Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Content Examples Detailed Descriptions Mappings Profiles & Extensions R3 Conversions 7.3.8 Resource TestScript - Detailed Descriptions

Example StructureDefinition/iso21090-AD-use (XML)

Security Category : Anonymous
FHIR Infrastructure Work Group Maturity Level : 2   Trial Use N/A Compartments Standards Status : Not linked to any defined compartments Detailed Descriptions for the elements in the TestScript resource. TestScript Element Id TestScript Definition A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. Cardinality 0..* Type DomainResource Invariants Defined on this element tst-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}') TestScript.url Element Id TestScript.url Definition An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers. Cardinality 1..1 Type uri Requirements Allows the test script to be referenced by a single globally unique identifier. Alternate Names url; authoritative-url; destination; identity Summary true Comments Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions . In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. TestScript.identifier Element Id TestScript.identifier Definition A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. Note This is a business identifier, not a resource identifier (see discussion ) Cardinality 0..1 Type Identifier Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Summary true Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI. TestScript.version Element Id TestScript.version Definition The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. Note This is a business versionId, not a resource version id (see discussion ) Cardinality 0..1 Type string Summary true Comments There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version]. TestScript.name Element Id TestScript.name Definition A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation. Cardinality 1..1 Type string Requirements Support human navigation and code generation. Summary true Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Invariants Affect this element inv-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation Informative name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
TestScript.title Element Id TestScript.title Definition A short, descriptive, user-friendly title for the test script. Cardinality 0..1 Type string Summary true Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. TestScript.status Element Id TestScript.status Definition The status of this test script. Enables tracking the life-cycle of the content. Cardinality 1..1 Terminology Binding PublicationStatus ( Required ) Type code Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) Summary true Comments Allows filtering of test scripts that are appropriate for use versus not. TestScript.experimental Element Id TestScript.experimental Definition A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Cardinality 0..1 Type boolean Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script. Summary true Comments Allows filtering of test scripts that are appropriate for use versus not. TestScript.date Element Id TestScript.date Definition The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes. Cardinality 0..1 Type dateTime Alternate Names Revision Date Summary true Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. TestScript.publisher Element Id TestScript.publisher Definition The name of the organization or individual that published the test script. Cardinality 0..1 Type string Requirements Helps establish the "authority/credibility" of the test script. May also allow for contact. Summary true Comments Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context. TestScript.contact Element Id TestScript.contact Definition Contact details to assist a user in finding and communicating with the publisher. Cardinality 0..* Type ContactDetail Summary true Comments May be a web site, an email address, a telephone number, etc. TestScript.description Element Id TestScript.description Definition A free text natural language description of the test script from a consumer's perspective. Cardinality 0..1 Type markdown Comments This description can be used to capture details such as why the test script was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test script as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created). TestScript.useContext Element Id TestScript.useContext Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances. Cardinality 0..* Type UsageContext Requirements Assist in searching for appropriate content. Summary true Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. TestScript.jurisdiction Element Id TestScript.jurisdiction Definition A legal or geographic region in which the test script is intended to be used. Cardinality 0..* Terminology Binding Jurisdiction ( Extensible ) Type CodeableConcept Summary true Comments It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended. TestScript.purpose Element Id TestScript.purpose Definition Explanation of why this test script is needed and why it has been designed as it has. Cardinality 0..1 Type markdown Comments This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script. TestScript.copyright Element Id TestScript.copyright Definition A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script. Cardinality 0..1 Type markdown Requirements Consumers must be able to determine any legal restrictions on the use of the test script and/or its content. Alternate Names License; Restrictions TestScript.origin Element Id TestScript.origin Definition An abstract server used in operations within this test script in the origin element. Cardinality 0..* Comments The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction. TestScript.origin.index Element Id TestScript.origin.index Definition Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. Cardinality 1..1 Type integer Comments A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration). Different origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler). The origin indices provided elsewhere in the test script must be one of these origin indices. TestScript.origin.profile Element Id TestScript.origin.profile Definition The type of origin profile the test system supports. Cardinality 1..1 Terminology Binding Test script profile origin type ( Extensible ) Type Coding Meaning if Missing FHIR-Client Comments Must be a "sender"/"client" profile. TestScript.destination Element Id TestScript.destination Definition An abstract server used in operations within this test script in the destination element. Cardinality 0..* Comments The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction. TestScript.destination.index Element Id TestScript.destination.index Definition Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
  • Cardinality Narrative 1..1
  • Type XML
  • integer JSON Comments A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration). Different destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager). The destination indices provided elsewhere in the test script must be one of these destination indices.
  • TTL TestScript.destination.profile Element Id TestScript.destination.profile Definition

The type of destination profile the test system supports. Cardinality 1..1 Terminology Binding Test script profile destination type Raw XML ( Extensible ) Type Coding Meaning if Missing FHIR-Server Comments Must be a "receiver"/"server" profile. TestScript.metadata Element Id TestScript.metadata Definition The required capability must exist and are assumed to function correctly on the FHIR server being tested. Cardinality 0..1 Invariants Defined on this element tst-4 Rule TestScript metadata capability SHALL contain required or validated or both. capability.required.exists() or capability.validated.exists() TestScript.metadata.link Element Id TestScript.metadata.link Definition A link to the FHIR specification that this test is covering. Cardinality 0..* TestScript.metadata.link.url Element Id TestScript.metadata.link.url Definition URL to a particular requirement or feature within the FHIR specification. Cardinality 1..1 Type uri TestScript.metadata.link.description Element Id TestScript.metadata.link.description Definition Short description of the link. Cardinality 0..1 Type string TestScript.metadata.capability Element Id TestScript.metadata.capability Definition Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. Cardinality 1..* Comments When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script. TestScript.metadata.capability.required Element Id TestScript.metadata.capability.required Definition Whether or not the test execution will require the given capabilities of the server in order for this test script to execute. Cardinality 1..1 Type boolean TestScript.metadata.capability.validated Element Id TestScript.metadata.capability.validated Definition Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute. Cardinality 1..1 Type boolean TestScript.metadata.capability.description Element Id TestScript.metadata.capability.description Definition Description of the capabilities that this test script is requiring the server to support. Cardinality 0..1 Type string TestScript.metadata.capability.origin Element Id TestScript.metadata.capability.origin Definition Which origin server these requirements apply to. Cardinality 0..* Type integer TestScript.metadata.capability.destination Element Id TestScript.metadata.capability.destination Definition Which server these requirements apply to. Cardinality 0..1 Type integer TestScript.metadata.capability.link Element Id TestScript.metadata.capability.link Definition Links to the FHIR specification that describes this interaction and the resources involved in more detail. Cardinality 0..* Type uri TestScript.metadata.capability.capabilities Element Id TestScript.metadata.capability.capabilities Definition Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped. Cardinality 1..1 Type canonical form ( CapabilityStatement ) Comments The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element. TestScript.fixture Element Id TestScript.fixture Definition Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. Cardinality 0..* TestScript.fixture.autocreate Element Id TestScript.fixture.autocreate Definition Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section. Cardinality 1..1 Type boolean TestScript.fixture.autodelete Element Id TestScript.fixture.autodelete Definition Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section. Cardinality 1..1 Type boolean TestScript.fixture.resource Element Id TestScript.fixture.resource Definition Reference to the resource (containing the contents of the resource needed for operations). Cardinality 0..1 Type Reference ( Any ) Comments See http://build.fhir.org/resourcelist.html for complete list of resource types. TestScript.profile Element Id TestScript.profile Definition Reference to the profile to be used for validation. Cardinality 0..* Type Reference ( Any ) Comments See http://build.fhir.org/resourcelist.html for complete list of resource types. TestScript.variable Element Id TestScript.variable Definition Variable is set based either on element value in response body or on header field value in the response headers. Cardinality 0..* Comments Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml. Invariants Defined on this element tst-3 Rule Variable can only contain one of expression, headerField or path. expression.empty() or headerField.empty() or path.empty() TestScript.variable.name Element Id TestScript.variable.name Definition Descriptive name for this variable. Cardinality 1..1 Type string Comments Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed. TestScript.variable.defaultValue Element Id TestScript.variable.defaultValue Definition A default, hard-coded, or user-defined value for this variable. Cardinality 0..1 Type string Comments The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values. TestScript.variable.description Element Id TestScript.variable.description Definition A free text natural language description of the variable and its purpose. Cardinality 0..1 Type string TestScript.variable.expression Element Id TestScript.variable.expression Definition The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. Cardinality 0..1 Type string Comments If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path. TestScript.variable.headerField Element Id TestScript.variable.headerField Definition Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. Cardinality 0..1 Type string Comments If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path. TestScript.variable.hint Element Id TestScript.variable.hint Definition Displayable text string with hint help information to the user when entering a default value. Cardinality 0..1 Type string TestScript.variable.path Element Id TestScript.variable.path Definition XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. Cardinality 0..1 Type string Comments If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path. TestScript.variable.sourceId Element Id TestScript.variable.sourceId Definition Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. Cardinality 0..1 Type id Comments This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the action.operation element. TestScript.setup Element Id TestScript.setup Definition A series of required setup operations before tests are executed. Cardinality 0..1 TestScript.setup.action Element Id TestScript.setup.action Definition Action would contain either an operation or an assertion. Cardinality 1..* Comments An action should contain either an operation or an assertion but not both. It can contain any number of variables. Invariants Defined on this element tst-1 Rule Setup action SHALL contain either an operation or assert but not both. operation.exists() xor assert.exists() TestScript.setup.action.operation Element Id TestScript.setup.action.operation Definition The operation to perform. Cardinality 0..1 Invariants Defined on this element tst-7 Rule Setup operation SHALL contain either sourceId or targetId or params or url. sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history')) TestScript.setup.action.operation.type Element Id TestScript.setup.action.operation.type Definition Server interaction or operation type. Cardinality 0..1 Terminology Binding Test script operation code ( Extensible ) Type Coding Comments See http://build.fhir.org/http.html for list of server interactions. TestScript.setup.action.operation.resource Element Id TestScript.setup.action.operation.resource Definition The type of the resource. See http://build.fhir.org/resourcelist.html. Cardinality 0..1 Terminology Binding Any defined Resource or Data Type name Type code Comments If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. TestScript.setup.action.operation.label Element Id TestScript.setup.action.operation.label Definition The label would be used for tracking/logging purposes by test engines. Cardinality 0..1 Type string Comments This has no impact on the verification itself. TestScript.setup.action.operation.description Element Id TestScript.setup.action.operation.description Definition The description would be used by test engines for tracking and reporting purposes. Cardinality 0..1 Type string Comments This has no impact on the verification itself. TestScript.setup.action.operation.accept Element Id TestScript.setup.action.operation.accept Definition The mime-type to use for RESTful operation in the 'Accept' header. Cardinality 0..1 Terminology Binding MimeType ( Required ) Type code Comments If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element. TestScript.setup.action.operation.contentType Element Id TestScript.setup.action.operation.contentType Definition The mime-type to use for RESTful operation in the 'Content-Type' header. Cardinality 0..1 Terminology Binding MimeType ( Required ) Type code Comments If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element. TestScript.setup.action.operation.destination Element Id TestScript.setup.action.operation.destination Definition The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. Cardinality 0..1 Type integer Comments If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange. TestScript.setup.action.operation.encodeRequestUrl Element Id TestScript.setup.action.operation.encodeRequestUrl Definition Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths. Cardinality 1..1 Type boolean TestScript.setup.action.operation.method Element Id TestScript.setup.action.operation.method Definition The HTTP method the test engine MUST use for this operation regardless of any other operation details. Cardinality 0..1 Terminology Binding TestScriptRequestMethodCode ( Required see XML Format Specification ) Type code Comments The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing. TestScript.setup.action.operation.origin Element Id TestScript.setup.action.operation.origin Definition The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. Cardinality 0..1 Type integer Comments If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server. TestScript.setup.action.operation.params Element Id TestScript.setup.action.operation.params Definition Path plus parameters after [type]. Used to set parts of the request URL explicitly. Cardinality 0..1 Type string Comments If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Test engines would append whatever is specified for "params" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The "params" element does not correspond exactly to "search parameters". Nor is it the "path". It corresponds to the part of the URL that comes after the [type] (when "resource" element is specified); e.g. It corresponds to "/[id]/_history/[vid] {?_format=[mime-type]}" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. TestScript.setup.action.operation.requestHeader Element Id TestScript.setup.action.operation.requestHeader Definition Header elements would be used to set HTTP headers. Cardinality 0..* Comments This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. See http://build.fhir.org/http.html#2.1.0.5.1 - "If-Match" header. See http://build.fhir.org/http.html#2.1.0.11 - Conditional Create using "If-None-Exist". See http://build.fhir.org/http.html#2.1.0.13.1 - Invalid "Content-Type" header for negative testing. - etc. TestScript.setup.action.operation.requestHeader.field Element Id TestScript.setup.action.operation.requestHeader.field Definition The HTTP header field e.g. "Accept". Cardinality 1..1 Type string Comments If header element is specified, then field is required. TestScript.setup.action.operation.requestHeader.value Element Id TestScript.setup.action.operation.requestHeader.value Definition The value of the header e.g. "application/fhir+xml". Cardinality 1..1 Type string Comments If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. TestScript.setup.action.operation.requestId Element Id TestScript.setup.action.operation.requestId Definition The fixture id (maybe new) to map to the request. Cardinality 0..1 Type id Comments If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "requestId". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified. TestScript.setup.action.operation.responseId Element Id TestScript.setup.action.operation.responseId Definition The fixture id (maybe new) to map to the response.

Cardinality 0..1 Type id Comments If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "responseId". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified. TestScript.setup.action.operation.sourceId Element Id TestScript.setup.action.operation.sourceId Definition The id of the fixture used as the body of a PUT or POST request. Cardinality 0..1 Type id TestScript.setup.action.operation.targetId Element Id TestScript.setup.action.operation.targetId Definition Id of fixture used for extracting the [id], [type], and [vid] for GET requests. Cardinality 0..1 Type id Comments If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. TestScript.setup.action.operation.url Element Id TestScript.setup.action.operation.url Definition Complete request URL. Cardinality 0..1 Type string Comments Used to set the request URL explicitly. If "url" element is defined, then "targetId", "resource", and "params" elements will be ignored. Test engines would use whatever is specified in "url" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. TestScript.setup.action.assert Element Id TestScript.setup.action.assert Definition Evaluates the results of previous operations to determine if the server under test behaves appropriately. Cardinality 0..1 Comments

In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine. AD-use

Invariants Defined on this element tst-5 Rule Only a single assertion SHALL be present within setup action assert element. extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) tst-10 Rule Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists()) tst-12 
<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="iso21090-AD-use"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/iso21090-AD-use"/> 
  <version value="5.0.0-snapshot3"/> 
  <name value="AD-use"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2012-06-24"/> 
  <publisher value="Health Level Seven International (Modeling and Methodology)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/mnm"/> 
    </telecom> 
  </contact> 
  <description value="Uses of Addresses - codes not defined as part of Address.use."/> 
  <fhirVersion value="5.0.0-snapshot3"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <context> 
    <type value="element"/> 
    <expression value="Address"/> 
  </context> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="BAD | CONF | HP | HV | DIR | PUB | PHYS | PST"/> 
      <definition value="Uses of Addresses - codes not defined as part of Address.use."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="AD.use"/> 
      </mapping> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may

       be any string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="The definition may point directly to a computable or human-readable definition

       of the extensibility codes, or it may be a logical URI as declared in some other
       specification. The definition SHALL be a URI for the Structure Definition defining
       the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="uri"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/iso21090-AD-use"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](

      extensibility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="code"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition">
          <valueString value="Uses of an address not included in Address.use."/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="PostalAddressUse"/> 
        </extension> 
        <strength value="required"/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/postal-address-use|5.0.0-snapshot3"/> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="BAD | CONF | HP | HV | DIR | PUB | PHYS | PST"/> 
      <definition value="Uses of Addresses - codes not defined as part of Address.use."/> 
      <min value="0"/> 
      <max value="1"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="AD.use"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/iso21090-AD-use"/> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="code"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition">
          <valueString value="Uses of an address not included in Address.use."/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="PostalAddressUse"/> 
        </extension> 
        <strength value="required"/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/postal-address-use|5.0.0-snapshot3"/> 
      </binding> 
    </element> 
  </differential> 

Rule


</

StructureDefinition


Setup
action
assert
response
and
responseCode
SHALL
be
empty
when
direction
equals
request
(response.empty()
and
responseCode.empty()
and
direction
=
'request')
or
direction.empty()
or
direction
=
'response'

>


TestScript.setup.action.assert.label
Element
Id
TestScript.setup.action.assert.label
Definition
The
label
would
be
used
for
tracking/logging
purposes
by
test
engines.
Cardinality
0..1
Type
string
Comments
This
has
no
impact
on
the
verification
itself.
TestScript.setup.action.assert.description
Element
Id
TestScript.setup.action.assert.description
Definition
The
description
would
be
used
by
test
engines
for
tracking
and
reporting
purposes.
Cardinality
0..1
Type
string



Comments

This Usage note: every effort has no impact on the verification itself. TestScript.setup.action.assert.direction Element Id TestScript.setup.action.assert.direction Definition The direction to use for the assertion. Cardinality 0..1 Terminology Binding AssertionDirectionType ( Required ) Type code Comments If the direction is specified as "response" (the default), then the processing of this assert is against the received response message. If the direction is specified as "request", then the processing of this assert is against the sent request message. TestScript.setup.action.assert.compareToSourceId Element Id TestScript.setup.action.assert.compareToSourceId Definition Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition. Cardinality 0..1 Type string TestScript.setup.action.assert.compareToSourceExpression Element Id TestScript.setup.action.assert.compareToSourceExpression Definition The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. Cardinality 0..1 Type string Comments Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated. TestScript.setup.action.assert.compareToSourcePath Element Id TestScript.setup.action.assert.compareToSourcePath Definition XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. Cardinality 0..1 Type string Comments The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated. TestScript.setup.action.assert.contentType Element Id TestScript.setup.action.assert.contentType Definition The mime-type contents to compare against the request or response message 'Content-Type' header. Cardinality 0..1 Terminology Binding MimeType ( Required ) Type code Comments If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If "assert.sourceId" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead. TestScript.setup.action.assert.expression Element Id TestScript.setup.action.assert.expression Definition The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. Cardinality 0..1 Type string Comments If both "expression" and a "fixtureId" are specified, then the expression will be evaluated against the request or response body mapped to the fixtureId. If "expression" is specified and a "fixtureId" is not, then the expression will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions. TestScript.setup.action.assert.headerField Element Id TestScript.setup.action.assert.headerField Definition The HTTP header field name e.g. 'Location'. Cardinality 0..1 Type string Comments If "headerField" is specified then "value" must be specified. If "sourceId" is not specified, then "headerField" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers. TestScript.setup.action.assert.minimumId Element Id TestScript.setup.action.assert.minimumId Definition The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. Cardinality 0..1 Type string Comments Asserts that the response contains all the element/content in another fixture pointed been made to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId. TestScript.setup.action.assert.navigationLinks Element Id TestScript.setup.action.assert.navigationLinks Definition Whether or not the test execution performs validation on the bundle navigation links. Cardinality 0..1 Type boolean Comments Asserts ensure that the Bundle contains first, last, and next links. TestScript.setup.action.assert.operator Element Id TestScript.setup.action.assert.operator Definition The operator type defines the conditional behavior of the assert. If not defined, the default is equals. Cardinality 0..1 Terminology Binding AssertionOperatorType ( Required ) Type code Comments Operators are useful especially for negative testing. If operator is not specified, then the "equals" operator is assumed; e.g. <code> <assert> <operator value="in" /> <responseCode value="200,201,204" /> </assert> <assert> <operator value="notEquals" /> <response value="okay"/> </assert> <assert> <operator value="greaterThan" /> <responseHeader> <field value="Content-Length" /> <value value="0" /> </responseHeader/> </assert> </code> . TestScript.setup.action.assert.path Element Id TestScript.setup.action.assert.path Definition The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. Cardinality 0..1 Type string Comments If both "path" and a "fixtureId" are specified, then the path will be evaluated against the request or response body mapped to the fixtureId. If "path" is specified and a "fixtureId" is not, then the path will be evaluated against the response body of the last operation. Test engines examples are to store the request and response body and headers of the last operation at all times for subsequent assertions. TestScript.setup.action.assert.requestMethod Element Id TestScript.setup.action.assert.requestMethod Definition The request method or HTTP operation code to compare against that used by the client system under test. Cardinality 0..1 Terminology Binding TestScriptRequestMethodCode ( Required ) Type code Comments If "requestMethod" is specified then it will be used in place of "value". The "requestMethod" will evaluate against the last operation's request HTTP operation. TestScript.setup.action.assert.requestURL Element Id TestScript.setup.action.assert.requestURL Definition The value to use in a comparison against the request URL path string. Cardinality 0..1 Type string Comments If "requestURL" is specified then it will be used in place of "value". The "requestURL" will evaluate against the last operation's full request URL path string. TestScript.setup.action.assert.resource Element Id TestScript.setup.action.assert.resource Definition The type of the resource. See http://build.fhir.org/resourcelist.html. Cardinality 0..1 Terminology Binding Any defined Resource or Data Type name Type code Comments This will be expected resource type in response body e.g. in read, vread, search, etc. See http://build.fhir.org/resourcelist.html for complete list of resource types; e.g. <assert > <resourceType value="Patient" </assert>. TestScript.setup.action.assert.response Element Id TestScript.setup.action.assert.response Definition okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable. Cardinality 0..1 Terminology Binding AssertionResponseTypes ( Required ) Type code Comments This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. <assert> <contentType value="json" /> <response value="okay"/> </assert>. TestScript.setup.action.assert.responseCode Element Id TestScript.setup.action.assert.responseCode Definition The value of the HTTP response code to be tested. Cardinality 0..1 Type string Comments To be used with "operator" attribute value. Asserts that the response code equals this value if "operator" is not specified. If the operator is "in" or "notIn" then the responseCode would be a comma-separated list of values e.g. "200,201". Otherwise, it's expected to be a numeric value. If "fixture" is not specified, then the "responseBodyId" value of the last operation is assumed. TestScript.setup.action.assert.sourceId Element Id TestScript.setup.action.assert.sourceId Definition Fixture to evaluate the XPath/JSONPath expression or the headerField against. Cardinality 0..1 Type id Comments This can be a statically defined fixture (at the top of the testscript) or a dynamically set fixture created by responseId of the action.operation element. TestScript.setup.action.assert.validateProfileId Element Id TestScript.setup.action.assert.validateProfileId Definition The ID of the Profile to validate against. Cardinality 0..1 Type id Comments The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId. TestScript.setup.action.assert.value Element Id TestScript.setup.action.assert.value Definition The value to compare to. Cardinality 0..1 Type string Comments The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value. TestScript.setup.action.assert.warningOnly Element Id TestScript.setup.action.assert.warningOnly Definition Whether or not the test execution will produce a warning only on error for this assert. Cardinality 1..1 Type boolean Comments If this element is specified correct and it is true, then assertion failures can be logged by test engine useful, but should not stop the test script execution from proceeding. There they are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning. TestScript.test Element Id TestScript.test Definition A test in this script. Cardinality 0..* TestScript.test.name Element Id TestScript.test.name Definition The name of this test used for tracking/logging purposes by test engines. Cardinality 0..1 Type string TestScript.test.description Element Id TestScript.test.description Definition A short description of the test used by test engines for tracking and reporting purposes. Cardinality 0..1 Type string TestScript.test.action Element Id TestScript.test.action Definition Action would contain either an operation or an assertion. Cardinality 1..* Comments An action should contain either an operation or an assertion but not both. It can contain any number of variables. Invariants Defined on this element tst-2 Rule Test action SHALL contain either an operation or assert but not both. operation.exists() xor assert.exists() TestScript.test.action.operation Element Id TestScript.test.action.operation Definition An operation would involve a REST request to a server. Cardinality 0..1 Type See TestScript.setup.action.operation Invariants Defined on this element tst-8 Rule Test operation SHALL contain either sourceId or targetId or params or url. sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history')) TestScript.test.action.assert Element Id TestScript.test.action.assert Definition Evaluates the results of previous operations to determine if the server under test behaves appropriately. Cardinality 0..1 Type See TestScript.setup.action.assert Comments In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine. Invariants Defined on this element tst-6 Rule Only a single assertion SHALL be present within test action assert element. extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) tst-11 Rule Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists()) tst-13 Rule Test action assert response and response and responseCode SHALL be empty when direction equals request (response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response' TestScript.teardown Element Id TestScript.teardown Definition A series normative part of operations required to clean up after all the tests are executed (successfully or otherwise). Cardinality 0..1 TestScript.teardown.action Element Id TestScript.teardown.action Definition The teardown action will only contain an operation. Cardinality 1..* Comments An action should contain either an operation or an assertion but not both. It can contain any number of variables. TestScript.teardown.action.operation Element Id TestScript.teardown.action.operation Definition An operation would involve a REST request to a server. specification.

Cardinality 1..1 Type See TestScript.setup.action.operation Invariants Defined on this element tst-9 Rule Teardown operation SHALL contain either sourceId or targetId or params or url. sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))