Test Script

$10 / year

The Test Script resource is designed to establish testing as a first class artifact within the FHIR specification. This resource allows defining a suite of tests that can be executed on one or more FHIR servers and clients.


The Test Script resource is used to define tests that can be executed on one or more FHIR servers. A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. The Test Script resource would typically contain:

– a list of fixtures (required resources used in the tests)
– setup procedures
– a suite of thematically related tests
– teardown procedures

One Test Script might feature a set of tests focusing on searching Patients and validating the Bundle responses. The fixtures for such a test would contain a list of Patient resources that are required for the test to complete successfully. The setup procedures create the fixtures on the FHIR server being tested. A series of tests execute various search parameters and search for the fixtures in the results. The teardown procedures would then clean up (delete) the fixtures on FHIR server that were created during the setup procedures.

The purpose of the TestScript is to encode in an executable representation tests that can be used to

1. determine whether a given FHIR server adheres to the FHIR specification and
2. determine whether two or more FHIR servers implement capabilities in a compatible or interoperable manner.

The Test Script resource is not used to represent Clinical tests, Prescriptions, or any other Healthcare related concept. The Test Script resource is an infrastructure support resource used to represent standardized tests to determine an implementation’s level of adherence to the FHIR specification.

Test Script is a part of the conformance framework and is used to validate the behavior of FHIR systems, specifically their correct implementation of StructureDefinition, ValueSet, OperationDefinition, CapabilityStatement and other FHIR resources that govern system behavior. TestScript instances may be included as part of ImplementationGuides to help define and test the desired behavior of systems that choose to comply with the implementation guide.

Date Created


Last Modified




Update Frequency


Temporal Coverage


Spatial Coverage

United States


John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements


Source Citation



FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Test Script Resource, Electronic Health Records Exchange Through FHIR

Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
EnumThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItemsEnumRequiredConst
TestScriptresourceTypeThis is a TestScript resourceTestScript
TestScriptid#/definitions/idThe logical id of the resource as used in the URL for the resource. Once assigned this value never changes.
TestScriptmeta#/definitions/MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
TestScriptimplicitRules#/definitions/uriA reference to a set of rules that were followed when the resource was constructed and which must be understood when processing the content. Often this is a reference to an implementation guide that defines the special rules along with other profiles etc.
TestScript_implicitRules#/definitions/ElementExtensions for implicitRules
TestScriptlanguage#/definitions/codeThe base language in which the resource is written.
TestScript_language#/definitions/ElementExtensions for language
TestScripttext#/definitions/NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
TestScriptcontainedarrayThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently and nor can they have their own independent transaction scope.{'$ref': '#/definitions/ResourceList'}
TestScriptextensionarrayMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension there is a set of requirements that SHALL be met as part of the definition of the extension.{'$ref': '#/definitions/Extension'}
Related Data Packages