A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
If the element is present, it must have either a @value, an @id, or extensions
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 at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.
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.
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.
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.
A short, descriptive, user-friendly title for the test script.
The status of this test script. Enables tracking the life-cycle of the content.
A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
The name of the organization or individual that published the test script.
Contact details to assist a user in finding and communicating with the publisher.
A free text natural language description of the test script from a consumer's perspective.
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.
A legal or geographic region in which the test script is intended to be used.
Explanation of why this test script is needed and why it has been designed as it has.
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.
An abstract server used in operations within this test script in the origin element.
An abstract server used in operations within this test script in the destination element.
The required capability must exist and are assumed to function correctly on the FHIR server being tested.
Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
Reference to the profile to be used for validation.
Variable is set based either on element value in response body or on header field value in the response headers.
A series of required setup operations before tests are executed.
A test in this script.
A series of operations required to clean up after all the tests are executed (successfully or otherwise).
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.
The type of origin profile the test system supports.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
The type of destination profile the test system supports.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
A link to the FHIR specification that this test is covering.
Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
URL to a particular requirement or feature within the FHIR specification.
Short description of the link.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
Description of the capabilities that this test script is requiring the server to support.
Which origin server these requirements apply to.
Which server these requirements apply to.
Links to the FHIR specification that describes this interaction and the resources involved in more detail.
Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.
Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.
Reference to the resource (containing the contents of the resource needed for operations).
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Descriptive name for this variable.
A default, hard-coded, or user-defined value for this variable.
A free text natural language description of the variable and its purpose.
The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
Displayable text string with hint help information to the user when entering a default value.
XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Action would contain either an operation or an assertion.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
The operation to perform.
Evaluates the results of previous operations to determine if the server under test behaves appropriately.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
Server interaction or operation type.
The type of the resource. See http://build.fhir.org/resourcelist.html.
The label would be used for tracking/logging purposes by test engines.
The description would be used by test engines for tracking and reporting purposes.
The mime-type to use for RESTful operation in the 'Accept' header.
The mime-type to use for RESTful operation in the 'Content-Type' header.
The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
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.
The HTTP method the test engine MUST use for this operation regardless of any other operation details.
The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
Path plus parameters after [type]. Used to set parts of the request URL explicitly.
Header elements would be used to set HTTP headers.
The fixture id (maybe new) to map to the request.
The fixture id (maybe new) to map to the response.
The id of the fixture used as the body of a PUT or POST request.
Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
Complete request URL.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
The HTTP header field e.g. "Accept".
The value of the header e.g. "application/fhir+xml".
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
The label would be used for tracking/logging purposes by test engines.
The description would be used by test engines for tracking and reporting purposes.
The direction to use for the assertion.
Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.
The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
The mime-type contents to compare against the request or response message 'Content-Type' header.
The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.
The HTTP header field name e.g. 'Location'.
The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
Whether or not the test execution performs validation on the bundle navigation links.
The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
The request method or HTTP operation code to compare against that used by the client system under test.
The value to use in a comparison against the request URL path string.
The type of the resource. See http://build.fhir.org/resourcelist.html.
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
The value of the HTTP response code to be tested.
Fixture to evaluate the XPath/JSONPath expression or the headerField against.
The ID of the Profile to validate against.
The value to compare to.
Whether or not the test execution will produce a warning only on error for this assert.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
The name of this test used for tracking/logging purposes by test engines.
A short description of the test used by test engines for tracking and reporting purposes.
Action would contain either an operation or an assertion.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
An operation would involve a REST request to a server.
Evaluates the results of previous operations to determine if the server under test behaves appropriately.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
The teardown action will only contain an operation.
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
An operation would involve a REST request to a server.
response
request
The type of direction to use for assertion.
If the element is present, it must have either a @value, an @id, or extensions
equals
notEquals
in
notIn
greaterThan
lessThan
empty
notEmpty
contains
notContains
evaluate
The type of operator to use for assertion.
If the element is present, it must have either a @value, an @id, or extensions
okay
created
noContent
notModified
bad
forbidden
notFound
methodNotAllowed
conflict
gone
preconditionFailed
unprocessable
The type of response code to use for assertion.
If the element is present, it must have either a @value, an @id, or extensions
DELETE
GET
OPTIONS
PATCH
POST
PUT
HEAD
The allowable request method or HTTP operation codes.
If the element is present, it must have either a @value, an @id, or extensions