Generated Narrative: StructureDefinition TestScript Last updated: 2021-01-05 10:01:24+1100 Name Flags Card. Type Description & Constraints TestScript C 1..1 CanonicalResource Describes a set of tests Elements defined in Ancestors:id, meta, implicitRules, language, <a href="http://hl7.org/fhir/R5/domainresource.html" title="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.">text, contained, <a href="http://hl7.org/fhir/R5/domainresource.html" title="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension, <a href="http://hl7.org/fhir/R5/domainresource.html" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.#xA;#xA;Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).">modifierExtension, <a href="http://hl7.org/fhir/R5/canonicalresource.html" title="An absolute URI that is used to identify this {{title}} 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 an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.">url, identifier, <a href="http://hl7.org/fhir/R5/canonicalresource.html" title="The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 without additional knowledge. (See the versionAlgorithm element.)">version, versionAlgorithm[x], name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, <a href="http://hl7.org/fhir/R5/canonicalresource.html" title="A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').">copyrightLabel #xD; <a href="StructureDefinition-TestScript-definitions.html#TestScript.url" title="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 is globally unique and a literal address 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 will remain the same when the test script is stored on different servers.">url Σ 0..1 uri Canonical identifier for this test script, represented as a URI (globally unique) #xD; identifier Σ 0..* Identifier Additional identifier for the test script #xD; <a href="StructureDefinition-TestScript-definitions.html#TestScript.version" title="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.">version Σ 0..1 string Business version of the test script #xD; versionAlgorithm[x] Σ 0..1 How to compare versions Binding: VersionAlgorithm (extensible) #xD; versionAlgorithmString string #xD; versionAlgorithmCoding Coding #xD; name ΣC 1..1 string Name for this test script (computer friendly) #xD; title Σ 0..1 string Name for this test script (human friendly) #xD; status ?!Σ 1..1 code draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. #xD; experimental Σ 0..1 boolean For testing only - never for real usage #xD; date Σ 0..1 dateTime Date last changed #xD; publisher Σ 0..1 string Name of the publisher/steward (organization or individual) #xD; contact Σ 0..* ContactDetail Contact details for the publisher #xD; description 0..1 markdown Natural language description of the test script #xD; <a href="StructureDefinition-TestScript-definitions.html#TestScript.useContext" title="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.">useContext Σ 0..* UsageContext The context that the content is intended to support #xD; jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for test script (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. #xD; purpose 0..1 markdown Why this test script is defined #xD; copyright 0..1 markdown Use and/or publishing restrictions #xD; <a href="StructureDefinition-TestScript-definitions.html#TestScript.copyrightLabel" title="A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').">copyrightLabel 0..1 string Copyright holder and year(s) #xD; testSystem 0..* BackboneElement An abstract server representing a client or sender in a message exchange #xD; index 1..1 positiveInt The index of the abstract test system #xD; title 1..1 string Label for the test system #xD; actor 0..* canonical(ActorDefinition | CapabilityStatement) Features met by the test system #xD; description 0..1 markdown Formatted information of this test system #xD; url 0..1 url The url path of this test system #xD; metadata C 0..1 BackboneElement Required capability that is assumed to function correctly on the FHIR server being tested #xD; link 0..* BackboneElement Links to the FHIR specification #xD; url 1..1 uri URL to the specification #xD; description 0..1 string Short description #xD; capability C 1..* BackboneElement Capabilities that are assumed to function correctly on the FHIR server being tested #xD; required C 1..1 boolean Are the capabilities required? #xD; validated C 1..1 boolean Are the capabilities validated? #xD; description 0..1 string The expected capabilities of the server #xD; origin 0..* integer Which origin server these requirements apply to #xD; destination 0..1 integer Which server these requirements apply to #xD; link 0..* uri Links to the FHIR specification #xD; capabilities 1..1 canonical(CapabilityStatement) Required Capability Statement #xD; scope 0..* BackboneElement Indication of the artifact(s) that are tested by this test case #xD; artifact 1..1 canonical(Resource) The specific conformance artifact being tested #xD; conformance 0..1 CodeableConcept required | optional | strict Binding: TestScriptScopeConformanceTypeValueSet (extensible): The expectation of whether the test must pass for the system to be considered conformant with the artifact. #xD; phase 0..1 CodeableConcept unit | integration | production Binding: TestScriptScopePhaseTypeValueSet (extensible): The phase of testing for this artifact. #xD; fixture 0..* BackboneElement Fixture in the test script - by reference (uri) #xD; autocreate 1..1 boolean Whether or not to implicitly create the fixture during setup #xD; autodelete 1..1 boolean Whether or not to implicitly delete the fixture during teardown #xD; resource 0..1 Reference(Resource) Reference of the resource #xD; expression 0..1 Expression The expression against the fixture to extract the required element #xD; profile 0..* canonical(StructureDefinition) Reference of the validation profile #xD; variable C 0..* BackboneElement Placeholder for evaluated elements #xD; name 1..1 string Descriptive name for this variable #xD; defaultValue 0..1 string Default, hard-coded, or user-defined value for this variable #xD; description 0..1 string Natural language description of the variable #xD; expression C 0..1 Expression The expression against the fixture body #xD; headerField C 0..1 string HTTP header field name for source #xD; hint 0..1 string Hint help text for default value to enter #xD; path CXD 0..1 string XPath or JSONPath against the fixture body #xD; sourceId 0..1 id Fixture Id of source expression or headerField within this variable #xD; setup 0..1 BackboneElement A series of required setup operations before tests are executed #xD; action C 0..* BackboneElement A setup common or operation or assert to perform #xD; common C 0..1 BackboneElement Links or references to common collection(s) of actions #xD; testScript 0..1 canonical(Test Script) Canonical reference to the common TestScript instance #xD; keyRef 1..1 id Common key reference that identifies the common collection of actions to perform #xD; parameter 0..* BackboneElement Parameter(s) to convey input values to the identified common collection of actions #xD; name 1..1 string Name of the parameter from the identified common collection of actions #xD; value 1..1 string Value to assign to the parameter from the identified common collection of actions #xD; operation C 0..1 BackboneElement The setup operation to perform #xD; type C 0..1 Coding The operation code type that will be executed Binding: TestScriptOperationCodeValueSet (extensible): FHIR Operation Code Types #xD; resource 0..1 uri Resource type Binding: ConcreteFHIRTypes (extensible): A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. #xD; label 0..1 string Tracking/logging operation label #xD; description 0..1 string Tracking/reporting operation description #xD; accept 0..1 code Mime type to accept in the payload of the response, with charset etc Binding: SupplementedMimeTypes (required): The mime type of an attachment. Any valid mime type is allowed (BCP 13; RFCs 2045, 2046, 2047, 4288, 4289 and 2049), and also json, xml, and ttl. Additional Bindings Purpose CapabilityFormatType Starter Example General: application/fhir+xml #xD; contentType 0..1 code Mime type of the request payload contents, with charset etc Binding: SupplementedMimeTypes (required): The mime type of an attachment. Any valid mime type is allowed (BCP 13; RFCs 2045, 2046, 2047, 4288, 4289 and 2049), and also json, xml, and ttl. Additional Bindings Purpose CapabilityFormatType Starter Example General: application/fhir+xml #xD; destination 0..1 integer Server responding to the request #xD; encodeRequestUrl 1..1 boolean Whether or not to send the request url in encoded format #xD; method 0..1 code delete | get | options | patch | post | put | head Binding: TestScriptRequestMethodCodeValueSet (required): The allowable request method or HTTP operation codes. #xD; origin 0..1 integer Server initiating the request #xD; params C 0..1 string Explicitly defined path parameters #xD; requestHeader 0..* BackboneElement Each operation can have one or more header elements #xD; field 1..1 string HTTP header field name #xD; value 1..1 string HTTP headerfield value #xD; requestId 0..1 id Fixture Id of mapped request #xD; responseId 0..1 id Fixture Id of mapped response #xD; sourceId C 0..1 id Fixture Id of body for PUT and POST requests #xD; targetId C 0..1 id Id of fixture used for extracting the [id], [type], and [vid] for GET requests #xD; url C 0..1 string Request URL #xD; assert <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://build.fhir.org/conformance-rules.html#constraints" title="This element has or is affected by constraints ( tst-5, tst-6, tst-7, tst-8, tst-3 )">C 0..1 BackboneElement The assertion to perform #xD; label 0..1 string Tracking/logging assertion label #xD; key 0..1 id Key that identifies this assert #xD; evaluateBasedOn 0..* id Zero or more assert.key references #xD; description 0..1 string Tracking/reporting assertion description #xD; direction C 0..1 code response | request Binding: AssertionDirectionTypeValueSet (required): The direction to use for assertions. #xD; compareToSourceId C 0..1 string Id of the source fixture to be evaluated #xD; compareToSourceExpression C 0..1 Expression The expression to evaluate against the source fixture #xD; compareToSourcePath CXD 0..1 string XPath or JSONPath expression to evaluate against the source fixture #xD; contentType C 0..1 code Mime type to compare against the 'Content-Type' header Binding: SupplementedMimeTypes (required): The mime type of an attachment. Any valid mime type is allowed (BCP 13; RFCs 2045, 2046, 2047, 4288, 4289 and 2049), and also json, xml, and ttl. Additional Bindings Purpose CapabilityFormatType Starter Example General: application/fhir+xml #xD; defaultManualCompletion 0..1 code fail | pass | skip | stop Binding: AssertionManualCompletionTypeValueSet (required): The default type of manual completion to use for assertion. #xD; expression C 0..1 Expression The expression to be evaluated #xD; headerField C 0..1 string HTTP header field name #xD; minimumId C 0..1 string Fixture Id of minimum content resource #xD; navigationLinks C 0..1 boolean Perform validation on navigation links? #xD; operator C 0..1 code equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval Binding: AssertionOperatorTypeValueSet (required): The type of operator to use for assertions. #xD; path CXD 0..1 string XPath or JSONPath expression #xD; requestMethod C 0..1 code delete | get | options | patch | post | put | head Binding: TestScriptRequestMethodCodeValueSet (required): The allowable request method or HTTP operation codes. #xD; requestURL C 0..1 string Request URL comparison value #xD; resource C 0..1 uri Resource type Binding: ConcreteFHIRTypes (extensible): A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. #xD; <a href="StructureDefinition-TestScript-definitions.html#TestScript.setup.action.assert.response" title="continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported.">response C 0..1 code continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported Binding: AssertionResponseTypesValueSet (required): The response code to expect in the response. #xD; responseCode C 0..1 string HTTP response code to test #xD; sourceId 0..1 id Fixture Id of source expression or headerField #xD; stopTestOnFail 1..1 boolean If this assert fails, will the current test execution stop? #xD; validateProfileId C 0..1 id Profile Id of validation profile reference #xD; value C 0..1 string The value to compare to #xD; warningOnly 1..1 boolean Will this assert produce a warning only on error? #xD; requirement 0..* BackboneElement Links or references to the testing requirements #xD; reference 1..1 canonical(Requirements) Canonical reference to the Requirements instance #xD; key 1..1 id Requirements statement key identifier #xD; test 0..* BackboneElement A test in this script #xD; name 0..1 string Tracking/logging name of this test #xD; description 0..1 string Tracking/reporting short description of the test #xD; action C 0..* BackboneElement A test operation or assert to perform #xD; common 0..1 See common Links or references to common collection(s) of actions #xD; operation C 0..1 See operation The setup operation to perform #xD; assert <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://build.fhir.org/conformance-rules.html#constraints" title="This element has or is affected by constraints ( tst-11, tst-12, tst-13, tst-14 )">C 0..1 See assert The setup assertion to perform #xD; teardown 0..1 BackboneElement A series of required clean up steps #xD; action 1..* BackboneElement One or more teardown operations to perform #xD; common 0..1 See common Links or references to common collection(s) of actions #xD; operation C 1..1 See operation The teardown operation to perform #xD; common 0..* BackboneElement A common collection of actions in this script #xD; key 1..1 id Key that identifies this common collection of actions #xD; name 0..1 string Tracking/logging name of this common collection of actions #xD; description 0..1 string Tracking/reporting short description of this common collection of actions #xD; parameter 0..* BackboneElement Parameter(s) to convey input values to this common collection of actions in this script #xD; name 0..1 string Tracking/logging name of this parameter to be used in this common collection of actions #xD; description 0..1 string Tracking/reporting short description of this parameter to be used this common collection of actions #xD; action C 1..* BackboneElement A common operation or assert that can be re-used in this script #xD; operation C 0..1 See operation The common operation that can be re-used in this script #xD; assert <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://build.fhir.org/conformance-rules.html#constraints" title="This element has or is affected by constraints ( tst-18, tst-19, tst-20, tst-21 )">C 0..1 See assert The common assertion to perform #xD; Documentation for this format
Specialized.Quality Reporting & Testing
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Name should be usable as an identifier for the module by machine processing applications such as code generation
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
If the resource is contained in another resource, it SHALL NOT contain nested Resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://build.fhir.org/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this test script, represented as a URI (globally unique)
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 is globally unique and a literal address 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 will remain the same when the test script is stored on different servers.
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](resource.html#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](resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the test script to be referenced by a single globally unique identifier.
URL should not contain | or # - these characters make processing canonical references problematic
Additional identifier for the test script
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.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
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.
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]. The version must not contain a '#' - see [Business Version](resource.html#bv-format).
Indicates the mechanism used to compare versions to determine which is more current.
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Name for this test script (computer friendly)
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.
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.
Name for this test script (human friendly)
A short, descriptive, user-friendly title for the test script.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this test script. Enables tracking the life-cycle of the content.
Allows filtering of test scripts that are appropriate for use versus not. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.
Allows filtering of test scripts that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc
Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script.
If absent, this resource is treated as though it is not experimental.
The date (and optionally time) when the test script was last significantly changed. 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.
The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Name of the publisher/steward (organization or individual)
The name of the organization or individual responsible for the release and ongoing maintenance of the test script.
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 is populated unless the information is available from context.
Helps establish the "authority/credibility" of the test script. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Natural language description of the test script
A free text natural language description of the test script from a consumer's perspective.
This description can be used to capture details such as 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 is 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).
The context that the content is intended to support
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.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for test script (if applicable)
A legal or geographic region in which the test script is intended to be used.
It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Countries and regions within which this artifact is targeted for use.
Explanation of why this test script is needed and why it has been designed as it has.
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.
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.
The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
Consumers must be able to determine any legal restrictions on the use of the test script and/or its content.
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Defines the content expected to be rendered in all representations of the artifact.
An abstract server representing a client or sender in a message exchange
An abstract server used in operations within this test script in the origin element.
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.
All FHIR elements must have a @value or children or both
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Number for the test system that is unique within this test script. Referenced by operation.origin and/or operation.destination.
A given test system index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as actor A and again as actor B within the same script as that could get confusing during test configuration). Different test system indices could play the same actor in the same test script. The operation.origin and/or operation.destination values defined elsewhere in the test script must be one of these test system indices.
A short human-friendly label for the test system that is unique within this test script and may be used when rendering the script.
Reference to requirements that must be satisfied by the test system.
Formatted information of this test system
Additional information about the role and capabilities of the systems that would participate in this portion of the script.
The explicit url path of the test system used in this test script. If populated, the test engine is not expected to prompt for or accept external input of this value.
This value represents the host location for an origin test system or the base url for a destination test system.
Required capability that is assumed to function correctly on the FHIR server being tested
The required capability must exist and are assumed to function correctly on the FHIR server being tested.
TestScript metadata capability will contain required or validated or both.
capability.required.exists() or capability.validated.exists()
A link to the FHIR specification that this test is covering.
URL to a particular requirement or feature within the FHIR specification.
Capabilities that are assumed to function correctly on the FHIR server being tested
Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
When the metadata capabilities section is defined at TestScript.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. 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.
Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
Description of the capabilities that this test script is requiring the server to support.
Which origin server these requirements apply to
Which origin server these requirements apply to.
Which server these requirements apply to
Which server these requirements apply to.
Links to the FHIR specification that describes this interaction and the resources involved in more detail.
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.
The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.
Indication of the artifact(s) that are tested by this test case
The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.
The specific conformance artifact being tested
The specific conformance artifact being tested. The canonical reference can be version-specific.
The expectation of whether the test must pass for the system to be considered conformant with the artifact: required - all tests are expected to pass, optional - all test are expected to pass but non-pass status may be allowed, strict - all tests are expected to pass and warnings are treated as a failure.
The expectation of whether the test must pass for the system to be considered conformant with the artifact.
The phase of testing for this artifact: unit - development / implementation phase, integration - internal system to system phase, production - live system to system phase (Note, this may involve pii/phi data).
Fixture in the test script - by reference (uri)
Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
Whether or not to implicitly create the fixture during setup
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.
Whether or not to implicitly delete the fixture during teardown
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.
Reference to the resource (containing the contents of the resource needed for operations). This is allowed to be a Parameters resource.
See the [Resource List](http://hl7.org/fhir/R5/resourcelist.html) for complete list of resource types.
The expression against the fixture to extract the required element
The expression for a specific element to extract from the fixture body.
If expression is defined then the evaluated element from the fixture will become the fixture contents. A test engine is expected to minimally support the expression languages: text/fhirpath, application/xml and application/json.
Reference to the profile to be used for validation.
Variable is set based either on element value in response body or on header field value in the response headers.
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.
Variable can only contain one of expression, headerField or path.
(expression.empty() and headerField.empty() and path.empty()) or (expression.empty() and (headerField.exists() xor path.exists())) or (headerField.empty() and (expression.exists() xor path.exists())) or (path.empty() and (expression.exists() xor headerField.exists()))
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.
Default, hard-coded, or user-defined value for this variable
A default, hard-coded, or user-defined value for this variable.
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.
Natural language description of the variable
A free text natural language description of the variable and its purpose.
The expression for a specific value to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
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. A test engine is expected to minimally support the expression languages: text/fhirpath, application/xml and application/json.
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
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.
Hint help text for default value to enter
Displayable text string with hint help information to the user when entering a default value.
XPath or JSONPath against the fixture body
XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
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.
Fixture Id of source expression or headerField within this variable
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
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.
A series of required setup operations before tests are executed
A series of required setup operations before tests are executed.
A setup common or operation or assert to perform
Action would contain either a common or operation or an assertion.
An action should contain only one of either a common or operation or an assertion. It can contain any number of variables.
Setup action will contain only one of either a common or an operation or an assert.
common.exists() xor operation.exists() xor assert.exists()
Links or references to common collection(s) of actions
Links or references to common collection(s) of actions in this or an external TestScript instance.
Canonical reference to the common TestScript instance
Canonical reference providing traceability to the common TestScript instance containing the commonKey.
If not defined, this TestScript instance is the container of the setup common key.
Common key reference that identifies the common collection of actions to perform
Common key reference that identifies the common collection of actions to perform as defined the this or the common testScript.
Parameter(s) to convey input values to the identified common collection of actions
Optional named parameter(s) to provide input values to the identified common collection of actions from this or an external TestScript.
Name of the parameter from the identified common collection of actions
The name of this parameter from the identified common collection of actions from this or an external TestScript.
Value to assign to the parameter from the identified common collection of actions
The value to assign to this parameter from the identified common collection of actions from this or an external TestScript.
The value data type is a generic string where the expectation is the actual value may be assigned to any action.opertion or action.assert element. The FHIR test engine must correctly assign the value to the target element's data type.
Setup operation will 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'))
The operation code type that will be executed
See the list of [server interactions](http://build.fhir.org/http.html).
The type of the FHIR resource. See the [resource list](http://hl7.org/fhir/R5/resourcelist.html). Data type of uri is needed when non-HL7 artifacts are identified.
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.
A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.
The label would be used for tracking/logging purposes by test engines.
This has no impact on the verification itself.
Tracking/reporting operation description
The description would be used by test engines for tracking and reporting purposes.
Mime type to accept in the payload of the response, with charset etc
The mime-type to use for RESTful operation in the 'Accept' header.
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.
The mime type of an attachment. Any valid mime type is allowed (BCP 13; RFCs 2045, 2046, 2047, 4288, 4289 and 2049), and also `json`, `xml`, and `ttl`.
Mime type of the request payload contents, with charset etc
The mime-type to use for RESTful operation in the 'Content-Type' header.
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.
The test system where the request message is destined. Must be one of the test system indices listed in TestScript.testSystem section.
If multiple TestScript.testSystem elements are defined and operation.destination is undefined, the test engine will report an error as it cannot determine what destination test system to use for the exchange.
Whether or not to send the request url in encoded format
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.
delete | get | options | patch | post | put | head
The HTTP method the test engine MUST use for this operation regardless of any other operation details.
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.
The allowable request method or HTTP operation codes.
The test system where the request message originates. Must be one of the test system indices listed in TestScript.testSystem section.
If absent, the test engine will send the message. When present, the test engine will not send the request message but will wait for the request message to be sent from this test system.
Path plus parameters after [type]. Used to set parts of the request URL explicitly.
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.
Each operation can have one or more header elements
Header elements would be used to set HTTP headers.
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. ["If-Match" header](http://build.fhir.org/http.html#2.1.0.5.1). See [Conditional Create using "If-None-Exist"](http://build.fhir.org/http.html#2.1.0.11). See [Invalid "Content-Type" header](http://build.fhir.org/http.html#2.1.0.13.1) for negative testing. - etc.
If header element is specified, then field is required.
The value of the header e.g. "application/fhir+xml".
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.
The fixture id (maybe new) to map to the request.
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.
The fixture id (maybe new) to map to the response.
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.
Fixture Id of body for PUT and POST requests
The id of the fixture used as the body of a PUT or POST request.
Id of fixture used for extracting the [id], [type], and [vid] for GET requests
Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
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.
Evaluates the results of previous operations to determine if the server under test behaves appropriately.
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.
Setup action assert will contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())
Setup action assert response and responseCode will be empty when direction equals request
(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'
A setup action assert will define a singular assertion function and prevent overlapping assertion functionality.
extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + requestURL.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <= 1)
A setup action assert will not allow the use of operator and value with minimumId, navigationLinks or validateProfileId.
extension.exists() or (minimumId.count() + navigationLinks.count() + validateProfileId.count() = 0) or (minimumId.count() + navigationLinks.count() + validateProfileId.count() = 1 and operator.count() + value.count() = 0)
The key that identifies this assert (unique within this TestScript).
This may be referenced by downstream assert.evaluateBasedOn for conditional evaluation by the test engine.
A list of zero or more assert.key references to conditionally determine if this assert will be evaluated.
This may reference upstream assert.key value(s) for conditional evaluation of this assert by the test engine.
Tracking/reporting assertion description
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.
The type of direction to use for assertion.
Id of the source fixture to be evaluated
Id of the source fixture used as the contents to be evaluated by either the "assert.compareToSourceExpression" or "assert.compareToSourcePath" definition.
The expression to evaluate against the source fixture
The expression for a specific value to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
The 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.
XPath or JSONPath expression to evaluate against the source fixture
XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
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.
Mime type to compare against the 'Content-Type' header
The mime-type contents to compare against the request or response message 'Content-Type' header.
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.
The default manual completion outcome applied to this assertion.
Manual completion is used to pause the test engine execution and evaluation allowing an external review of the defined assert condition. The defaultManualCompletion defines the default manual completion outcome applied if one of the enumerated values is not applied.
If defaultManualCompletion is not specified, then the default manual completion outcome will be 'skip'.
The type of operator to use for assertion.
The default type of manual completion to use for assertion.
The expression to be evaluated against the request or response message contents - HTTP headers and payload.
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. The expression can be evaluated as either a path to a specific value or as a boolean expression against the given sourceId. When the expression evaluates to a boolean, the assert.value element is not used. See [Testing FHIR Use Expressions](http://hl7.org/fhir/R5/testing.html#expressions). A test engine is expected to minimally support the expression languages: text/fhirpath, application/xml and application/json.
The HTTP header field name e.g. 'Location'.
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.
The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
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. See [Testing FHIR Use minimumId](http://hl7.org/fhir/R5/testing.html#minimumId) for a more complete description of the test engine's comparison logic.
Whether or not the test execution performs validation on the bundle navigation links.
Asserts that the Bundle contains first, last, and next links.
equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval
The operator type defines the conditional behavior of the assert.
Operators are useful for both positive and negative testing. If operator is not specified, then the default conditional behavior is implemented as defined in [Testing FHIR Assertions](http://hl7.org/fhir/R5/testing.html#assertion-table).
If operator is not specified, then the default conditional behavior is implemented as defined in the Testing FHIR page Assertions table - see Comments.
The type of operator to use for assertions.
The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
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 are to store the request and response body and headers of the last operation at all times for subsequent assertions.
The request method or HTTP operation code to compare against that used by the client system under test.
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.
The value to use in a comparison against the request URL path string.
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.
The type of the resource. See the [resource list](http://hl7.org/fhir/R5/resourcelist.html).
This will be expected resource type in response body e.g. in read, vread, search, etc. See the [Resource List](http://hl7.org/fhir/R5/resourcelist.html) for complete list of resource types; e.g. <resourceType value="Patient".
continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported
continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported.
This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. <contentType value="json" /> <response value="okay"/>.
The type of response code to use for assertion.
The response code to expect in the response.
The value of the HTTP response code to be tested.
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.
Fixture Id of source expression or headerField
Fixture to evaluate the XPath/JSONPath expression or the headerField against.
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.
If this assert fails, will the current test execution stop?
Whether or not the current test execution will stop on failure for this assert.
If this element is specified and it is true, then assertion failures should not stop the current test execution from proceeding.
Profile Id of validation profile reference
The ID of the Profile to validate against.
The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.
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.
Will this assert produce a warning only on error?
Whether or not the test execution will produce a warning only on error for this assert.
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.
Links or references to the testing requirements
Links or references providing traceability to the testing requirements for this assert.
TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.
Canonical reference to the Requirements instance
Canonical reference providing traceability to the testing requirement for this assert.
Requirements.statement.key that identifies the statement that this assert satisfies.
The name of this test used for tracking/logging purposes by test engines.
Tracking/reporting short description of the test
A short description of the test used by test engines for tracking and reporting purposes.
Action would contain either an operation or an assertion.
An action should contain either an operation or an assertion but not both. It can contain any number of variables.
Test action will contain only one of either a common or an operation or an assert.
An operation would involve a REST request to a server.
Test operation will 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'))
Test action assert will contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
Test action assert response and response and responseCode will be empty when direction equals request
A test action assert will define a singular assertion function and prevent overlapping assertion functionality.
A test action assert will not allow the use of operator and value with minimumId, navigationLinks or validateProfileId.
A series of operations required to clean up after all the tests are executed (successfully or otherwise).
One or more teardown operations to perform
The teardown action will only contain an operation.
Links or references to common collection(s) of actions in this or an external TestScript instance. Action asserts will be ignored for the TestScript.teardown.
Teardown operation will contain either sourceId or targetId or params or url.
A common collection of actions in this script
A common collection of actions that can be re-used in a TestScript.
Key that identifies this common collection of actions
Key that identifies this common collection of actions (unique within this resource).
Tracking/logging name of this common collection of actions
The name of this this common collection of actions used for tracking/logging purposes by test engines.
Tracking/reporting short description of this common collection of actions
A short description of this common collection of actions used by test engines for tracking and reporting purposes.
Parameter(s) to convey input values to this common collection of actions in this script
Optional named parameter(s) to provide input values to this common collection of actions from this or an external TestScript.
Tracking/logging name of this parameter to be used in this common collection of actions
The name of this parameter that will referenced in this common collection of actions using the TestScript variable nomenclature '${name}.
Tracking/reporting short description of this parameter to be used this common collection of actions
An optional short description of this parameter to be used this common collection of actions used by test engines for tracking and reporting purposes.
A common operation or assert that can be re-used in this script
An action will contain either an operation or an assertion but not both.
Common action will contain either an operation or assert but not both.
The common operation that can be re-used in this script
Common operation will contain either sourceId or targetId or params or url.
Common action assert will contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
Common action assert response and response and responseCode will be empty when direction equals request
A common action assert will define a singular assertion function and prevent overlapping assertion functionality.
A common action assert will not allow the use of operator and value with minimumId, navigationLinks or validateProfileId.
See the [Resource List](resourcelist.html) for complete list of resource types.
See the list of [server interactions](http.html).
The type of the FHIR resource. See the [resource list](resourcelist.html). Data type of uri is needed when non-HL7 artifacts are identified.
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. ["If-Match" header](http.html#2.1.0.5.1). See [Conditional Create using "If-None-Exist"](http.html#2.1.0.11). See [Invalid "Content-Type" header](http.html#2.1.0.13.1) for negative testing. - etc.
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. The expression can be evaluated as either a path to a specific value or as a boolean expression against the given sourceId. When the expression evaluates to a boolean, the assert.value element is not used. See [Testing FHIR Use Expressions](testing.html#expressions). A test engine is expected to minimally support the expression languages: text/fhirpath, application/xml and application/json.
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. See [Testing FHIR Use minimumId](testing.html#minimumId) for a more complete description of the test engine's comparison logic.
Operators are useful for both positive and negative testing. If operator is not specified, then the default conditional behavior is implemented as defined in [Testing FHIR Assertions](testing.html#assertion-table).
The type of the resource. See the [resource list](resourcelist.html).
This will be expected resource type in response body e.g. in read, vread, search, etc. See the [Resource List](resourcelist.html) for complete list of resource types; e.g. <resourceType value="Patient".