This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
(v5.0.0-ballot:
R5
Ballot
-
see
ballot
notes
3).
).
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:
R4B
R4
R3
Work
Group
|
Maturity
Level
:
|
|
Use Context : Any |
The
canonical
URL
for
this
extension:
profile
is:
http://hl7.org/fhir/StructureDefinition/shareabletestscript
Status:
draft.
Extension
maintained
by:
Health
Level
Seven,
Inc.
-
Security
WG
True
or
False
indicating
whether
all
patient
identifying
Enforces
the
minimum
information
was
removed
from
set
for
the
data.
test
script
metadata
required
by
HL7
and
other
organizations
that
share
and
publish
test
scripts
Context
of
Use:
Use
This
profile
was
published
on
element:
AuditEvent.entity
usage
info:
insert
Thu,
Jan
1,
1970
00:00+1000
as
a
list
of
places
where
this
extension
is
used
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This indicates the differences between this profile and the base TestScript structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
| TestScript | Describes a set of tests | |
![]() ![]() | 1..1 | uri | Canonical identifier for this test script, represented as a URI (globally unique) | |
![]() ![]() | 1..1 | string | Business version of the test script | |
![]() ![]() | 1..1 | boolean | For testing purposes, not real usage | |
![]() ![]() |
|
1..1 | string |
Name
of
the
publisher/steward
(organization
or
|
![]() ![]() | 1..1 | markdown |
Natural
language
description
of
the
|
|
Documentation
for
this
format
|
||||
Full
Structure
This
provides
the
consolidated
view
(aka
snapshot)
of
the
profile
after
applying
the
changes
in
this
profile
to
the
base
TestScript
structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
![]() | 1..1 | TestScript |
Describes
a
set
of
tests
| ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ): IETF language tag
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource |
Contained,
inline
Resources
| |||||
![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() |
| 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ
C
![]() | 1..1 | uri | Canonical identifier for this test script, represented as a URI (globally unique) | ||||
![]() ![]() | Σ | 0..* | Identifier |
Additional
identifier
for
the
test
script
| ||||
![]() ![]() | Σ | 1..1 | string | Business version of the test script | ||||
![]() ![]() | Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) | |||||
![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | Coding | |||||||
![]() ![]() |
Σ
C
![]() | 1..1 | string | Name for this test script (computer friendly) | ||||
![]() ![]() | Σ | 0..1 | string | Name for this test script (human friendly) | ||||
![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. | ||||
![]() ![]() | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() | Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() | Σ | 1..1 | string |
Name
of
the
publisher/steward
(organization
or
| ||||
![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
|
||||
| 1..1 | markdown | Natural language description of the test script | |||||
![]() ![]() | Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
| ||||
![]() ![]() | Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
test
script
(if
applicable)
Binding: Jurisdiction ( extensible ): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() | 0..1 | markdown | Why this test script is defined | |||||
![]() ![]() | 0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() | 0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() | 0..* | BackboneElement |
An
abstract
server
representing
a
client
or
sender
in
a
message
exchange
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | integer | The index of the abstract origin server starting at 1 | |||||
![]() ![]() ![]() | 1..1 | Coding |
FHIR-Client
|
FHIR-SDC-FormFiller
Binding: TestScriptProfileOriginType ( extensible ): The type of origin profile the test system supports. | |||||
![]() ![]() | 0..* | BackboneElement |
An
abstract
server
representing
a
destination
or
receiver
in
a
message
exchange
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | integer | The index of the abstract destination server starting at 1 | |||||
![]() ![]() ![]() | 1..1 | Coding |
FHIR-Server
|
FHIR-SDC-FormManager
|
FHIR-SDC-FormReceiver
|
FHIR-SDC-FormProcessor
Binding: TestScriptProfileDestinationType ( extensible ): The type of destination profile the test system supports. | |||||
![]() ![]() |
C
![]() | 0..1 | BackboneElement |
Required
capability
that
is
assumed
to
function
correctly
on
|
||||
| 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 0..* | BackboneElement |
Links
to
the
FHIR
specification
| |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
|
1..1 | uri | URL to the specification | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Short description | |||||
![]() ![]() ![]() | 1..* | BackboneElement |
Capabilities
that
are
assumed
to
function
correctly
on
the
FHIR
server
being
tested
| |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() | 1..1 | boolean | Are the capabilities required? | |||||
![]() ![]() ![]() ![]() | 1..1 | boolean | Are the capabilities validated? | |||||
![]() ![]() ![]() ![]() | 0..1 | string | The expected capabilities of the server | |||||
![]() ![]() ![]() ![]() | 0..* | integer |
Which
origin
server
these
requirements
apply
to
| |||||
![]() ![]() ![]() ![]() | 0..1 | integer | Which server these requirements apply to | |||||
![]() ![]() ![]() ![]() | 0..* | uri |
Links
to
the
FHIR
specification
| |||||
![]() ![]() ![]() ![]() | 1..1 | canonical ( CapabilityStatement ) | Required Capability Statement | |||||
![]() ![]() | 0..* | BackboneElement |
Indication
of
the
artifact(s)
that
are
tested
by
this
test
case
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | canonical ( Resource ) | The specific conformance artifact being tested | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept |
required
|
optional
|
strict
Binding: TestScriptScopeConformanceType ( extensible ): The expectation of whether the test must pass for the system to be considered conformant with the artifact. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept |
unit
|
integration
|
production
Binding: TestScriptScopePhaseType ( extensible ): The phase of testing for this artifact. | |||||
![]() ![]() | 0..* | BackboneElement |
Fixture
in
the
test
script
-
by
reference
(uri)
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | boolean | Whether or not to implicitly create the fixture during setup | |||||
![]() ![]() ![]() | 1..1 | boolean | Whether or not to implicitly delete the fixture during teardown | |||||
![]() ![]() ![]() | 0..1 | Reference ( Resource ) | Reference of the resource | |||||
![]() ![]() | 0..* | Reference ( Resource ) |
Reference
of
the
validation
profile
| |||||
![]() ![]() |
C
![]() | 0..* | BackboneElement |
Placeholder
for
evaluated
elements
| ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | string | Descriptive name for this variable | |||||
![]() ![]() ![]() | 0..1 | string | Default, hard-coded, or user-defined value for this variable | |||||
![]() ![]() ![]() | 0..1 | string | Natural language description of the variable | |||||
![]() ![]() ![]() | 0..1 | string | The FHIRPath expression against the fixture body | |||||
![]() ![]() ![]() | 0..1 | string | HTTP header field name for source | |||||
![]() ![]() ![]() | 0..1 | string | Hint help text for default value to enter | |||||
![]() ![]() ![]() | 0..1 | string | XPath or JSONPath against the fixture body | |||||
![]() ![]() ![]() | 0..1 | id | Fixture Id of source expression or headerField within this variable | |||||
![]() ![]() | 0..1 | BackboneElement | A series of required setup operations before tests are executed | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() |
C
![]() | 1..* | BackboneElement |
A
setup
operation
or
assert
to
perform
| ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | BackboneElement | The setup operation to perform | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Coding |
The
operation
code
type
that
will
be
executed
Binding: TestScriptOperationCode ( extensible ): FHIR Operation Code Types | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri |
Resource
type
Binding: Concrete FHIR Types ( extensible ): A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/logging operation label | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/reporting operation description | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
Mime
type
to
accept
in
the
payload
of
the
response,
with
charset
etc.
Binding: MimeType ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: |
|||||
| 0..1 | code |
Mime
type
of
the
request
payload
contents,
with
charset
etc.
Binding: MimeType ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: application/fhir+xml | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | integer | Server responding to the request | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | Whether or not to send the request url in encoded format | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
delete
|
get
|
options
|
patch
|
post
|
put
|
head
Binding: TestScriptRequestMethodCode ( required ): The allowable request method or HTTP operation codes. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | integer | Server initiating the request | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Explicitly defined path parameters | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | BackboneElement |
Each
operation
can
have
one
or
more
header
elements
| |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | HTTP header field name | |||||
![]() ![]() ![]() ![]()
|
1..1 | string | HTTP headerfield value | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of mapped request | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of mapped response | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of body for PUT and POST requests | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Id of fixture used for extracting the [id], [type], and [vid] for GET requests | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Request URL | |||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | BackboneElement | The assertion to perform | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/logging assertion label | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/reporting assertion description | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
response
|
request
Binding: AssertionDirectionType ( required ): The direction to use for assertions. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Id of the source fixture to be evaluated | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The FHIRPath expression to evaluate against the source fixture | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | XPath or JSONPath expression to evaluate against the source fixture | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
Mime
type
to
compare
against
the
'Content-Type'
header
Binding: MimeType ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: application/fhir+xml | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The FHIRPath expression to be evaluated | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | HTTP header field name | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixture Id of minimum content resource | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean |
| |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
equals
|
notEquals
|
in
|
notIn
|
greaterThan
|
lessThan
|
empty
|
notEmpty
|
contains
|
notContains
|
eval
Binding: AssertionOperatorType ( required ): The type of operator to use for assertions. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | XPath or JSONPath expression | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
delete
|
get
|
options
|
patch
|
post
|
put
|
head
Binding: TestScriptRequestMethodCode ( required ): The allowable request method or HTTP operation codes. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Request URL comparison value | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri |
Resource
type
Binding: Concrete FHIR Types ( extensible ): A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
okay
|
created
|
noContent
|
notModified
|
bad
|
forbidden
|
notFound
|
methodNotAllowed
|
conflict
|
gone
|
preconditionFailed
|
unprocessable
Binding: AssertionResponseTypes ( required ): The response code to expect in the response. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | HTTP response code to test | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of source expression or headerField | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | If this assert fails, will the current test execution stop? | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Profile Id of validation profile reference | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value to compare to | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | Will this assert produce a warning only on error? | |||||
![]() ![]() | 0..* | BackboneElement |
A
test
in
this
script
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 0..1 | string | Tracking/logging name of this test | |||||
![]() ![]() ![]() | 0..1 | string | Tracking/reporting short description of the test | |||||
![]() ![]() ![]() |
C
![]() | 1..* | BackboneElement |
A
test
operation
or
assert
to
perform
| ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | See operation (TestScript) | The setup operation to perform | ||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | See assert (TestScript) | The setup assertion to perform | ||||
![]() ![]() | 0..1 | BackboneElement | A series of required clean up steps | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..* | BackboneElement |
One
or
more
teardown
operations
to
perform
| |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() |
C
![]() | 1..1 | See operation (TestScript) | The teardown operation to perform | ||||
Documentation
for
this
format
|
||||||||
<!-- Shareable TestScript -->![]()
< xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension><TestScript xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this test script, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the test script --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the test script --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 1..1 Name for this test script (computer friendly) --> <title value="[string]"/><!-- I 0..1 Name for this test script (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 1..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the test script --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for test script (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this test script is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <origin> I 0..* BackboneElement <!-- I 0..* An abstract server representing a client or sender in a message exchange --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <index value="[integer]"/><!-- I 1..1 The index of the abstract origin server starting at 1 --> <profile><!-- I 1..1 Coding FHIR-Client | FHIR-SDC-FormFiller --></profile> </origin> <destination> I 0..* BackboneElement <!-- I 0..* An abstract server representing a destination or receiver in a message exchange --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <index value="[integer]"/><!-- I 1..1 The index of the abstract destination server starting at 1 --> <profile><!-- I 1..1 Coding FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor --></profile> </destination> <metadata> I 0..1 BackboneElement <!-- I 0..1 Required capability that is assumed to function correctly on the FHIR server being tested --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <link> I 0..* BackboneElement <!-- I 0..* Links to the FHIR specification --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <url value="[uri]"/><!-- I 1..1 URL to the specification --> <description value="[string]"/><!-- I 0..1 Short description --> </link> <capability> I 1..* BackboneElement <!-- I 1..* Capabilities that are assumed to function correctly on the FHIR server being tested --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <required value="[boolean]"/><!-- I 1..1 Are the capabilities required? --> <validated value="[boolean]"/><!-- I 1..1 Are the capabilities validated? --> <description value="[string]"/><!-- I 0..1 The expected capabilities of the server --> <origin value="[integer]"/><!-- I 0..* Which origin server these requirements apply to --> <destination value="[integer]"/><!-- I 0..1 Which server these requirements apply to --> <link value="[uri]"/><!-- I 0..* Links to the FHIR specification --> <capabilities value="[canonical]"/><!-- I 1..1 Required Capability Statement --> </capability> </metadata> <scope> I 0..* BackboneElement <!-- I 0..* Indication of the artifact(s) that are tested by this test case --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <artifact value="[canonical]"/><!-- I 1..1 The specific conformance artifact being tested --> <conformance><!-- I 0..1 CodeableConcept required | optional | strict --></conformance> <phase><!-- I 0..1 CodeableConcept unit | integration | production --></phase> </scope> <fixture> I 0..* BackboneElement <!-- I 0..* Fixture in the test script - by reference (uri) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <autocreate value="[boolean]"/><!-- I 1..1 Whether or not to implicitly create the fixture during setup --> <autodelete value="[boolean]"/><!-- I 1..1 Whether or not to implicitly delete the fixture during teardown --> <resource><!-- I 0..1 Reference(Resource) Reference of the resource --></resource> </fixture> <profile><!-- I 0..* Reference(Resource) Reference of the validation profile --></profile> <variable> I 0..* BackboneElement <!-- I 0..* Placeholder for evaluated elements --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Descriptive name for this variable --> <defaultValue value="[string]"/><!-- I 0..1 Default, hard-coded, or user-defined value for this variable --> <description value="[string]"/><!-- I 0..1 Natural language description of the variable --> <expression value="[string]"/><!-- I 0..1 The FHIRPath expression against the fixture body --> <headerField value="[string]"/><!-- I 0..1 HTTP header field name for source --> <hint value="[string]"/><!-- I 0..1 Hint help text for default value to enter --> <path value="[string]"/><!-- I 0..1 XPath or JSONPath against the fixture body --> <sourceId value="[id]"/><!-- I 0..1 Fixture Id of source expression or headerField within this variable --> </variable> <setup> I 0..1 BackboneElement <!-- I 0..1 A series of required setup operations before tests are executed --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <action> I 1..* BackboneElement <!-- I 1..* A setup operation or assert to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <operation> I 0..1 BackboneElement <!-- I 0..1 The setup operation to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type><!-- I 0..1 Coding The operation code type that will be executed --></type> <resource value="[uri]"/><!-- I 0..1 Resource type --> <label value="[string]"/><!-- I 0..1 Tracking/logging operation label --> <description value="[string]"/><!-- I 0..1 Tracking/reporting operation description --> <accept value="[code]"/><!-- I 0..1 Mime type to accept in the payload of the response, with charset etc. --> <contentType value="[code]"/><!-- I 0..1 Mime type of the request payload contents, with charset etc. --> <destination value="[integer]"/><!-- I 0..1 Server responding to the request --> <encodeRequestUrl value="[boolean]"/><!-- I 1..1 Whether or not to send the request url in encoded format --> <method value="[code]"/><!-- I 0..1 delete | get | options | patch | post | put | head --> <origin value="[integer]"/><!-- I 0..1 Server initiating the request --> <params value="[string]"/><!-- I 0..1 Explicitly defined path parameters --> <requestHeader> I 0..* BackboneElement <!-- I 0..* Each operation can have one or more header elements --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <field value="[string]"/><!-- I 1..1 HTTP header field name --> <value value="[string]"/><!-- I 1..1 HTTP headerfield value --> </requestHeader> <requestId value="[id]"/><!-- I 0..1 Fixture Id of mapped request --> <responseId value="[id]"/><!-- I 0..1 Fixture Id of mapped response --> <sourceId value="[id]"/><!-- I 0..1 Fixture Id of body for PUT and POST requests --> <targetId value="[id]"/><!-- I 0..1 Id of fixture used for extracting the [id], [type], and [vid] for GET requests --> <url value="[string]"/><!-- I 0..1 Request URL --> </operation> <assert> I 0..1 BackboneElement <!-- I 0..1 The assertion to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <label value="[string]"/><!-- I 0..1 Tracking/logging assertion label --> <description value="[string]"/><!-- I 0..1 Tracking/reporting assertion description --> <direction value="[code]"/><!-- I 0..1 response | request --> <compareToSourceId value="[string]"/><!-- I 0..1 Id of the source fixture to be evaluated --> <compareToSourceExpression value="[string]"/><!-- I 0..1 The FHIRPath expression to evaluate against the source fixture --> <compareToSourcePath value="[string]"/><!-- I 0..1 XPath or JSONPath expression to evaluate against the source fixture --> <contentType value="[code]"/><!-- I 0..1 Mime type to compare against the 'Content-Type' header --> <expression value="[string]"/><!-- I 0..1 The FHIRPath expression to be evaluated --> <headerField value="[string]"/><!-- I 0..1 HTTP header field name --> <minimumId value="[string]"/><!-- I 0..1 Fixture Id of minimum content resource --> <navigationLinks value="[boolean]"/><!-- I 0..1 Perform validation on navigation links? --> <operator value="[code]"/><!-- I 0..1 equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval --> <path value="[string]"/><!-- I 0..1 XPath or JSONPath expression --> <requestMethod value="[code]"/><!-- I 0..1 delete | get | options | patch | post | put | head --> <requestURL value="[string]"/><!-- I 0..1 Request URL comparison value --> <resource value="[uri]"/><!-- I 0..1 Resource type --> <response value="[code]"/><!-- I 0..1 okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable --> <responseCode value="[string]"/><!-- I 0..1 HTTP response code to test --> <sourceId value="[id]"/><!-- I 0..1 Fixture Id of source expression or headerField --> <stopTestOnFail value="[boolean]"/><!-- I 1..1 If this assert fails, will the current test execution stop? --> <validateProfileId value="[id]"/><!-- I 0..1 Profile Id of validation profile reference --> <value value="[string]"/><!-- I 0..1 The value to compare to --> <warningOnly value="[boolean]"/><!-- I 1..1 Will this assert produce a warning only on error? --> </assert> </action> </setup> <test> I 0..* BackboneElement <!-- I 0..* A test in this script --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 0..1 Tracking/logging name of this test --> <description value="[string]"/><!-- I 0..1 Tracking/reporting short description of the test --> <action> I 1..* BackboneElement <!-- I 1..* A test operation or assert to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <operation><!-- See http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation The setup operation to perform --></operation> <assert><!-- See http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.assert The setup assertion to perform --></assert> </action> </test> <teardown> I 0..1 BackboneElement <!-- I 0..1 A series of required clean up steps --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <action> I 1..* BackboneElement <!-- I 1..* One or more teardown operations to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <operation><!-- See http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation The teardown operation to perform --></operation> </action> </teardown> </TestScript>
{ // Shareable TestScript
// from Element: extension
"
],
"
"
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this test script, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the test script
"version" : "<string>", // I R! Business version of the test script
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // I R! Name for this test script (computer friendly)
"title" : "<string>", // IName for this test script (human friendly)
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
"date" : "<dateTime>", // IDate last changed
"publisher" : "<string>", // I R! Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the test script
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for test script (if applicable)
"purpose" : "<markdown>", // IWhy this test script is defined
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"origin" : [{ BackboneElement }], // IAn abstract server representing a client or sender in a message exchange
"destination" : [{ BackboneElement }], // IAn abstract server representing a destination or receiver in a message exchange
"metadata" : { BackboneElement }, // IRequired capability that is assumed to function correctly on the FHIR server being tested
"scope" : [{ BackboneElement }], // IIndication of the artifact(s) that are tested by this test case
"fixture" : [{ BackboneElement }], // IFixture in the test script - by reference (uri)
"profile" : [{ Reference(Resource) }], // IReference of the validation profile
"variable" : [{ BackboneElement }], // IPlaceholder for evaluated elements
"setup" : { BackboneElement }, // IA series of required setup operations before tests are executed
"test" : [{ BackboneElement }], // IA test in this script
"teardown" : { BackboneElement } // IA series of required clean up steps
}
This structure is derived from TestScript .
Differential View
This indicates the differences between this profile and the base TestScript structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
| TestScript | Describes a set of tests | |
![]() ![]() | 1..1 | uri | Canonical identifier for this test script, represented as a URI (globally unique) | |
![]() ![]() |
1..1 | string | Business version of the test script | |
![]() ![]() | 1..1 | boolean | For testing purposes, not real usage | |
![]() ![]() |
|
1..1 | string |
Name
of
the
publisher/steward
(organization
or
|
![]() ![]() | 1..1 | markdown |
Natural
language
description
of
the
|
|
Documentation
for
this
format
|
||||
Full
Structure
Snapshot
View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base TestScript structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
![]() | 1..1 | TestScript |
Describes
a
set
of
tests
| ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ): IETF language tag
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource |
Contained,
inline
Resources
| |||||
![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() | ?! Σ | 0..* | Extension |
|
||||
|
Σ
C
![]() | 1..1 | uri | Canonical identifier for this test script, represented as a URI (globally unique) | ||||
![]() ![]() | Σ | 0..* | Identifier |
Additional
identifier
for
the
test
script
| ||||
![]() ![]() | Σ | 1..1 | string | Business version of the test script | ||||
![]() ![]() | Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) | |||||
![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | Coding | |||||||
![]() ![]() |
Σ
C
![]() | 1..1 | string | Name for this test script (computer friendly) | ||||
![]() ![]() | Σ | 0..1 | string | Name for this test script (human friendly) | ||||
![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. | ||||
![]() ![]() | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() | Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() | Σ | 1..1 | string |
Name
of
the
publisher/steward
(organization
or
| ||||
![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
| ||||
![]() ![]() | 1..1 | markdown | Natural language description of the test script | |||||
![]() ![]() | Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
| ||||
![]() ![]() | Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
test
script
(if
applicable)
Binding: Jurisdiction ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
| 0..1 | markdown | Why this test script is defined | |||||
![]() ![]() | 0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() | 0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() | 0..* | BackboneElement |
An
abstract
server
representing
a
client
or
sender
in
a
message
exchange
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | integer | The index of the abstract origin server starting at 1 | |||||
![]() ![]() ![]() | 1..1 | Coding |
FHIR-Client
|
FHIR-SDC-FormFiller
Binding: TestScriptProfileOriginType ( extensible ): The type of origin profile the test system supports. | |||||
![]() ![]() | 0..* | BackboneElement |
An
abstract
server
representing
a
destination
or
receiver
in
a
message
exchange
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | integer | The index of the abstract destination server starting at 1 | |||||
![]() ![]() ![]() | 1..1 | Coding |
FHIR-Server
|
FHIR-SDC-FormManager
|
FHIR-SDC-FormReceiver
|
FHIR-SDC-FormProcessor
Binding: TestScriptProfileDestinationType ( extensible ): The type of destination profile the test system supports. | |||||
![]() ![]() |
C
![]() | 0..1 | BackboneElement |
Required
capability
that
is
assumed
to
function
correctly
on
|
||||
| 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 0..* | BackboneElement |
Links
to
the
FHIR
specification
| |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
|
1..1 | uri | URL to the specification | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Short description | |||||
![]() ![]() ![]() | 1..* | BackboneElement |
Capabilities
that
are
assumed
to
function
correctly
on
the
FHIR
server
being
tested
| |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() | 1..1 | boolean | Are the capabilities required? | |||||
![]() ![]() ![]() ![]() | 1..1 | boolean | Are the capabilities validated? | |||||
![]() ![]() ![]() ![]() | 0..1 | string | The expected capabilities of the server | |||||
![]() ![]() ![]() ![]() | 0..* | integer |
Which
origin
server
these
requirements
apply
to
| |||||
![]() ![]() ![]() ![]() | 0..1 | integer | Which server these requirements apply to | |||||
![]() ![]() ![]() ![]() | 0..* | uri |
Links
to
the
FHIR
specification
| |||||
![]() ![]() ![]() ![]() | 1..1 | canonical ( CapabilityStatement ) | Required Capability Statement | |||||
![]() ![]() | 0..* | BackboneElement |
Indication
of
the
artifact(s)
that
are
tested
by
this
test
case
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | canonical ( Resource ) | The specific conformance artifact being tested | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept |
required
|
optional
|
strict
Binding: TestScriptScopeConformanceType ( extensible ): The expectation of whether the test must pass for the system to be considered conformant with the artifact. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept |
unit
|
integration
|
production
Binding: TestScriptScopePhaseType ( extensible ): The phase of testing for this artifact. | |||||
![]() ![]() | 0..* | BackboneElement |
Fixture
in
the
test
script
-
by
reference
(uri)
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | boolean | Whether or not to implicitly create the fixture during setup | |||||
![]() ![]() ![]() | 1..1 | boolean | Whether or not to implicitly delete the fixture during teardown | |||||
![]() ![]() ![]() | 0..1 | Reference ( Resource ) | Reference of the resource | |||||
![]() ![]() | 0..* | Reference ( Resource ) |
Reference
of
the
validation
profile
| |||||
![]() ![]() |
C
![]() | 0..* | BackboneElement |
Placeholder
for
evaluated
elements
| ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..1 | string | Descriptive name for this variable | |||||
![]() ![]() ![]() | 0..1 | string | Default, hard-coded, or user-defined value for this variable | |||||
![]() ![]() ![]() | 0..1 | string | Natural language description of the variable | |||||
![]() ![]() ![]() | 0..1 | string | The FHIRPath expression against the fixture body | |||||
![]() ![]() ![]() | 0..1 | string | HTTP header field name for source | |||||
![]() ![]() ![]() | 0..1 | string | Hint help text for default value to enter | |||||
![]() ![]() ![]() | 0..1 | string | XPath or JSONPath against the fixture body | |||||
![]() ![]() ![]() | 0..1 | id | Fixture Id of source expression or headerField within this variable | |||||
![]() ![]() | 0..1 | BackboneElement | A series of required setup operations before tests are executed | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() |
C
![]() | 1..* | BackboneElement |
A
setup
operation
or
assert
to
perform
| ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | BackboneElement | The setup operation to perform | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Coding |
The
operation
code
type
that
will
be
executed
Binding: TestScriptOperationCode ( extensible ): FHIR Operation Code Types | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri |
Resource
type
Binding: Concrete FHIR Types ( extensible ): A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/logging operation label | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/reporting operation description | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
Mime
type
to
accept
in
the
payload
of
the
response,
with
charset
etc.
Binding: MimeType ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: |
|||||
| 0..1 | code |
Mime
type
of
the
request
payload
contents,
with
charset
etc.
Binding: MimeType ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: application/fhir+xml | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | integer | Server responding to the request | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | Whether or not to send the request url in encoded format | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
delete
|
get
|
options
|
patch
|
post
|
put
|
head
Binding: TestScriptRequestMethodCode ( required ): The allowable request method or HTTP operation codes. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | integer | Server initiating the request | |||||
| 0..1 | string | Explicitly defined path parameters | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | BackboneElement |
Each
operation
can
have
one
or
more
header
elements
| |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | HTTP header field name | |||||
![]() ![]() ![]() ![]()
|
1..1 | string | HTTP headerfield value | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of mapped request | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of mapped response | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of body for PUT and POST requests | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Id of fixture used for extracting the [id], [type], and [vid] for GET requests | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Request URL | |||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | BackboneElement | The assertion to perform | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/logging assertion label | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Tracking/reporting assertion description | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
response
|
request
Binding: AssertionDirectionType ( required ): The direction to use for assertions. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Id of the source fixture to be evaluated | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The FHIRPath expression to evaluate against the source fixture | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | XPath or JSONPath expression to evaluate against the source fixture | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
Mime
type
to
compare
against
the
'Content-Type'
header
Binding: MimeType ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: application/fhir+xml | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The FHIRPath expression to be evaluated | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | HTTP header field name | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixture Id of minimum content resource | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean |
| |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
equals
|
notEquals
|
in
|
notIn
|
greaterThan
|
lessThan
|
empty
|
notEmpty
|
contains
|
notContains
|
eval
Binding: AssertionOperatorType ( required ): The type of operator to use for assertions. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | XPath or JSONPath expression | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
delete
|
get
|
options
|
patch
|
post
|
put
|
head
Binding: TestScriptRequestMethodCode ( required ): The allowable request method or HTTP operation codes. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Request URL comparison value | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri |
Resource
type
Binding: Concrete FHIR Types ( extensible ): A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code |
okay
|
created
|
noContent
|
notModified
|
bad
|
forbidden
|
notFound
|
methodNotAllowed
|
conflict
|
gone
|
preconditionFailed
|
unprocessable
Binding: AssertionResponseTypes ( required ): The response code to expect in the response. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | HTTP response code to test | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Fixture Id of source expression or headerField | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | If this assert fails, will the current test execution stop? | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Profile Id of validation profile reference | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value to compare to | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | Will this assert produce a warning only on error? | |||||
![]() ![]() | 0..* | BackboneElement |
A
test
in
this
script
| |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 0..1 | string | Tracking/logging name of this test | |||||
![]() ![]() ![]() | 0..1 | string | Tracking/reporting short description of the test | |||||
![]() ![]() ![]() |
C
![]() | 1..* | BackboneElement |
A
test
operation
or
assert
to
perform
| ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | See operation (TestScript) | The setup operation to perform | ||||
![]() ![]() ![]() ![]() |
C
![]() | 0..1 | See assert (TestScript) | The setup assertion to perform | ||||
![]() ![]() | 0..1 | BackboneElement | A series of required clean up steps | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() | 1..* | BackboneElement |
One
or
more
teardown
operations
to
perform
| |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension |
Additional
content
defined
by
implementations
| |||||
![]() ![]() ![]() ![]() | ?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
| ||||
![]() ![]() ![]() ![]() |
C
![]() | 1..1 | See operation (TestScript) | The teardown operation to perform | ||||
Documentation
for
this
format
|
||||||||
XML Template
<!-- Shareable TestScript -->![]()
< xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension><TestScript xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this test script, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the test script --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the test script --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 1..1 Name for this test script (computer friendly) --> <title value="[string]"/><!-- I 0..1 Name for this test script (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 1..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the test script --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for test script (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this test script is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <origin> I 0..* BackboneElement <!-- I 0..* An abstract server representing a client or sender in a message exchange --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <index value="[integer]"/><!-- I 1..1 The index of the abstract origin server starting at 1 --> <profile><!-- I 1..1 Coding FHIR-Client | FHIR-SDC-FormFiller --></profile> </origin> <destination> I 0..* BackboneElement <!-- I 0..* An abstract server representing a destination or receiver in a message exchange --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <index value="[integer]"/><!-- I 1..1 The index of the abstract destination server starting at 1 --> <profile><!-- I 1..1 Coding FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor --></profile> </destination> <metadata> I 0..1 BackboneElement <!-- I 0..1 Required capability that is assumed to function correctly on the FHIR server being tested --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <link> I 0..* BackboneElement <!-- I 0..* Links to the FHIR specification --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <url value="[uri]"/><!-- I 1..1 URL to the specification --> <description value="[string]"/><!-- I 0..1 Short description --> </link> <capability> I 1..* BackboneElement <!-- I 1..* Capabilities that are assumed to function correctly on the FHIR server being tested --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <required value="[boolean]"/><!-- I 1..1 Are the capabilities required? --> <validated value="[boolean]"/><!-- I 1..1 Are the capabilities validated? --> <description value="[string]"/><!-- I 0..1 The expected capabilities of the server --> <origin value="[integer]"/><!-- I 0..* Which origin server these requirements apply to --> <destination value="[integer]"/><!-- I 0..1 Which server these requirements apply to --> <link value="[uri]"/><!-- I 0..* Links to the FHIR specification --> <capabilities value="[canonical]"/><!-- I 1..1 Required Capability Statement --> </capability> </metadata> <scope> I 0..* BackboneElement <!-- I 0..* Indication of the artifact(s) that are tested by this test case --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <artifact value="[canonical]"/><!-- I 1..1 The specific conformance artifact being tested --> <conformance><!-- I 0..1 CodeableConcept required | optional | strict --></conformance> <phase><!-- I 0..1 CodeableConcept unit | integration | production --></phase> </scope> <fixture> I 0..* BackboneElement <!-- I 0..* Fixture in the test script - by reference (uri) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <autocreate value="[boolean]"/><!-- I 1..1 Whether or not to implicitly create the fixture during setup --> <autodelete value="[boolean]"/><!-- I 1..1 Whether or not to implicitly delete the fixture during teardown --> <resource><!-- I 0..1 Reference(Resource) Reference of the resource --></resource> </fixture> <profile><!-- I 0..* Reference(Resource) Reference of the validation profile --></profile> <variable> I 0..* BackboneElement <!-- I 0..* Placeholder for evaluated elements --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 1..1 Descriptive name for this variable --> <defaultValue value="[string]"/><!-- I 0..1 Default, hard-coded, or user-defined value for this variable --> <description value="[string]"/><!-- I 0..1 Natural language description of the variable --> <expression value="[string]"/><!-- I 0..1 The FHIRPath expression against the fixture body --> <headerField value="[string]"/><!-- I 0..1 HTTP header field name for source --> <hint value="[string]"/><!-- I 0..1 Hint help text for default value to enter --> <path value="[string]"/><!-- I 0..1 XPath or JSONPath against the fixture body --> <sourceId value="[id]"/><!-- I 0..1 Fixture Id of source expression or headerField within this variable --> </variable> <setup> I 0..1 BackboneElement <!-- I 0..1 A series of required setup operations before tests are executed --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <action> I 1..* BackboneElement <!-- I 1..* A setup operation or assert to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <operation> I 0..1 BackboneElement <!-- I 0..1 The setup operation to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type><!-- I 0..1 Coding The operation code type that will be executed --></type> <resource value="[uri]"/><!-- I 0..1 Resource type --> <label value="[string]"/><!-- I 0..1 Tracking/logging operation label --> <description value="[string]"/><!-- I 0..1 Tracking/reporting operation description --> <accept value="[code]"/><!-- I 0..1 Mime type to accept in the payload of the response, with charset etc. --> <contentType value="[code]"/><!-- I 0..1 Mime type of the request payload contents, with charset etc. --> <destination value="[integer]"/><!-- I 0..1 Server responding to the request --> <encodeRequestUrl value="[boolean]"/><!-- I 1..1 Whether or not to send the request url in encoded format --> <method value="[code]"/><!-- I 0..1 delete | get | options | patch | post | put | head --> <origin value="[integer]"/><!-- I 0..1 Server initiating the request --> <params value="[string]"/><!-- I 0..1 Explicitly defined path parameters --> <requestHeader> I 0..* BackboneElement <!-- I 0..* Each operation can have one or more header elements --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <field value="[string]"/><!-- I 1..1 HTTP header field name --> <value value="[string]"/><!-- I 1..1 HTTP headerfield value --> </requestHeader> <requestId value="[id]"/><!-- I 0..1 Fixture Id of mapped request --> <responseId value="[id]"/><!-- I 0..1 Fixture Id of mapped response --> <sourceId value="[id]"/><!-- I 0..1 Fixture Id of body for PUT and POST requests --> <targetId value="[id]"/><!-- I 0..1 Id of fixture used for extracting the [id], [type], and [vid] for GET requests --> <url value="[string]"/><!-- I 0..1 Request URL --> </operation> <assert> I 0..1 BackboneElement <!-- I 0..1 The assertion to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <label value="[string]"/><!-- I 0..1 Tracking/logging assertion label --> <description value="[string]"/><!-- I 0..1 Tracking/reporting assertion description --> <direction value="[code]"/><!-- I 0..1 response | request --> <compareToSourceId value="[string]"/><!-- I 0..1 Id of the source fixture to be evaluated --> <compareToSourceExpression value="[string]"/><!-- I 0..1 The FHIRPath expression to evaluate against the source fixture --> <compareToSourcePath value="[string]"/><!-- I 0..1 XPath or JSONPath expression to evaluate against the source fixture --> <contentType value="[code]"/><!-- I 0..1 Mime type to compare against the 'Content-Type' header --> <expression value="[string]"/><!-- I 0..1 The FHIRPath expression to be evaluated --> <headerField value="[string]"/><!-- I 0..1 HTTP header field name --> <minimumId value="[string]"/><!-- I 0..1 Fixture Id of minimum content resource --> <navigationLinks value="[boolean]"/><!-- I 0..1 Perform validation on navigation links? --> <operator value="[code]"/><!-- I 0..1 equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval --> <path value="[string]"/><!-- I 0..1 XPath or JSONPath expression --> <requestMethod value="[code]"/><!-- I 0..1 delete | get | options | patch | post | put | head --> <requestURL value="[string]"/><!-- I 0..1 Request URL comparison value --> <resource value="[uri]"/><!-- I 0..1 Resource type --> <response value="[code]"/><!-- I 0..1 okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable --> <responseCode value="[string]"/><!-- I 0..1 HTTP response code to test --> <sourceId value="[id]"/><!-- I 0..1 Fixture Id of source expression or headerField --> <stopTestOnFail value="[boolean]"/><!-- I 1..1 If this assert fails, will the current test execution stop? --> <validateProfileId value="[id]"/><!-- I 0..1 Profile Id of validation profile reference --> <value value="[string]"/><!-- I 0..1 The value to compare to --> <warningOnly value="[boolean]"/><!-- I 1..1 Will this assert produce a warning only on error? --> </assert> </action> </setup> <test> I 0..* BackboneElement <!-- I 0..* A test in this script --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <name value="[string]"/><!-- I 0..1 Tracking/logging name of this test --> <description value="[string]"/><!-- I 0..1 Tracking/reporting short description of the test --> <action> I 1..* BackboneElement <!-- I 1..* A test operation or assert to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <operation><!-- See http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation The setup operation to perform --></operation> <assert><!-- See http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.assert The setup assertion to perform --></assert> </action> </test> <teardown> I 0..1 BackboneElement <!-- I 0..1 A series of required clean up steps --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <action> I 1..* BackboneElement <!-- I 1..* One or more teardown operations to perform --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <operation><!-- See http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation The teardown operation to perform --></operation> </action> </teardown> </TestScript>
JSON Template
{ // Shareable TestScript
// from Element: extension
"
],
"
"
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this test script, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the test script
"version" : "<string>", // I R! Business version of the test script
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // I R! Name for this test script (computer friendly)
"title" : "<string>", // IName for this test script (human friendly)
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
"date" : "<dateTime>", // IDate last changed
"publisher" : "<string>", // I R! Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the test script
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for test script (if applicable)
"purpose" : "<markdown>", // IWhy this test script is defined
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"origin" : [{ BackboneElement }], // IAn abstract server representing a client or sender in a message exchange
"destination" : [{ BackboneElement }], // IAn abstract server representing a destination or receiver in a message exchange
"metadata" : { BackboneElement }, // IRequired capability that is assumed to function correctly on the FHIR server being tested
"scope" : [{ BackboneElement }], // IIndication of the artifact(s) that are tested by this test case
"fixture" : [{ BackboneElement }], // IFixture in the test script - by reference (uri)
"profile" : [{ Reference(Resource) }], // IReference of the validation profile
"variable" : [{ BackboneElement }], // IPlaceholder for evaluated elements
"setup" : { BackboneElement }, // IA series of required setup operations before tests are executed
"test" : [{ BackboneElement }], // IA test in this script
"teardown" : { BackboneElement } // IA series of required clean up steps
}
Constraints
Alternate
definitions:
Master
Definition
(
XML
,
JSON
),
Schematron
| Path | Name | Conformance | ValueSet |
| TestScript.language | Common Languages | preferred | Common Languages |
| TestScript.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| TestScript.status | PublicationStatus | required | PublicationStatus |
| TestScript.jurisdiction | Jurisdiction | extensible | Jurisdiction |
| TestScript.origin.profile | TestScriptProfileOriginType | extensible | TestScriptProfileOriginType |
| TestScript.destination.profile | TestScriptProfileDestinationType | extensible | TestScriptProfileDestinationType |
| TestScript.scope.conformance | TestScriptScopeConformanceType | extensible | TestScriptScopeConformanceType |
| TestScript.scope.phase | TestScriptScopePhaseType | extensible | TestScriptScopePhaseType |
| TestScript.setup.action.operation.type | TestScriptOperationCode | extensible | TestScriptOperationCode |
| TestScript.setup.action.operation.resource |
Concrete
FHIR
|
|
Concrete FHIR Types |
| TestScript.setup.action.operation.accept | MimeType | required | MimeType |
| TestScript.setup.action.operation.contentType | MimeType | required | MimeType |
| TestScript.setup.action.operation.method | TestScriptRequestMethodCode | required | TestScriptRequestMethodCode |
| TestScript.setup.action.assert.direction | AssertionDirectionType | required | AssertionDirectionType |
| TestScript.setup.action.assert.contentType | MimeType | required | MimeType |
| TestScript.setup.action.assert.operator | AssertionOperatorType | required | AssertionOperatorType |
| TestScript.setup.action.assert.requestMethod | TestScriptRequestMethodCode | required | TestScriptRequestMethodCode |
| TestScript.setup.action.assert.resource | Concrete FHIR Types | extensible | Concrete FHIR Types |
| TestScript.setup.action.assert.response | AssertionResponseTypes | required | AssertionResponseTypes |