DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

6.24.10 Resource TestScript - Detailed Descriptions

Detailed Descriptions for the elements in the TestScript resource.

TestScript
Definition

TestScript is a resource that specifies a suite of tests against a FHIR server implementation to determine compliance against the FHIR specification.

Control1..1
TestScript.url
Definition

An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published.

Control1..1
Typeuri
Alternate Namesurl; authoritative-url; destination; identity
Summarytrue
TestScript.version
Definition

The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually.

NoteThis is a business versionId, not a resource identifier (see discussion)
Control0..1
Typestring
Requirements

There may be multiple resource versions of the TestScript that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.

Summarytrue
TestScript.name
Definition

A free text natural language name identifying the TestScript.

Control1..1
Typestring
Summarytrue
Comments

Not expected to be globally unique.

TestScript.status
Definition

The status of the TestScript.

Control1..1
BindingConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required)
Typecode
Is Modifiertrue
Requirements

Allows filtering of TestScripts that are appropriate for use vs. not.

Summarytrue
TestScript.identifier
Definition

Identifier for the TestScript assigned for external purposes outside the context of FHIR.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
TestScript.experimental
Definition

This TestScript was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Requirements

Allows filtering of TestScripts that are appropriate for use vs. not.

Summarytrue
TestScript.publisher
Definition

The name of the individual or organization that published the Test Script.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the Test Script. May also allow for contact.

Summarytrue
Comments

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

TestScript.contact
Definition

Contacts to assist a user in finding and communicating with the publisher.

Control0..*
Summarytrue
Comments

May be a web site, an email address, a telephone number (tel:), etc.

TestScript.contact.name
Definition

The name of an individual to contact regarding the Test Script.

Control0..1
Typestring
Summarytrue
Comments

If there is no named individual, the telecom is for the organization as a whole.

TestScript.contact.telecom
Definition

Contact details for individual (if a name was provided) or the publisher.

Control0..*
TypeContactPoint
Summarytrue
TestScript.date
Definition

The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change.

Control0..1
TypedateTime
Summarytrue
Comments

Additional specific dates may be added as extensions.

TestScript.description
Definition

A free text natural language description of the TestScript and its use.

Control0..1
Typestring
Summarytrue
Comments

This field can be used for things such as why the TestScript was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the TestScript as conveyed in TestScript.text. This item SHOULD be populated unless the information is available from context.

TestScript.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts.

Control0..*
BindingContext of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible)
TypeCodeableConcept
Requirements

Assist in searching for appropriate content.

Summarytrue
TestScript.requirements
Definition

Explains why this Test Script is needed and why it's been constrained as it has.

Control0..1
Typestring
Comments

This element does not describe the usage of the Test Script (that's done in comments), rather it's for traceability of why the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.

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 details of the constraints and mappings.

Control0..1
Typestring
Alternate NamesLicense; Restrictions
TestScript.metadata
Definition

The required capability must exist and are assumed to function correctly on the FHIR server being tested.

Control0..1
InvariantsDefined on this element
inv-5: TestScript metadata capability SHALL contain required or validated or both. (xpath: f:capability/f:required or f:capability/f:validated or (f:capability/f:required and f:capability/f:validated))
TestScript.metadata.link
Definition

A link to the FHIR specification that this test is covering.

Control0..*
TestScript.metadata.link.url
Definition

URL to a particular requirement or feature within the FHIR specification.

Control1..1
Typeuri
TestScript.metadata.link.description
Definition

Short description of the link.

Control0..1
Typestring
TestScript.metadata.capability
Definition

Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.

Control1..*
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. The 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
Definition

Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.

Control0..1
Typeboolean
Default Valuefalse
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.

Control0..1
Typeboolean
Default Valuefalse
TestScript.metadata.capability.description
Definition

Description of the capabilities that this test script is requiring the server to support.

Control0..1
Typestring
TestScript.metadata.capability.destination
Definition

Which server these requirements apply to.

Control0..1
Typeinteger
TestScript.metadata.capability.link
Definition

Links to the FHIR specification that describes this interaction and the resources involved in more detail.

Control0..*
Typeuri
TestScript.metadata.capability.conformance
Definition

Minimum conformance required of server for test script to execute successfully. If server does not meet at a minimum the reference conformance definition, then all tests in this script are skipped.

Control1..1
TypeReference(Conformance)
Comments

The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.

TestScript.multiserver
Definition

If the tests apply to more than one FHIR server (e.g. cross-server interoperability tests) then multiserver=true. Defaults to false if value is unspecified.

Control0..1
Typeboolean
Meaning if MissingFalse
TestScript.fixture
Definition

Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

Control0..*
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.

Control0..1
Typeboolean
Meaning if MissingFalse
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.

Control0..1
Typeboolean
Meaning if MissingFalse
TestScript.fixture.resource
Definition

Reference to the resource (containing the contents of the resource needed for operations).

Control0..1
TypeReference(Any)
Comments

See http://hl7-fhir.github.io/resourcelist.html for complete list of resource types.

TestScript.profile
Definition

Reference to the profile to be used for validation.

Control0..*
TypeReference(Any)
Comments

See http://hl7-fhir.github.io/resourcelist.html for complete list of resource types.

TestScript.variable
Definition

Variable is set based either on element value in response body or on header field value in the response headers.

Control0..*
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 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.

InvariantsDefined on this element
inv-4: Variable cannot contain both headerField and path. (xpath: not(f:headerField and f:path))
TestScript.variable.name
Definition

Descriptive name for this variable.

Control1..1
Typestring
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.headerField
Definition

Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.

Control0..1
Typestring
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.path
Definition

XPath or JSONPath against the fixture body. When variables are defined, either headerField must be specified or path, but not both.

Control0..1
Typestring
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.sourceId
Definition

Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.

Control0..1
Typeid
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
Definition

A series of required setup operations before tests are executed.

Control0..1
TestScript.setup.metadata
Definition

Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.

Control0..1
TypeSee TestScript.metadata
InvariantsDefined on this element
inv-6: Setup metadata capability SHALL contain required or validated or both. (xpath: f:capability/f:required or f:capability/f:validated or (f:capability/f:required and f:capability/f:validated))
TestScript.setup.action
Definition

Action would contain either an operation or an assertion.

Control1..*
Comments

An action should contain either an operation or an assertion but not both. It can contain any number of variables.

InvariantsDefined on this element
inv-1: Setup action SHALL contain either an operation or assert but not both. (xpath: (f:operation or f:assert) and not(f:operation and f:assert))
TestScript.setup.action.operation
Definition

The operation to perform.

Control0..1
InvariantsDefined on this element
inv-10: Setup operation SHALL contain either sourceId or targetId or params or url. (xpath: f:sourceId or ((f:targetId or f:url or f:params) and (count(f:targetId) + count(f:url) + count(f:params) =1)) or (f:type/f:code/@value='conformance' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history'))
TestScript.setup.action.operation.type
Definition

Server interaction or operation type.

Control0..1
BindingTestScriptOperationCodes: The allowable operation types. (Extensible)
TypeCoding
Comments

See http://hl7-fhir.github.io/http.html for list of server interactions.

TestScript.setup.action.operation.resource
Definition

The type of the resource. See http://hl7-fhir.github.io/resourcelist.html.

Control0..1
BindingFHIRDefinedType: Any defined Resource or Data Type name
Typecode
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
Definition

The label would be used for tracking/logging purposes by test engines.

Control0..1
Typestring
Comments

This has no impact on the verification itself.

TestScript.setup.action.operation.description
Definition

The description would be used by test engines for tracking and reporting purposes.

Control0..1
Typestring
Comments

This has no impact on the verification itself.

TestScript.setup.action.operation.accept
Definition

The content-type or mime-type to use for RESTful operation in the 'Accept' header.

Control0..1
BindingContentType: The content or mime type. (Required)
Typecode
Meaning if Missingxml
Comments

If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If 'xml' is specified, then 'Accept' header of 'application/xml+fhir' will be set. If 'json' is specified, then 'application/json+fhir' will be used. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element.

TestScript.setup.action.operation.contentType
Definition

The content-type or mime-type to use for RESTful operation in the 'Content-Type' header.

Control0..1
BindingContentType: The content or mime type. (Required)
Typecode
Meaning if Missingxml
Comments

If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If 'xml' is specified, then 'Content-Type' header of 'application/xml+fhir' will be set. If 'json' is specified, then 'application/json+fhir' will be used. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element.

TestScript.setup.action.operation.destination
Definition

Which server to perform the operation on.

Control0..1
Typeinteger
Default Value0
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.

Control0..1
Typeboolean
Default Valuetrue
TestScript.setup.action.operation.params
Definition

Path plus parameters after [type]. Used to set parts of the request URL explicitly.

Control0..1
Typestring
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
Definition

Header elements would be used to set HTTP headers.

Control0..*
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://hl7-fhir.github.io/http.html#2.1.0.5.1 - "If-Match" header. See http://hl7-fhir.github.io/http.html#2.1.0.11 - Conditional Create using "If-None-Exist". See http://hl7-fhir.github.io/http.html#2.1.0.13.1 - Invalid "Content-Type" header for negative testing. - etc.

TestScript.setup.action.operation.requestHeader.field
Definition

The HTTP header field e.g. "Accept".

Control1..1
Typestring
Comments

If header element is specified, then field is required.

TestScript.setup.action.operation.requestHeader.value
Definition

The value of the header e.g. "application/xml".

Control1..1
Typestring
Comments

If header element is specified, then value is required. No conversions will be done by Test Engine e.g. "xml" to "application/xml+fhir". 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.responseId
Definition

The fixture id (maybe new) to map to the response.

Control0..1
Typeid
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 sourceId in subsequent assertions when assertion path and/or headerField is specified and sourceId is not specified.

TestScript.setup.action.operation.sourceId
Definition

The id of the fixture used as the body of a PUT or POST request.

Control0..1
Typeid
TestScript.setup.action.operation.targetId
Definition

Id of fixture used for extracting the [id], [type], and [vid] for GET requests.

Control0..1
Typeid
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
Definition

Complete request URL.

Control0..1
Typestring
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
Definition

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

Control0..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.

InvariantsDefined on this element
inv-13: Setup action assert shall contain both compareToSourceId and compareToSourcePath or neither. (xpath: (f:compareToSourceId and f:compareToSourcePath) or not(f:compareToSourceId or f:compareToSourcePath))
inv-8: Only a single assertion SHALL be present within setup action assert element. (xpath: count(f:contentType) + count(f:headerField) + count(f:minimumId) + count(f:navigationLinks) + count(f:path) + count(f:resource) + count(f:responseCode) + count(f:response) + count(f:validateProfileId) <=1)
TestScript.setup.action.assert.label
Definition

The label would be used for tracking/logging purposes by test engines.

Control0..1
Typestring
Comments

This has no impact on the verification itself.

TestScript.setup.action.assert.description
Definition

The description would be used by test engines for tracking and reporting purposes.

Control0..1
Typestring
Comments

This has no impact on the verification itself.

TestScript.setup.action.assert.direction
Definition

The direction to use for the assertion.

Control0..1
BindingAssertionDirectionType: The type of direction to use for assertion. (Required)
Typecode
TestScript.setup.action.assert.compareToSourceId
Definition

Id of fixture used to compare the "sourceId/path" evaluations to.

Control0..1
Typestring
Comments

The id of the fixture used to make comparisons to.

TestScript.setup.action.assert.compareToSourcePath
Definition

XPath or JSONPath expression against fixture used to compare the "sourceId/path" evaluations to.

Control0..1
Typestring
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
Definition

The content-type or mime-type to use for RESTful operation in the 'Content-Type' header.

Control0..1
BindingContentType: The content or mime type. (Required)
Typecode
Meaning if Missingxml
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 'xml' is specified, then 'Content-Type' header of 'application/xml+fhir' will be confirmed. If 'json' is specified, then 'application/json+fhir' will be used. If you'd like to have more control over the string, then use 'assert.headerField' instead.

TestScript.setup.action.assert.headerField
Definition

The HTTP header field name e.g. 'Location'.

Control0..1
Typestring
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
Definition

The ID of a fixture. Asserts that the response contains at a minimumId the fixture specified by minimumId.

Control0..1
Typestring
Comments

Asserts that the response contains all the element/content in another fixture pointed to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId.

TestScript.setup.action.assert.navigationLinks
Definition

Whether or not the test execution performs validation on the bundle navigation links.

Control0..1
Typeboolean
Comments

Asserts that the Bundle contains first, last, and next links.

TestScript.setup.action.assert.operator
Definition

The operator type.

Control0..1
BindingAssertionOperatorType: The type of operator to use for assertion. (Required)
Typecode
Comments

Operators come handy 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
Definition

The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.

Control0..1
Typestring
Comments

If both "path" and "fixtureId" are specified, then the path will be evaluated against the responseBody mapped to the fixtureId. If "path" is specified and "fixtureId" is not, then the path will be evaluated against the responseBody of the last operation. Test engines are to store the response body and headers of the last operation at all times for subsequent assertions.

TestScript.setup.action.assert.resource
Definition

The type of the resource. See http://hl7-fhir.github.io/resourcelist.html.

Control0..1
BindingFHIRDefinedType: Any defined Resource or Data Type name
Typecode
Comments

This will be expected resource type in response body e.g. in read, vread, search, etc. See http://hl7-fhir.github.io/resourcelist.html for complete list of resource types; e.g. <assert > <resourceType value="Patient" </assert>.

TestScript.setup.action.assert.response
Definition

okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.

Control0..1
BindingAssertionResponseTypes: The type of response code to use for assertion. (Required)
Typecode
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
Definition

The value of the HTTP response code to be tested.

Control0..1
Typestring
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
Definition

Fixture to evaluate the XPath/JSONPath expression or the headerField against.

Control0..1
Typeid
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
Definition

The ID of the Profile to validate against.

Control0..1
Typeid
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
Definition

The value to compare to.

Control0..1
Typestring
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
Definition

Whether or not the test execution will produce a warning only on error for this assert.

Control0..1
Typeboolean
Default Valuefalse
Comments

If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There 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
Definition

A test in this script.

Control0..*
TestScript.test.name
Definition

The name of this test used for tracking/logging purposes by test engines.

Control0..1
Typestring
TestScript.test.description
Definition

A short description of the test used by test engines for tracking and reporting purposes.

Control0..1
Typestring
TestScript.test.metadata
Definition

Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.

Control0..1
TypeSee TestScript.metadata
InvariantsDefined on this element
inv-7: Test metadata capability SHALL contain required or validated or both. (xpath: f:capability/f:required or f:capability/f:validated or (f:capability/f:required and f:capability/f:validated))
TestScript.test.action
Definition

Action would contain either an operation or an assertion.

Control1..*
Comments

An action should contain either an operation or an assertion but not both. It can contain any number of variables.

InvariantsDefined on this element
inv-2: Test action SHALL contain either an operation or assert but not both. (xpath: (f:operation or f:assert) and not(f:operation and f:assert))
TestScript.test.action.operation
Definition

An operation would involve a REST request to a server.

Control0..1
TypeSee TestScript.setup.action.operation
InvariantsDefined on this element
inv-11: Test operation SHALL contain either sourceId or targetId or params or url. (xpath: f:sourceId or (f:targetId or f:url or f:params) and (count(f:targetId) + count(f:url) + count(f:params) =1) or (f:type/f:code/@value='conformance' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history'))
TestScript.test.action.assert
Definition

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

Control0..1
TypeSee 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.

InvariantsDefined on this element
inv-14: Test action assert shall contain both compareToSourceId and compareToSourcePath or neither. (xpath: (f:compareToSourceId and f:compareToSourcePath) or not(f:compareToSourceId or f:compareToSourcePath))
inv-9: Only a single assertion SHALL be present within test action assert element. (xpath: count(f:contentType) + count(f:headerField) + count(f:minimumId) + count(f:navigationLinks) + count(f:path) + count(f:resource) + count(f:responseCode) + count(f:response) + count(f:validateProfileId) <=1)
TestScript.teardown
Definition

A series of operations required to clean up after the all the tests are executed (successfully or otherwise).

Control0..1
TestScript.teardown.action
Definition

The teardown action will only contain an operation.

Control1..*
Comments

An action should contain either an operation or an assertion but not both. It can contain any number of variables.

InvariantsDefined on this element
inv-3: Teardown action SHALL contain an operation. (xpath: f:operation)
TestScript.teardown.action.operation
Definition

An operation would involve a REST request to a server.

Control0..1
TypeSee TestScript.setup.action.operation
InvariantsDefined on this element
inv-12: Teardown operation SHALL contain either sourceId or targetId or params or url. (xpath: f:sourceId or (f:targetId or f:url or (f:params and f:resource)) and (count(f:targetId) + count(f:url) + count(f:params) =1) or (f:type/f:code/@value='conformance' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history'))