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

TestScript
url
Canonical identifier for this test script, represented as a URI (globally unique)
identifier
Additional identifier for the test script
version
Business version of the test script
versionAlgorithm[x]
How to compare versions
name
Name for this test script (computer friendly)
title
Name for this test script (human friendly)
status
draft | active | retired | unknown
experimental
For testing purposes, not real usage
date
Date last changed
publisher
Name of the publisher/steward (organization or individual)
contact
Contact details for the publisher
description
Natural language description of the test script
useContext
The context that the content is intended to support
jurisdiction
Intended jurisdiction for test script (if applicable)
purpose
Why this test script is defined
copyrightLabel
Copyright holder and year(s)
origin
An abstract server representing a client or sender in a message exchange
index
The index of the abstract origin server starting at 1
profile
FHIR-Client | FHIR-SDC-FormFiller
url
The url path of the origin server
destination
An abstract server representing a destination or receiver in a message exchange
index
The index of the abstract destination server starting at 1
profile
FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor
url
The url path of the destination server
metadata
Required capability that is assumed to function correctly on the FHIR server being tested
capability
Capabilities that are assumed to function correctly on the FHIR server being tested
required
Are the capabilities required?
validated
Are the capabilities validated?
description
The expected capabilities of the server
origin
Which origin server these requirements apply to
destination
Which server these requirements apply to
capabilities
Required Capability Statement
scope
Indication of the artifact(s) that are tested by this test case
artifact
The specific conformance artifact being tested
conformance
required | optional | strict
phase
unit | integration | production
fixture
Fixture in the test script - by reference (uri)
autocreate
Whether or not to implicitly create the fixture during setup
autodelete
Whether or not to implicitly delete the fixture during teardown
resource
Reference of the resource
profile
Reference of the validation profile
variable
Placeholder for evaluated elements
name
Descriptive name for this variable
defaultValue
Default, hard-coded, or user-defined value for this variable
description
Natural language description of the variable
expression
The FHIRPath expression against the fixture body
headerField
HTTP header field name for source
hint
Hint help text for default value to enter
path
XPath or JSONPath against the fixture body
sourceId
Fixture Id of source expression or headerField within this variable
setup
A series of required setup operations before tests are executed
action
A setup operation or assert to perform
operation
The setup operation to perform
type
The operation code type that will be executed
resource
Resource type
label
Tracking/logging operation label
description
Tracking/reporting operation description
accept
Mime type to accept in the payload of the response, with charset etc
contentType
Mime type of the request payload contents, with charset etc
destination
Server responding to the request
encodeRequestUrl
Whether or not to send the request url in encoded format
method
delete | get | options | patch | post | put | head
origin
Server initiating the request
params
Explicitly defined path parameters
requestHeader
Each operation can have one or more header elements
field
HTTP header field name
value
HTTP headerfield value
requestId
Fixture Id of mapped request
responseId
Fixture Id of mapped response
sourceId
Fixture Id of body for PUT and POST requests
targetId
Id of fixture used for extracting the [id], [type], and [vid] for GET requests
url
Request URL
assert
The assertion to perform
label
Tracking/logging assertion label
description
Tracking/reporting assertion description
direction
response | request
compareToSourceId
Id of the source fixture to be evaluated
compareToSourceExpression
The FHIRPath expression to evaluate against the source fixture
compareToSourcePath
XPath or JSONPath expression to evaluate against the source fixture
contentType
Mime type to compare against the 'Content-Type' header
defaultManualCompletion
fail | pass | skip | stop
expression
The FHIRPath expression to be evaluated
headerField
HTTP header field name
minimumId
Fixture Id of minimum content resource
operator
equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval
path
XPath or JSONPath expression
requestMethod
delete | get | options | patch | post | put | head
requestURL
Request URL comparison value
resource
Resource type
response
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
responseCode
HTTP response code to test
sourceId
Fixture Id of source expression or headerField
stopTestOnFail
If this assert fails, will the current test execution stop?
validateProfileId
Profile Id of validation profile reference
value
The value to compare to
warningOnly
Will this assert produce a warning only on error?
requirement
Links or references to the testing requirements
link[x]
Link or reference to the testing requirement
test
A test in this script
name
Tracking/logging name of this test
description
Tracking/reporting short description of the test
action
A test operation or assert to perform
operation
The setup operation to perform
assert
The setup assertion to perform
teardown
A series of required clean up steps
action
One or more teardown operations to perform
operation
The teardown operation to perform