This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
Mixed
Normative
and
STU
see
ballot
notes
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
FHIR
Infrastructure
Work
Group
|
|
Trial Use |
| Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the TestScript resource.
| TestScript | |||||||||||||||||||||||||||||
| Element Id | TestScript | ||||||||||||||||||||||||||||
| Definition | A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. | ||||||||||||||||||||||||||||
| Short Display | Describes a set of tests | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Type | CanonicalResource | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||
| TestScript.url | |||||||||||||||||||||||||||||
| Element Id | TestScript.url | ||||||||||||||||||||||||||||
| Definition |
An
absolute
URI
that
is
used
to
identify
this
test
script
when
it
is
referenced
in
a
specification,
model,
design
or
an
instance;
also
called
its
canonical
identifier.
This
SHOULD
be
globally
unique
and
SHOULD
be
a
literal
address
at
which
an
authoritative
instance
of
this
test
script
is
(or
will
be)
published.
This
URL
can
be
the
target
of
a
| ||||||||||||||||||||||||||||
| Short Display | Canonical identifier for this test script, represented as a URI (globally unique) | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Requirements | Allows the test script to be referenced by a single globally unique identifier. | ||||||||||||||||||||||||||||
| Alternate Names | url; authoritative-url; destination; identity | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments |
Can
be
a
urn:uuid:
or
a
urn:oid:
but
real
http:
addresses
are
preferred.
Multiple
instances
may
share
the
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 |
| ||||||||||||||||||||||||||||
| TestScript.identifier | |||||||||||||||||||||||||||||
| Element Id | TestScript.identifier | ||||||||||||||||||||||||||||
| Definition | A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||||||||||||||||||||||
| Short Display | Additional identifier for the test script | ||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion ) | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Type | Identifier | ||||||||||||||||||||||||||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||||||||||||||||||
| TestScript.version | |||||||||||||||||||||||||||||
| Element Id | TestScript.version | ||||||||||||||||||||||||||||
| Definition | The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
|
| true | ||||||||||||||||||||||||||||
| Comments |
| ||||||||||||||||||||||||||||
| TestScript.versionAlgorithm[x] | |||||||||||||||||||||||||||||
| Element Id | TestScript.versionAlgorithm[x] | ||||||||||||||||||||||||||||
| Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||||||||||||||||||||||
| Short Display | How to compare versions | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Version Algorithm ( Extensible ) | ||||||||||||||||||||||||||||
| Type | string | Coding | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||||||
| TestScript.name | |||||||||||||||||||||||||||||
| Element Id | TestScript.name | ||||||||||||||||||||||||||||
| Definition | A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
||||||||||||||||||||||||||||
|
|
Name for this test script (computer friendly) | ||||||||||||||||||||||||||||
|
Cardinality
|
1..1 | ||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
|
|
Support human navigation and code generation. | ||||||||||||||||||||||||||||
|
Summary
|
true | ||||||||||||||||||||||||||||
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||
| TestScript.title | |||||||||||||||||||||||||||||
| Element Id | TestScript.title | ||||||||||||||||||||||||||||
| Definition | A short, descriptive, user-friendly title for the test script. | ||||||||||||||||||||||||||||
| Short Display | Name for this test script (human friendly) | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||||||
| TestScript.status | |||||||||||||||||||||||||||||
| Element Id | TestScript.status | ||||||||||||||||||||||||||||
| Definition |
The status of this test script. Enables tracking the life-cycle of the content. | ||||||||||||||||||||||||||||
| Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Terminology Binding | PublicationStatus ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | Allows filtering of test scripts that are appropriate for use versus not. | ||||||||||||||||||||||||||||
| TestScript.experimental | |||||||||||||||||||||||||||||
| Element Id | TestScript.experimental | ||||||||||||||||||||||||||||
| Definition |
A
Boolean
value
| ||||||||||||||||||||||||||||
| Short Display | For testing purposes, not real usage | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Meaning if Missing | If 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. | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | Allows filtering of test scripts that are appropriate for use versus not. | ||||||||||||||||||||||||||||
| TestScript.date | |||||||||||||||||||||||||||||
| Element Id | TestScript.date | ||||||||||||||||||||||||||||
| Definition | The date (and optionally time) when the test script was 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. | ||||||||||||||||||||||||||||
| Short Display | Date last changed | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | dateTime | ||||||||||||||||||||||||||||
| Alternate Names | Revision Date | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | 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. | ||||||||||||||||||||||||||||
| TestScript.publisher | |||||||||||||||||||||||||||||
| Element Id | TestScript.publisher | ||||||||||||||||||||||||||||
| Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the test script. | ||||||||||||||||||||||||||||
| Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Requirements | Helps establish the "authority/credibility" of the test script. May also allow for contact. | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context. | ||||||||||||||||||||||||||||
| TestScript.contact | |||||||||||||||||||||||||||||
| Element Id | TestScript.contact | ||||||||||||||||||||||||||||
| Definition |
Contact
details
to
assist
a
user
in
finding
and
communicating
with
the
|
||||||||||||||||||||||||||||
| Short Display | Contact details for the publisher | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||||||||||||||||||
| TestScript.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.description | ||||||||||||||||||||||||||||
| Definition | A free text natural language description of the test script from a consumer's perspective. | ||||||||||||||||||||||||||||
| Short Display | Natural language description of the test script | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
This
| ||||||||||||||||||||||||||||
| TestScript.useContext | |||||||||||||||||||||||||||||
| Element Id | TestScript.useContext | ||||||||||||||||||||||||||||
| Definition |
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
contexts
may
be
general
categories
(gender,
age,
...)
or
may
be
references
to
specific
programs
(insurance
plans,
studies,
...)
and
may
be
used
to
assist
with
indexing
and
searching
for
| ||||||||||||||||||||||||||||
| Short Display | The context that the content is intended to support | ||||||||||||||||||||||||||||
|
Cardinality
|
0..* | ||||||||||||||||||||||||||||
|
Type
|
UsageContext | ||||||||||||||||||||||||||||
| Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||||||
| TestScript.jurisdiction | |||||||||||||||||||||||||||||
| Element Id | TestScript.jurisdiction | ||||||||||||||||||||||||||||
| Definition | A legal or geographic region in which the test script is intended to be used. | ||||||||||||||||||||||||||||
| Short Display | Intended jurisdiction for test script (if applicable) | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Terminology Binding |
Jurisdiction
ValueSet
(
Extensible
)
|
||||||||||||||||||||||||||||
|
Type
|
CodeableConcept | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Comments | It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||||||||||||||||||||||
| TestScript.purpose | |||||||||||||||||||||||||||||
| Element Id | TestScript.purpose | ||||||||||||||||||||||||||||
| Definition | Explanation of why this test script is needed and why it has been designed as it has. | ||||||||||||||||||||||||||||
| Short Display | Why this test script is defined | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script. | ||||||||||||||||||||||||||||
| TestScript.copyright | |||||||||||||||||||||||||||||
| Element Id | TestScript.copyright | ||||||||||||||||||||||||||||
| Definition | A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script. | ||||||||||||||||||||||||||||
| Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||||||||||
| Requirements | Consumers must be able to determine any legal restrictions on the use of the test script and/or its content. | ||||||||||||||||||||||||||||
| Alternate Names | License; Restrictions | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | ... | ||||||||||||||||||||||||||||
| TestScript.copyrightLabel | |||||||||||||||||||||||||||||
| Element Id | TestScript.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 Display | Copyright holder and year(s) | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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 Id | TestScript.origin | ||||||||||||||||||||||||||||
| Definition | An abstract server used in operations within this test script in the origin element. | ||||||||||||||||||||||||||||
| Short Display | An abstract server representing a client or sender in a message exchange | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction. | ||||||||||||||||||||||||||||
| TestScript.origin.index | |||||||||||||||||||||||||||||
| Element Id | TestScript.origin.index | ||||||||||||||||||||||||||||
| Definition | Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. | ||||||||||||||||||||||||||||
| Short Display | The index of the abstract origin server starting at 1 | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | integer | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration). Different origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler). The origin indices provided elsewhere in the test script must be one of these origin indices. | ||||||||||||||||||||||||||||
| TestScript.origin.profile | |||||||||||||||||||||||||||||
| Element Id | TestScript.origin.profile | ||||||||||||||||||||||||||||
| Definition | The type of origin profile the test system supports. | ||||||||||||||||||||||||||||
| Short Display | FHIR-Client | FHIR-SDC-FormFiller | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Terminology Binding |
Test
Script
Profile
Origin
Type
(
Extensible
)
|
||||||||||||||||||||||||||||
|
Type
|
Coding | ||||||||||||||||||||||||||||
| Meaning if Missing | FHIR-Client | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | Must be a "sender"/"client" profile. | ||||||||||||||||||||||||||||
| TestScript.origin.url | |||||||||||||||||||||||||||||
| Element Id | TestScript.origin.url | ||||||||||||||||||||||||||||
| Definition | The explicit url path of the origin server used in this test script. | ||||||||||||||||||||||||||||
| Short Display | The url path of the origin server | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | url | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If provided, the test engine is not expected to prompt for or accept external input of this value. | ||||||||||||||||||||||||||||
| TestScript.destination | |||||||||||||||||||||||||||||
| Element Id | TestScript.destination | ||||||||||||||||||||||||||||
| Definition | An abstract server used in operations within this test script in the destination element. | ||||||||||||||||||||||||||||
| Short Display | An abstract server representing a destination or receiver in a message exchange | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction. | ||||||||||||||||||||||||||||
| TestScript.destination.index | |||||||||||||||||||||||||||||
| Element Id | TestScript.destination.index | ||||||||||||||||||||||||||||
| Definition | Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. | ||||||||||||||||||||||||||||
| Short Display | The index of the abstract destination server starting at 1 | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | integer | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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 Id | TestScript.destination.profile | ||||||||||||||||||||||||||||
| Definition | The type of destination profile the test system supports. | ||||||||||||||||||||||||||||
| Short Display | FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Test Script Profile Destination Type ( Extensible ) | ||||||||||||||||||||||||||||
|
Type
|
Coding | ||||||||||||||||||||||||||||
| Meaning if Missing | FHIR-Server | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | Must be a "receiver"/"server" profile. | ||||||||||||||||||||||||||||
| TestScript.destination.url | |||||||||||||||||||||||||||||
| Element Id | TestScript.destination.url | ||||||||||||||||||||||||||||
| Definition | The explicit url path of the destination server used in this test script. | ||||||||||||||||||||||||||||
| Short Display | The url path of the destination server | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | url | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If provided, the test engine is not expected to prompt for or accept external input of this value. | ||||||||||||||||||||||||||||
| TestScript.metadata | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata | ||||||||||||||||||||||||||||
| Definition | The required capability must exist and are assumed to function correctly on the FHIR server being tested. | ||||||||||||||||||||||||||||
| Short Display | Required capability that is assumed to function correctly on the FHIR server being tested | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||
| TestScript.metadata.link | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.link | ||||||||||||||||||||||||||||
| Definition |
A link to the FHIR specification that this test is covering. |
||||||||||||||||||||||||||||
| Short Display | Links to the FHIR specification | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.link.url | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.link.url | ||||||||||||||||||||||||||||
| Definition |
|
||||||||||||||||||||||||||||
| Short Display | URL to the specification | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.link.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.link.description | ||||||||||||||||||||||||||||
| Definition | Short description of the link. | ||||||||||||||||||||||||||||
| Short Display | Short description | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.capability | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability | ||||||||||||||||||||||||||||
| Definition | Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. | ||||||||||||||||||||||||||||
| Short Display | Capabilities that are assumed to function correctly on the FHIR server being tested | ||||||||||||||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.metadata.capability.required | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.required | ||||||||||||||||||||||||||||
| Definition |
|
||||||||||||||||||||||||||||
| Short Display | Are the capabilities required? | ||||||||||||||||||||||||||||
|
Cardinality
|
1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||
| TestScript.metadata.capability.validated | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.validated | ||||||||||||||||||||||||||||
| Definition |
|
||||||||||||||||||||||||||||
| Short Display | Are the capabilities validated? | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.metadata.capability.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.description | ||||||||||||||||||||||||||||
| Definition | Description of the capabilities that this test script is requiring the server to support. | ||||||||||||||||||||||||||||
| Short Display | The expected capabilities of the server | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.capability.origin | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.origin | ||||||||||||||||||||||||||||
| Definition | Which origin server these requirements apply to. | ||||||||||||||||||||||||||||
| Short Display | Which origin server these requirements apply to | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Type | integer | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.capability.destination | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.destination | ||||||||||||||||||||||||||||
| Definition | Which server these requirements apply to. | ||||||||||||||||||||||||||||
| Short Display | Which server these requirements apply to | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | integer | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.capability.link | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.link | ||||||||||||||||||||||||||||
| Definition | Links to the FHIR specification that describes this interaction and the resources involved in more detail. | ||||||||||||||||||||||||||||
| Short Display | Links to the FHIR specification | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.metadata.capability.capabilities | |||||||||||||||||||||||||||||
| Element Id | TestScript.metadata.capability.capabilities | ||||||||||||||||||||||||||||
| Definition | Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped. | ||||||||||||||||||||||||||||
| Short Display | Required Capability Statement | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | canonical ( CapabilityStatement ) | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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 Id | TestScript.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 Display | Indication of the artifact(s) that are tested by this test case | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.scope.artifact | |||||||||||||||||||||||||||||
| Element Id | TestScript.scope.artifact | ||||||||||||||||||||||||||||
| Definition | The specific conformance artifact being tested. The canonical reference can be version-specific. | ||||||||||||||||||||||||||||
| Short Display | The specific conformance artifact being tested | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | canonical ( Any ) | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.scope.conformance | |||||||||||||||||||||||||||||
| Element Id | TestScript.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 Display | required | optional | strict | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Test Script Scope Conformance Type ( Extensible ) | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Meaning if Missing | required | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.scope.phase | |||||||||||||||||||||||||||||
| Element Id | TestScript.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 Display | unit | integration | production | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Test Script Scope Phase Type ( Extensible ) | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Meaning if Missing | unit | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.fixture | |||||||||||||||||||||||||||||
| Element Id | TestScript.fixture | ||||||||||||||||||||||||||||
| Definition | Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. | ||||||||||||||||||||||||||||
| Short Display | Fixture in the test script - by reference (uri) | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.fixture.autocreate | |||||||||||||||||||||||||||||
| Element Id | TestScript.fixture.autocreate | ||||||||||||||||||||||||||||
| Definition | Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section. | ||||||||||||||||||||||||||||
| Short Display | Whether or not to implicitly create the fixture during setup | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.fixture.autodelete | |||||||||||||||||||||||||||||
| Element Id | TestScript.fixture.autodelete | ||||||||||||||||||||||||||||
| Definition | Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section. | ||||||||||||||||||||||||||||
| Short Display | Whether or not to implicitly delete the fixture during teardown | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.fixture.resource | |||||||||||||||||||||||||||||
| Element Id | TestScript.fixture.resource | ||||||||||||||||||||||||||||
| Definition |
Reference
to
the
resource
(containing
the
contents
of
the
resource
needed
for
operations).
This
| ||||||||||||||||||||||||||||
| Short Display | Reference of the resource | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | Reference ( Any ) | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | See the Resource List for complete list of resource types. | ||||||||||||||||||||||||||||
| TestScript.profile | |||||||||||||||||||||||||||||
| Element Id | TestScript.profile | ||||||||||||||||||||||||||||
| Definition | Reference to the profile to be used for validation. | ||||||||||||||||||||||||||||
| Short Display | Reference of the validation profile | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Type | canonical ( StructureDefinition ) | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | See the Resource List for complete list of resource types. | ||||||||||||||||||||||||||||
| TestScript.variable | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable | ||||||||||||||||||||||||||||
| Definition |
Variable
is
set
|
||||||||||||||||||||||||||||
| Short Display | Placeholder for evaluated elements | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
Variables
would
be
set
based
either
on
|
||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.variable.name | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.name | ||||||||||||||||||||||||||||
| Definition |
| ||||||||||||||||||||||||||||
| Short Display | Descriptive name for this variable | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed. | ||||||||||||||||||||||||||||
| TestScript.variable.defaultValue | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.defaultValue | ||||||||||||||||||||||||||||
| Definition | A default, hard-coded, or user-defined value for this variable. | ||||||||||||||||||||||||||||
| Short Display | Default, hard-coded, or user-defined value for this variable | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values. | ||||||||||||||||||||||||||||
| TestScript.variable.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.description | ||||||||||||||||||||||||||||
| Definition | A free text natural language description of the variable and its purpose. | ||||||||||||||||||||||||||||
| Short Display | Natural language description of the variable | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.variable.expression | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.expression | ||||||||||||||||||||||||||||
| Definition | The FHIRPath 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. | ||||||||||||||||||||||||||||
| Short Display | The FHIRPath expression against the fixture body | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.variable.headerField | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.headerField | ||||||||||||||||||||||||||||
| Definition |
Will
be
used
to
grab
the
HTTP
header
field
value
from
|
||||||||||||||||||||||||||||
| Short Display | HTTP header field name for source | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.variable.hint | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.hint | ||||||||||||||||||||||||||||
| Definition | Displayable text string with hint help information to the user when entering a default value. | ||||||||||||||||||||||||||||
| Short Display | Hint help text for default value to enter | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.variable.path | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.path | ||||||||||||||||||||||||||||
| Definition | XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. | ||||||||||||||||||||||||||||
| Short Display | XPath or JSONPath against the fixture body | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.variable.sourceId | |||||||||||||||||||||||||||||
| Element Id | TestScript.variable.sourceId | ||||||||||||||||||||||||||||
| Definition |
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. | ||||||||||||||||||||||||||||
| Short Display | Fixture Id of source expression or headerField within this variable | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
This
can
be
a
statically
defined
fixture
(at
the
top
of
the
TestScript)
or
a
dynamically
set
fixture
created
by
responseId
of
the
| ||||||||||||||||||||||||||||
| TestScript.setup | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup | ||||||||||||||||||||||||||||
| Definition |
A series of required setup operations before tests are executed. | ||||||||||||||||||||||||||||
| Short Display | A series of required setup operations before tests are executed | ||||||||||||||||||||||||||||
|
Cardinality
|
0..1 | ||||||||||||||||||||||||||||
| Summary |
| ||||||||||||||||||||||||||||
| TestScript.setup.action | |||||||||||||||||||||||||||||
|
| TestScript.setup.action | ||||||||||||||||||||||||||||
| Definition |
Action would contain either an operation or an assertion. | ||||||||||||||||||||||||||||
| Short Display | A setup operation or assert to perform | ||||||||||||||||||||||||||||
|
Cardinality
|
1..* | ||||||||||||||||||||||||||||
| Summary |
|
||||||||||||||||||||||||||||
|
| An action should contain either an operation or an assertion but not both. It can contain any number of variables. |
||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation | |||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
| Definition | The operation to perform. | ||||||||||||||||||||||||||||
| Short Display | The setup operation to perform | ||||||||||||||||||||||||||||
|
Cardinality
|
0..1 | ||||||||||||||||||||||||||||
| Summary |
|
||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
| TestScript.setup.action.operation.type | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.type | ||||||||||||||||||||||||||||
| Definition |
|
||||||||||||||||||||||||||||
| Short Display | The operation code type that will be executed | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Test Script Operation Code ( Extensible ) | ||||||||||||||||||||||||||||
| Type | Coding | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
See
the
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.resource | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.resource | ||||||||||||||||||||||||||||
| Definition |
The
type
of
|
||||||||||||||||||||||||||||
| Short Display | Resource type | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Concrete FHIR Types ( Extensible ) | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.label | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.label | ||||||||||||||||||||||||||||
| Definition | The label would be used for tracking/logging purposes by test engines. | ||||||||||||||||||||||||||||
| Short Display | Tracking/logging operation label | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | This has no impact on the verification itself. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.description | ||||||||||||||||||||||||||||
| Definition | The description would be used by test engines for tracking and reporting purposes. | ||||||||||||||||||||||||||||
| Short Display | Tracking/reporting operation description | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | This has no impact on the verification itself. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.accept | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.accept | ||||||||||||||||||||||||||||
| Definition | The mime-type to use for RESTful operation in the 'Accept' header. | ||||||||||||||||||||||||||||
| Short Display | Mime type to accept in the payload of the response, with charset etc | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Mime Types ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
If
this
|
||||||||||||||||||||||||||||
| TestScript.setup.action.operation.contentType | |||||||||||||||||||||||||||||
|
|
| ||||||||||||||||||||||||||||
| Definition | The mime-type to use for RESTful operation in the 'Content-Type' header. | ||||||||||||||||||||||||||||
| Short Display | Mime type of the request payload contents, with charset etc | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Mime Types ( Required ) | ||||||||||||||||||||||||||||
| Type |
code
|
||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.destination | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.destination | ||||||||||||||||||||||||||||
| Definition | The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. | ||||||||||||||||||||||||||||
| Short Display | Server responding to the request | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | integer | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.encodeRequestUrl | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.encodeRequestUrl | ||||||||||||||||||||||||||||
| Definition | Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths. | ||||||||||||||||||||||||||||
| Short Display | Whether or not to send the request url in encoded format | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.method | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.method | ||||||||||||||||||||||||||||
| Definition | The HTTP method the test engine MUST use for this operation regardless of any other operation details. | ||||||||||||||||||||||||||||
| Short Display | delete | get | options | patch | post | put | head | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Test Script Request Method Code ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
The
primary
purpose
of
the
explicit
HTTP
method
is
support
of
HTTP
POST
method
invocation
of
the
FHIR
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.origin | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.origin | ||||||||||||||||||||||||||||
| Definition | The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. | ||||||||||||||||||||||||||||
| Short Display | Server initiating the request | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | integer | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.params | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.params | ||||||||||||||||||||||||||||
| Definition | Path plus parameters after [type]. Used to set parts of the request URL explicitly. | ||||||||||||||||||||||||||||
| Short Display | Explicitly defined path parameters | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.requestHeader | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.requestHeader | ||||||||||||||||||||||||||||
| Definition | Header elements would be used to set HTTP headers. | ||||||||||||||||||||||||||||
| Short Display | Each operation can have one or more header elements | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
This
gives
control
to
test-script
writers
to
set
headers
explicitly
based
on
test
requirements.
It
will
allow
for
testing
using:
-
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.requestHeader.field | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.requestHeader.field | ||||||||||||||||||||||||||||
| Definition | The HTTP header field e.g. "Accept". | ||||||||||||||||||||||||||||
| Short Display | HTTP header field name | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
If
header
element
is
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.requestHeader.value | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.requestHeader.value | ||||||||||||||||||||||||||||
| Definition | The value of the header e.g. "application/fhir+xml". | ||||||||||||||||||||||||||||
| Short Display | HTTP headerfield value | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.requestId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.requestId | ||||||||||||||||||||||||||||
| Definition | The fixture id (maybe new) to map to the request. | ||||||||||||||||||||||||||||
| Short Display | Fixture Id of mapped request | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
If
a
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.responseId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.responseId | ||||||||||||||||||||||||||||
| Definition | The fixture id (maybe new) to map to the response. | ||||||||||||||||||||||||||||
| Short Display | Fixture Id of mapped response | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "responseId". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified. | ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.sourceId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.sourceId | ||||||||||||||||||||||||||||
| Definition | The id of the fixture used as the body of a PUT or POST request. | ||||||||||||||||||||||||||||
| Short Display | Fixture Id of body for PUT and POST requests | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.targetId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.targetId | ||||||||||||||||||||||||||||
| Definition | Id of fixture used for extracting the [id], [type], and [vid] for GET requests. | ||||||||||||||||||||||||||||
| Short Display | Id of fixture used for extracting the [id], [type], and [vid] for GET requests | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.operation.url | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.operation.url | ||||||||||||||||||||||||||||
| Definition | Complete request URL. | ||||||||||||||||||||||||||||
| Short Display | Request URL | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert | ||||||||||||||||||||||||||||
| Definition | Evaluates the results of previous operations to determine if the server under test behaves appropriately. | ||||||||||||||||||||||||||||
| Short Display | The assertion to perform | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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 |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.label | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.label | ||||||||||||||||||||||||||||
| Definition |
The
label
would
be
used
for
|
||||||||||||||||||||||||||||
|
| Tracking/logging assertion label | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | This has no impact on the verification itself. | ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.description | ||||||||||||||||||||||||||||
| Definition | The description would be used by test engines for tracking and reporting purposes. | ||||||||||||||||||||||||||||
| Short Display | Tracking/reporting assertion description | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | This has no impact on the verification itself. | ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.direction | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.direction | ||||||||||||||||||||||||||||
| Definition | The direction to use for the assertion. | ||||||||||||||||||||||||||||
| Short Display | response | request | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Assertion Direction Type ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.compareToSourceId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.compareToSourceId | ||||||||||||||||||||||||||||
| Definition | Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition. | ||||||||||||||||||||||||||||
| Short Display |
Id
of
the
| ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.compareToSourceExpression | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.compareToSourceExpression | ||||||||||||||||||||||||||||
| Definition | The FHIRPath 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. | ||||||||||||||||||||||||||||
| Short Display | The FHIRPath expression to evaluate against the source fixture | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.compareToSourcePath | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.compareToSourcePath | ||||||||||||||||||||||||||||
| Definition | XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. | ||||||||||||||||||||||||||||
| Short Display | XPath or JSONPath expression to evaluate against the source fixture | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.contentType | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.contentType | ||||||||||||||||||||||||||||
| Definition | The mime-type contents to compare against the request or response message 'Content-Type' header. | ||||||||||||||||||||||||||||
| Short Display | Mime type to compare against the 'Content-Type' header | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Mime Types ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.defaultManualCompletion | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.defaultManualCompletion | ||||||||||||||||||||||||||||
| Definition | The default manual completion outcome applied to this assertion. | ||||||||||||||||||||||||||||
| Short Display | fail | pass | skip | stop | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Assertion Manual Completion Type ( Required ) | ||||||||||||||||||||||||||||
| Type |
code
|
||||||||||||||||||||||||||||
| Meaning if Missing | If defaultManualCompletion is not specified, then the default manual completion outcome will be 'skip'. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | 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. | ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.expression | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.expression | ||||||||||||||||||||||||||||
| Definition | The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. | ||||||||||||||||||||||||||||
| Short Display | The FHIRPath expression to be evaluated | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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.
The
FHIRPath
expression
can
be
evaluated
as
either
a
path
to
a
specific
value
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.headerField | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.headerField | ||||||||||||||||||||||||||||
| Definition | The HTTP header field name e.g. 'Location'. | ||||||||||||||||||||||||||||
| Short Display | HTTP header field name | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.minimumId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.minimumId | ||||||||||||||||||||||||||||
| Definition | The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. | ||||||||||||||||||||||||||||
| Short Display | Fixture Id of minimum content resource | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
Asserts
that
the
response
contains
all
the
element/content
in
See Testing FHIR Use minimumId for a more complete description of the test engine's comparison logic. |
||||||||||||||||||||||||||||
|
|
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.navigationLinks | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.navigationLinks | ||||||||||||||||||||||||||||
| Definition | Whether or not the test execution performs validation on the bundle navigation links. | ||||||||||||||||||||||||||||
| Short Display | Perform validation on navigation links? | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | Asserts that the Bundle contains first, last, and next links. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.operator | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.operator | ||||||||||||||||||||||||||||
| Definition | The operator type defines the conditional behavior of the assert. | ||||||||||||||||||||||||||||
| Short Display | equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Assertion Operator Type ( Required ) | ||||||||||||||||||||||||||||
| Type |
code
|
||||||||||||||||||||||||||||
| Meaning if Missing |
If
operator
is
not
specified,
then
the
default
conditional
behavior
is
implemented
as
defined
in
the
| ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | 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 . | ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.path | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.path | ||||||||||||||||||||||||||||
| Definition |
The
XPath
or
JSONPath
expression
to
be
evaluated
against
the
| ||||||||||||||||||||||||||||
| Short Display | XPath or JSONPath expression | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.requestMethod | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.requestMethod | ||||||||||||||||||||||||||||
| Definition | The request method or HTTP operation code to compare against that used by the client system under test. | ||||||||||||||||||||||||||||
| Short Display | delete | get | options | patch | post | put | head | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Test Script Request Method Code ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
If
"requestMethod"
is
specified
then
it
will
be
used
in
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.requestURL | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.requestURL | ||||||||||||||||||||||||||||
| Definition | The value to use in a comparison against the request URL path string. | ||||||||||||||||||||||||||||
| Short Display | Request URL comparison value | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | If "requestURL" is specified then it will be used in place of "value". The "requestURL" will evaluate against the last operation's full request URL path string. | ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.resource | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.resource | ||||||||||||||||||||||||||||
| Definition | The type of the resource. See the resource list . | ||||||||||||||||||||||||||||
| Short Display | Resource type | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Concrete FHIR Types ( Extensible ) | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | This will be expected resource type in response body e.g. in read, vread, search, etc. See the Resource List for complete list of resource types; e.g. <assert > <resourceType value="Patient" </assert>. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.response | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.response | ||||||||||||||||||||||||||||
| Definition | 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. | ||||||||||||||||||||||||||||
| Short Display | 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 | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Terminology Binding | Assertion Response Types ( Required ) | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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>. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.responseCode | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.responseCode | ||||||||||||||||||||||||||||
| Definition | The value of the HTTP response code to be tested. | ||||||||||||||||||||||||||||
| Short Display | HTTP response code to test | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
To
be
used
with
"operator"
attribute
value.
Asserts
that
the
response
code
equals
this
value
if
"operator"
is
not
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.sourceId | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.sourceId | ||||||||||||||||||||||||||||
| Definition | Fixture to evaluate the XPath/JSONPath expression or the headerField against. | ||||||||||||||||||||||||||||
| Short Display | Fixture Id of source expression or headerField | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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 Id | TestScript.setup.action.assert.stopTestOnFail | ||||||||||||||||||||||||||||
| Definition | Whether or not the current test execution will stop on failure for this assert. | ||||||||||||||||||||||||||||
| Short Display | If this assert fails, will the current test execution stop? | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| 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 Id | TestScript.setup.action.assert.validateProfileId | ||||||||||||||||||||||||||||
| Definition |
The
| ||||||||||||||||||||||||||||
| Short Display | Profile Id of validation profile reference | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | id | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId. | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.value | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.value | ||||||||||||||||||||||||||||
| Definition | The value to compare to. | ||||||||||||||||||||||||||||
| Short Display | The value to compare to | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
The
string-representation
of
a
| ||||||||||||||||||||||||||||
|
| |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.warningOnly | ||||||||||||||||||||||||||||
| Definition | Whether or not the test execution will produce a warning only on error for this assert. | ||||||||||||||||||||||||||||
| Short Display | Will this assert produce a warning only on error? | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
If
| ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.requirement | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.requirement | ||||||||||||||||||||||||||||
| Definition |
Links
or
references
providing
traceability
to
the
| ||||||||||||||||||||||||||||
| Short Display | Links or references to the testing requirements | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | 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. | ||||||||||||||||||||||||||||
| TestScript.setup.action.assert.requirement.link[x] | |||||||||||||||||||||||||||||
| Element Id | TestScript.setup.action.assert.requirement.link[x] | ||||||||||||||||||||||||||||
| Definition |
Link or reference providing traceability to the testing requirement for this test. | ||||||||||||||||||||||||||||
| Short Display | Link or reference to the testing requirement | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | uri | canonical ( Requirements ) | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.test | |||||||||||||||||||||||||||||
| Element Id | TestScript.test | ||||||||||||||||||||||||||||
| Definition | A test in this script. | ||||||||||||||||||||||||||||
| Short Display | A test in this script | ||||||||||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.test.name | |||||||||||||||||||||||||||||
| Element Id | TestScript.test.name | ||||||||||||||||||||||||||||
| Definition | The name of this test used for tracking/logging purposes by test engines. | ||||||||||||||||||||||||||||
| Short Display | Tracking/logging name of this test | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.test.description | |||||||||||||||||||||||||||||
| Element Id | TestScript.test.description | ||||||||||||||||||||||||||||
| Definition | A short description of the test used by test engines for tracking and reporting purposes. | ||||||||||||||||||||||||||||
| Short Display | Tracking/reporting short description of the test | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | string | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.test.action | |||||||||||||||||||||||||||||
| Element Id | TestScript.test.action | ||||||||||||||||||||||||||||
| Definition | Action would contain either an operation or an assertion. | ||||||||||||||||||||||||||||
| Short Display | A test operation or assert to perform | ||||||||||||||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
An
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.test.action.operation | |||||||||||||||||||||||||||||
| Element Id | TestScript.test.action.operation | ||||||||||||||||||||||||||||
| Definition | An operation would involve a REST request to a server. | ||||||||||||||||||||||||||||
| Short Display | The setup operation to perform | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | See TestScript.setup.action.operation | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.test.action.assert | |||||||||||||||||||||||||||||
| Element Id | TestScript.test.action.assert | ||||||||||||||||||||||||||||
| Definition |
Evaluates
the
| ||||||||||||||||||||||||||||
| Short Display | The setup assertion to perform | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Type | See TestScript.setup.action.assert | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments |
In
order
to
| ||||||||||||||||||||||||||||
| Invariants |
| ||||||||||||||||||||||||||||
| TestScript.teardown | |||||||||||||||||||||||||||||
| Element Id | TestScript.teardown | ||||||||||||||||||||||||||||
| Definition | A series of operations required to clean up after all the tests are executed (successfully or otherwise). | ||||||||||||||||||||||||||||
| Short Display | A series of required clean up steps | ||||||||||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| TestScript.teardown.action | |||||||||||||||||||||||||||||
| Element Id | TestScript.teardown.action | ||||||||||||||||||||||||||||
| Definition | The teardown action will only contain an operation. | ||||||||||||||||||||||||||||
| Short Display | One or more teardown operations to perform | ||||||||||||||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Comments | An action should contain either an operation or an assertion but not both. It can contain any number of variables. | ||||||||||||||||||||||||||||
| TestScript.teardown.action.operation | |||||||||||||||||||||||||||||
| Element Id | TestScript.teardown.action.operation | ||||||||||||||||||||||||||||
| Definition | An operation would involve a REST request to a server. | ||||||||||||||||||||||||||||
| Short Display | The teardown operation to perform | ||||||||||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||||||||||
| Type | See TestScript.setup.action.operation | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants |
|
||||||||||||||||||||||||||||