FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the TestScript resource.

TestScript
Element IdTestScript
Definition

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Short DisplayDescribes a set of tests
Cardinality0..*
TypeCanonicalResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
TestScript.url
Element IdTestScript.url
Definition

An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.

Short DisplayCanonical identifier for this test script, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the test script to be referenced by a single globally unique identifier.

Alternate Namesurl; authoritative-url; destination; identity
Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
TestScript.identifier
Element IdTestScript.identifier
Definition

A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short DisplayAdditional identifier for the test script
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI.

TestScript.version
Element IdTestScript.version
Definition

The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Short DisplayBusiness version of the test script
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

TestScript.versionAlgorithm[x]
Element IdTestScript.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

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.

TestScript.name
Element IdTestScript.name
Definition

A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short DisplayName for this test script (computer friendly)
Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
TestScript.title
Element IdTestScript.title
Definition

A short, descriptive, user-friendly title for the test script.

Short DisplayName for this test script (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

TestScript.status
Element IdTestScript.status
Definition

The status of this test script. Enables tracking the life-cycle of the content.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of test scripts that are appropriate for use versus not.

TestScript.experimental
Element IdTestScript.experimental
Definition

A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script.

Summarytrue
Comments

Allows filtering of test scripts that are appropriate for use versus not.

TestScript.date
Element IdTestScript.date
Definition

The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

TestScript.publisher
Element IdTestScript.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the test script.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..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. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context.

TestScript.contact
Element IdTestScript.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

TestScript.description
Element IdTestScript.description
Definition

A free text natural language description of the test script from a consumer's perspective.

Short DisplayNatural language description of the test script
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

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 SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created).

TestScript.useContext
Element IdTestScript.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

TestScript.jurisdiction
Element IdTestScript.jurisdiction
Definition

A legal or geographic region in which the test script is intended to be used.

Short DisplayIntended jurisdiction for test script (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended.

TestScript.purpose
Element IdTestScript.purpose
Definition

Explanation of why this test script is needed and why it has been designed as it has.

Short DisplayWhy this test script is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script.

TestScript.copyright
Element IdTestScript.copyright
Definition

A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the test script and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

...

TestScript.copyrightLabel
Element IdTestScript.copyrightLabel
Definition

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').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

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.

TestScript.origin
Element IdTestScript.origin
Definition

An abstract server used in operations within this test script in the origin element.

Short DisplayAn abstract server representing a client or sender in a message exchange
Cardinality0..*
Summaryfalse
Comments

The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.

TestScript.origin.index
Element IdTestScript.origin.index
Definition

Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.

Short DisplayThe index of the abstract origin server starting at 1
Cardinality1..1
Typeinteger
Summaryfalse
Comments

A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration).

Different origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler).

The origin indices provided elsewhere in the test script must be one of these origin indices.

TestScript.origin.profile
Element IdTestScript.origin.profile
Definition

The type of origin profile the test system supports.

Short DisplayFHIR-Client | FHIR-SDC-FormFiller
Cardinality1..1
Terminology BindingTestScriptProfileOriginType (Extensible)
TypeCoding
Meaning if MissingFHIR-Client
Summaryfalse
Comments

Must be a "sender"/"client" profile.

TestScript.destination
Element IdTestScript.destination
Definition

An abstract server used in operations within this test script in the destination element.

Short DisplayAn abstract server representing a destination or receiver in a message exchange
Cardinality0..*
Summaryfalse
Comments

The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.

TestScript.destination.index
Element IdTestScript.destination.index
Definition

Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.

Short DisplayThe index of the abstract destination server starting at 1
Cardinality1..1
Typeinteger
Summaryfalse
Comments

A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration).

Different destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager).

The destination indices provided elsewhere in the test script must be one of these destination indices.

TestScript.destination.profile
Element IdTestScript.destination.profile
Definition

The type of destination profile the test system supports.

Short DisplayFHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor
Cardinality1..1
Terminology BindingTestScriptProfileDestinationType (Extensible)
TypeCoding
Meaning if MissingFHIR-Server
Summaryfalse
Comments

Must be a "receiver"/"server" profile.

TestScript.metadata
Element IdTestScript.metadata
Definition

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

Short DisplayRequired capability that is assumed to function correctly on the FHIR server being tested
Cardinality0..1
Summaryfalse
Invariants
Defined on this element
tst-4Rule TestScript metadata capability SHALL contain required or validated or both.capability.required.exists() or capability.validated.exists()
TestScript.metadata.link
Element IdTestScript.metadata.link
Definition

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

Short DisplayLinks to the FHIR specification
Cardinality0..*
Summaryfalse
TestScript.metadata.link.url
Element IdTestScript.metadata.link.url
Definition

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

Short DisplayURL to the specification
Cardinality1..1
Typeuri
Summaryfalse
TestScript.metadata.link.description
Element IdTestScript.metadata.link.description
Definition

Short description of the link.

Short DisplayShort description
Cardinality0..1
Typestring
Summaryfalse
TestScript.metadata.capability
Element IdTestScript.metadata.capability
Definition

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

Short DisplayCapabilities that are assumed to function correctly on the FHIR server being tested
Cardinality1..*
Summaryfalse
Comments

When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script.

TestScript.metadata.capability.required
Element IdTestScript.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.

Short DisplayAre the capabilities required?
Cardinality1..1
Typeboolean
Summaryfalse
TestScript.metadata.capability.validated
Element IdTestScript.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.

Short DisplayAre the capabilities validated?
Cardinality1..1
Typeboolean
Summaryfalse
TestScript.metadata.capability.description
Element IdTestScript.metadata.capability.description
Definition

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

Short DisplayThe expected capabilities of the server
Cardinality0..1
Typestring
Summaryfalse
TestScript.metadata.capability.origin
Element IdTestScript.metadata.capability.origin
Definition

Which origin server these requirements apply to.

Short DisplayWhich origin server these requirements apply to
Cardinality0..*
Typeinteger
Summaryfalse
TestScript.metadata.capability.destination
Element IdTestScript.metadata.capability.destination
Definition

Which server these requirements apply to.

Short DisplayWhich server these requirements apply to
Cardinality0..1
Typeinteger
Summaryfalse
TestScript.metadata.capability.link
Element IdTestScript.metadata.capability.link
Definition

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

Short DisplayLinks to the FHIR specification
Cardinality0..*
Typeuri
Summaryfalse
TestScript.metadata.capability.capabilities
Element IdTestScript.metadata.capability.capabilities
Definition

Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.

Short DisplayRequired Capability Statement
Cardinality1..1
Typecanonical(CapabilityStatement)
Summaryfalse
Comments

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

TestScript.scope
Element IdTestScript.scope
Definition

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.

Short DisplayIndication of the artifact(s) that are tested by this test case
Cardinality0..*
Summaryfalse
TestScript.scope.artifact
Element IdTestScript.scope.artifact
Definition

The specific conformance artifact being tested. The canonical reference can be version-specific.

Short DisplayThe specific conformance artifact being tested
Cardinality1..1
Typecanonical(Any)
Summaryfalse
TestScript.scope.conformance
Element IdTestScript.scope.conformance
Definition

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.

Short Displayrequired | optional | strict
Cardinality0..1
Terminology BindingTestScriptScopeConformanceType (Extensible)
TypeCodeableConcept
Meaning if Missingrequired
Summaryfalse
TestScript.scope.phase
Element IdTestScript.scope.phase
Definition

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

Short Displayunit | integration | production
Cardinality0..1
Terminology BindingTestScriptScopePhaseType (Extensible)
TypeCodeableConcept
Meaning if Missingunit
Summaryfalse
TestScript.fixture
Element IdTestScript.fixture
Definition

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

Short DisplayFixture in the test script - by reference (uri)
Cardinality0..*
Summaryfalse
TestScript.fixture.autocreate
Element IdTestScript.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.

Short DisplayWhether or not to implicitly create the fixture during setup
Cardinality1..1
Typeboolean
Summaryfalse
TestScript.fixture.autodelete
Element IdTestScript.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.

Short DisplayWhether or not to implicitly delete the fixture during teardown
Cardinality1..1
Typeboolean
Summaryfalse
TestScript.fixture.resource
Element IdTestScript.fixture.resource
Definition

Reference to the resource (containing the contents of the resource needed for operations). This is allowed to be a Parameters resource.

Short DisplayReference of the resource
Cardinality0..1
TypeReference(Any)
Summaryfalse
Comments

See http://build.fhir.org/resourcelist.html for complete list of resource types.

TestScript.profile
Element IdTestScript.profile
Definition

Reference to the profile to be used for validation.

Short DisplayReference of the validation profile
Cardinality0..*
TypeReference(Any)
Summaryfalse
Comments

See http://build.fhir.org/resourcelist.html for complete list of resource types.

TestScript.variable
Element IdTestScript.variable
Definition

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

Short DisplayPlaceholder for evaluated elements
Cardinality0..*
Summaryfalse
Comments

Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml.

Invariants
Defined on this element
tst-3Rule Variable can only contain one of expression, headerField or path.expression.empty() or headerField.empty() or path.empty()
TestScript.variable.name
Element IdTestScript.variable.name
Definition

Descriptive name for this variable.

Short DisplayDescriptive name for this variable
Cardinality1..1
Typestring
Summaryfalse
Comments

Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed.

TestScript.variable.defaultValue
Element IdTestScript.variable.defaultValue
Definition

A default, hard-coded, or user-defined value for this variable.

Short DisplayDefault, hard-coded, or user-defined value for this variable
Cardinality0..1
Typestring
Summaryfalse
Comments

The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values.

TestScript.variable.description
Element IdTestScript.variable.description
Definition

A free text natural language description of the variable and its purpose.

Short DisplayNatural language description of the variable
Cardinality0..1
Typestring
Summaryfalse
TestScript.variable.expression
Element IdTestScript.variable.expression
Definition

The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.

Short DisplayThe FHIRPath expression against the fixture body
Cardinality0..1
Typestring
Summaryfalse
Comments

If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.

TestScript.variable.headerField
Element IdTestScript.variable.headerField
Definition

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

Short DisplayHTTP header field name for source
Cardinality0..1
Typestring
Summaryfalse
Comments

If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path.

TestScript.variable.hint
Element IdTestScript.variable.hint
Definition

Displayable text string with hint help information to the user when entering a default value.

Short DisplayHint help text for default value to enter
Cardinality0..1
Typestring
Summaryfalse
TestScript.variable.path
Element IdTestScript.variable.path
Definition

XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.

Short DisplayXPath or JSONPath against the fixture body
Cardinality0..1
Typestring
Summaryfalse
Comments

If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.

TestScript.variable.sourceId
Element IdTestScript.variable.sourceId
Definition

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

Short DisplayFixture Id of source expression or headerField within this variable
Cardinality0..1
Typeid
Summaryfalse
Comments

This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the action.operation element.

TestScript.setup
Element IdTestScript.setup
Definition

A series of required setup operations before tests are executed.

Short DisplayA series of required setup operations before tests are executed
Cardinality0..1
Summaryfalse
TestScript.setup.action
Element IdTestScript.setup.action
Definition

Action would contain either an operation or an assertion.

Short DisplayA setup operation or assert to perform
Cardinality1..*
Summaryfalse
Comments

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

Invariants
Defined on this element
tst-1Rule Setup action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
TestScript.setup.action.operation
Element IdTestScript.setup.action.operation
Definition

The operation to perform.

Short DisplayThe setup operation to perform
Cardinality0..1
Summaryfalse
Invariants
Defined on this element
tst-7Rule Setup operation SHALL contain either sourceId or targetId or params or url.sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history'))
TestScript.setup.action.operation.type
Element IdTestScript.setup.action.operation.type
Definition

Server interaction or operation type.

Short DisplayThe operation code type that will be executed
Cardinality0..1
Terminology BindingTestScriptOperationCode (Extensible)
TypeCoding
Summaryfalse
Comments

See http://build.fhir.org/http.html for list of server interactions.

TestScript.setup.action.operation.resource
Element IdTestScript.setup.action.operation.resource
Definition

The type of the FHIR resource. See http://build.fhir.org/resourcelist.html. Data type of uri is needed when non-HL7 artifacts are identified.

Short DisplayResource type
Cardinality0..1
Terminology BindingConcrete FHIR Types (Extensible)
Typeuri
Summaryfalse
Comments

If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used.

TestScript.setup.action.operation.label
Element IdTestScript.setup.action.operation.label
Definition

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

Short DisplayTracking/logging operation label
Cardinality0..1
Typestring
Summaryfalse
Comments

This has no impact on the verification itself.

TestScript.setup.action.operation.description
Element IdTestScript.setup.action.operation.description
Definition

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

Short DisplayTracking/reporting operation description
Cardinality0..1
Typestring
Summaryfalse
Comments

This has no impact on the verification itself.

TestScript.setup.action.operation.accept
Element IdTestScript.setup.action.operation.accept
Definition

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

Short DisplayMime type to accept in the payload of the response, with charset etc.
Cardinality0..1
Terminology BindingMime Types (Required)
Typecode
Summaryfalse
Comments

If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element.

TestScript.setup.action.operation.contentType
Element IdTestScript.setup.action.operation.contentType
Definition

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

Short DisplayMime type of the request payload contents, with charset etc.
Cardinality0..1
Terminology BindingMime Types (Required)
Typecode
Summaryfalse
Comments

If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element.

TestScript.setup.action.operation.destination
Element IdTestScript.setup.action.operation.destination
Definition

The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.

Short DisplayServer responding to the request
Cardinality0..1
Typeinteger
Summaryfalse
Comments

If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange.

TestScript.setup.action.operation.encodeRequestUrl
Element IdTestScript.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.

Short DisplayWhether or not to send the request url in encoded format
Cardinality1..1
Typeboolean
Summaryfalse
TestScript.setup.action.operation.method
Element IdTestScript.setup.action.operation.method
Definition

The HTTP method the test engine MUST use for this operation regardless of any other operation details.

Short Displaydelete | get | options | patch | post | put | head
Cardinality0..1
Terminology BindingTestScriptRequestMethodCode (Required)
Typecode
Summaryfalse
Comments

The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing.

TestScript.setup.action.operation.origin
Element IdTestScript.setup.action.operation.origin
Definition

The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.

Short DisplayServer initiating the request
Cardinality0..1
Typeinteger
Summaryfalse
Comments

If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server.

TestScript.setup.action.operation.params
Element IdTestScript.setup.action.operation.params
Definition

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

Short DisplayExplicitly defined path parameters
Cardinality0..1
Typestring
Summaryfalse
Comments

If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Test engines would append whatever is specified for "params" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The "params" element does not correspond exactly to "search parameters". Nor is it the "path". It corresponds to the part of the URL that comes after the [type] (when "resource" element is specified); e.g. It corresponds to "/[id]/_history/[vid] {?_format=[mime-type]}" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.

TestScript.setup.action.operation.requestHeader
Element IdTestScript.setup.action.operation.requestHeader
Definition

Header elements would be used to set HTTP headers.

Short DisplayEach operation can have one or more header elements
Cardinality0..*
Summaryfalse
Comments

This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. See http://build.fhir.org/http.html#2.1.0.5.1 - "If-Match" header. See http://build.fhir.org/http.html#2.1.0.11 - Conditional Create using "If-None-Exist". See http://build.fhir.org/http.html#2.1.0.13.1 - Invalid "Content-Type" header for negative testing. - etc.

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

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

Short DisplayHTTP header field name
Cardinality1..1
Typestring
Summaryfalse
Comments

If header element is specified, then field is required.

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

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

Short DisplayHTTP headerfield value
Cardinality1..1
Typestring
Summaryfalse
Comments

If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.

TestScript.setup.action.operation.requestId
Element IdTestScript.setup.action.operation.requestId
Definition

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

Short DisplayFixture Id of mapped request
Cardinality0..1
Typeid
Summaryfalse
Comments

If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "requestId". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified.

TestScript.setup.action.operation.responseId
Element IdTestScript.setup.action.operation.responseId
Definition

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

Short DisplayFixture Id of mapped response
Cardinality0..1
Typeid
Summaryfalse
Comments

If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "responseId". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified.

TestScript.setup.action.operation.sourceId
Element IdTestScript.setup.action.operation.sourceId
Definition

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

Short DisplayFixture Id of body for PUT and POST requests
Cardinality0..1
Typeid
Summaryfalse
TestScript.setup.action.operation.targetId
Element IdTestScript.setup.action.operation.targetId
Definition

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

Short DisplayId of fixture used for extracting the [id], [type], and [vid] for GET requests
Cardinality0..1
Typeid
Summaryfalse
Comments

If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used.

TestScript.setup.action.operation.url
Element IdTestScript.setup.action.operation.url
Definition

Complete request URL.

Short DisplayRequest URL
Cardinality0..1
Typestring
Summaryfalse
Comments

Used to set the request URL explicitly. If "url" element is defined, then "targetId", "resource", and "params" elements will be ignored. Test engines would use whatever is specified in "url" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.

TestScript.setup.action.assert
Element IdTestScript.setup.action.assert
Definition

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

Short DisplayThe assertion to perform
Cardinality0..1
Summaryfalse
Comments

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

Invariants
Defined on this element
tst-5Rule Only a single assertion SHALL be present within setup action assert element.extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) or (((expression.count() + minimumId.count() <=2) or (expression.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1)) or (((path.count() + minimumId.count() <=2) or (path.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1))
tst-10Rule Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())
tst-12Rule Setup action assert response and responseCode SHALL be empty when direction equals request(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'
TestScript.setup.action.assert.label
Element IdTestScript.setup.action.assert.label
Definition

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

Short DisplayTracking/logging assertion label
Cardinality0..1
Typestring
Summaryfalse
Comments

This has no impact on the verification itself.

TestScript.setup.action.assert.description
Element IdTestScript.setup.action.assert.description
Definition

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

Short DisplayTracking/reporting assertion description
Cardinality0..1
Typestring
Summaryfalse
Comments

This has no impact on the verification itself.

TestScript.setup.action.assert.direction
Element IdTestScript.setup.action.assert.direction
Definition

The direction to use for the assertion.

Short Displayresponse | request
Cardinality0..1
Terminology BindingAssertionDirectionType (Required)
Typecode
Summaryfalse
Comments

If the direction is specified as "response" (the default), then the processing of this assert is against the received response message. If the direction is specified as "request", then the processing of this assert is against the sent request message.

TestScript.setup.action.assert.compareToSourceId
Element IdTestScript.setup.action.assert.compareToSourceId
Definition

Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.

Short DisplayId of the source fixture to be evaluated
Cardinality0..1
Typestring
Summaryfalse
TestScript.setup.action.assert.compareToSourceExpression
Element IdTestScript.setup.action.assert.compareToSourceExpression
Definition

The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.

Short DisplayThe FHIRPath expression to evaluate against the source fixture
Cardinality0..1
Typestring
Summaryfalse
Comments

Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated.

TestScript.setup.action.assert.compareToSourcePath
Element IdTestScript.setup.action.assert.compareToSourcePath
Definition

XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.

Short DisplayXPath or JSONPath expression to evaluate against the source fixture
Cardinality0..1
Typestring
Summaryfalse
Comments

The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated.

TestScript.setup.action.assert.contentType
Element IdTestScript.setup.action.assert.contentType
Definition

The mime-type contents to compare against the request or response message 'Content-Type' header.

Short DisplayMime type to compare against the 'Content-Type' header
Cardinality0..1
Terminology BindingMime Types (Required)
Typecode
Summaryfalse
Comments

If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If "assert.sourceId" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead.

TestScript.setup.action.assert.expression
Element IdTestScript.setup.action.assert.expression
Definition

The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.

Short DisplayThe FHIRPath expression to be evaluated
Cardinality0..1
Typestring
Summaryfalse
Comments

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

TestScript.setup.action.assert.headerField
Element IdTestScript.setup.action.assert.headerField
Definition

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

Short DisplayHTTP header field name
Cardinality0..1
Typestring
Summaryfalse
Comments

If "headerField" is specified then "value" must be specified. If "sourceId" is not specified, then "headerField" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers.

TestScript.setup.action.assert.minimumId
Element IdTestScript.setup.action.assert.minimumId
Definition

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

Short DisplayFixture Id of minimum content resource
Cardinality0..1
Typestring
Summaryfalse
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
Element IdTestScript.setup.action.assert.navigationLinks
Definition

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

Short DisplayPerform validation on navigation links?
Cardinality0..1
Typeboolean
Summaryfalse
Comments

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

TestScript.setup.action.assert.operator
Element IdTestScript.setup.action.assert.operator
Definition

The operator type defines the conditional behavior of the assert. If not defined, the default is equals.

Short Displayequals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
Cardinality0..1
Terminology BindingAssertionOperatorType (Required)
Typecode
Summaryfalse
Comments

Operators are useful especially for negative testing. If operator is not specified, then the "equals" operator is assumed; e.g. \<code> \<assert> \<operator value="in" /> \<responseCode value="200,201,204" /> </assert> \<assert> \<operator value="notEquals" /> \<response value="okay"/> </assert> \<assert> \<operator value="greaterThan" /> \<responseHeader> \<field value="Content-Length" /> \<value value="0" /> </responseHeader/> </assert> </code>.

TestScript.setup.action.assert.path
Element IdTestScript.setup.action.assert.path
Definition

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

Short DisplayXPath or JSONPath expression
Cardinality0..1
Typestring
Summaryfalse
Comments

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

TestScript.setup.action.assert.requestMethod
Element IdTestScript.setup.action.assert.requestMethod
Definition

The request method or HTTP operation code to compare against that used by the client system under test.

Short Displaydelete | get | options | patch | post | put | head
Cardinality0..1
Terminology BindingTestScriptRequestMethodCode (Required)
Typecode
Summaryfalse
Comments

If "requestMethod" is specified then it will be used in place of "value". The "requestMethod" will evaluate against the last operation's request HTTP operation.

TestScript.setup.action.assert.requestURL
Element IdTestScript.setup.action.assert.requestURL
Definition

The value to use in a comparison against the request URL path string.

Short DisplayRequest URL comparison value
Cardinality0..1
Typestring
Summaryfalse
Comments

If "requestURL" is specified then it will be used in place of "value". The "requestURL" will evaluate against the last operation's full request URL path string.

TestScript.setup.action.assert.resource
Element IdTestScript.setup.action.assert.resource
Definition

The type of the resource. See http://build.fhir.org/resourcelist.html.

Short DisplayResource type
Cardinality0..1
Terminology BindingConcrete FHIR Types (Extensible)
Typeuri
Summaryfalse
Comments

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

TestScript.setup.action.assert.response
Element IdTestScript.setup.action.assert.response
Definition

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

Short Displayokay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
Cardinality0..1
Terminology BindingAssertionResponseTypes (Required)
Typecode
Summaryfalse
Comments

This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. <assert> <contentType value="json" /> <response value="okay"/> </assert>.

TestScript.setup.action.assert.responseCode
Element IdTestScript.setup.action.assert.responseCode
Definition

The value of the HTTP response code to be tested.

Short DisplayHTTP response code to test
Cardinality0..1
Typestring
Summaryfalse
Comments

To be used with "operator" attribute value. Asserts that the response code equals this value if "operator" is not specified. If the operator is "in" or "notIn" then the responseCode would be a comma-separated list of values e.g. "200,201". Otherwise, it's expected to be a numeric value. If "fixture" is not specified, then the "responseBodyId" value of the last operation is assumed.

TestScript.setup.action.assert.sourceId
Element IdTestScript.setup.action.assert.sourceId
Definition

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

Short DisplayFixture Id of source expression or headerField
Cardinality0..1
Typeid
Summaryfalse
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.stopTestOnFail
Element IdTestScript.setup.action.assert.stopTestOnFail
Definition

Whether or not the current test execution will stop on failure for this assert.

Short DisplayIf this assert fails, will the current test execution stop?
Cardinality1..1
Typeboolean
Summaryfalse
Comments

If this element is specified and it is true, then assertion failures should not stop the current test execution from proceeding.

TestScript.setup.action.assert.validateProfileId
Element IdTestScript.setup.action.assert.validateProfileId
Definition

The ID of the Profile to validate against.

Short DisplayProfile Id of validation profile reference
Cardinality0..1
Typeid
Summaryfalse
Comments

The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.

TestScript.setup.action.assert.value
Element IdTestScript.setup.action.assert.value
Definition

The value to compare to.

Short DisplayThe value to compare to
Cardinality0..1
Typestring
Summaryfalse
Comments

The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value.

TestScript.setup.action.assert.warningOnly
Element IdTestScript.setup.action.assert.warningOnly
Definition

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

Short DisplayWill this assert produce a warning only on error?
Cardinality1..1
Typeboolean
Summaryfalse
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
Element IdTestScript.test
Definition

A test in this script.

Short DisplayA test in this script
Cardinality0..*
Summaryfalse
TestScript.test.name
Element IdTestScript.test.name
Definition

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

Short DisplayTracking/logging name of this test
Cardinality0..1
Typestring
Summaryfalse
TestScript.test.description
Element IdTestScript.test.description
Definition

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

Short DisplayTracking/reporting short description of the test
Cardinality0..1
Typestring
Summaryfalse
TestScript.test.action
Element IdTestScript.test.action
Definition

Action would contain either an operation or an assertion.

Short DisplayA test operation or assert to perform
Cardinality1..*
Summaryfalse
Comments

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

Invariants
Defined on this element
tst-2Rule Test action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
TestScript.test.action.operation
Element IdTestScript.test.action.operation
Definition

An operation would involve a REST request to a server.

Short DisplayThe setup operation to perform
Cardinality0..1
TypeSee TestScript.setup.action.operation
Summaryfalse
Invariants
Defined on this element
tst-8Rule Test operation SHALL contain either sourceId or targetId or params or url.sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))
TestScript.test.action.assert
Element IdTestScript.test.action.assert
Definition

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

Short DisplayThe setup assertion to perform
Cardinality0..1
TypeSee TestScript.setup.action.assert
Summaryfalse
Comments

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

Invariants
Defined on this element
tst-6Rule Only a single assertion SHALL be present within test action assert element.extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) or (((expression.count() + minimumId.count() <=2) or (expression.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1)) or (((path.count() + minimumId.count() <=2) or (path.count() + validateProfileId.count() <=2)) and (expression.count() + path.count() <=1) and (minimumId.count() + validateProfileId.count() <=1))
tst-11Rule Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())
tst-13Rule Test action assert response and response and responseCode SHALL be empty when direction equals request(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'
TestScript.teardown
Element IdTestScript.teardown
Definition

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

Short DisplayA series of required clean up steps
Cardinality0..1
Summaryfalse
TestScript.teardown.action
Element IdTestScript.teardown.action
Definition

The teardown action will only contain an operation.

Short DisplayOne or more teardown operations to perform
Cardinality1..*
Summaryfalse
Comments

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

TestScript.teardown.action.operation
Element IdTestScript.teardown.action.operation
Definition

An operation would involve a REST request to a server.

Short DisplayThe teardown operation to perform
Cardinality1..1
TypeSee TestScript.setup.action.operation
Summaryfalse
Invariants
Defined on this element
tst-9Rule Teardown operation SHALL contain either sourceId or targetId or params or url.sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))