FHIR CI-Build
Implementation SupportThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is a representation of the json schema for TestScript, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/TestScript",
"$ref": "#/definitions/TestScript",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"TestScript": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"resourceType": {
"description": "This is a TestScript resource",
"const": "TestScript"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The 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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A 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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A 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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May 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 managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the test script.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this test script. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The date (and optionally time) when the test script was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the test script.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the test script from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the test script is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this test script is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "Element.schema.json#/definitions/Element"
},
"origin": {
"description": "An abstract server used in operations within this test script in the origin element.",
"items": {
"$ref": "#/definitions/TestScript_Origin"
},
"type": "array"
},
"destination": {
"description": "An abstract server used in operations within this test script in the destination element.",
"items": {
"$ref": "#/definitions/TestScript_Destination"
},
"type": "array"
},
"metadata": {
"description": "The required capability must exist and are assumed to function correctly on the FHIR server being tested.",
"$ref": "#/definitions/TestScript_Metadata"
},
"scope": {
"description": "The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.",
"items": {
"$ref": "#/definitions/TestScript_Scope"
},
"type": "array"
},
"fixture": {
"description": "Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.",
"items": {
"$ref": "#/definitions/TestScript_Fixture"
},
"type": "array"
},
"profile": {
"description": "Reference to the profile to be used for validation.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"variable": {
"description": "Variable is set based either on element value in response body or on header field value in the response headers.",
"items": {
"$ref": "#/definitions/TestScript_Variable"
},
"type": "array"
},
"setup": {
"description": "A series of required setup operations before tests are executed.",
"$ref": "#/definitions/TestScript_Setup"
},
"test": {
"description": "A test in this script.",
"items": {
"$ref": "#/definitions/TestScript_Test"
},
"type": "array"
},
"teardown": {
"description": "A series of operations required to clean up after all the tests are executed (successfully or otherwise).",
"$ref": "#/definitions/TestScript_Teardown"
},
"common": {
"description": "A common collection of actions that can be re-used in a TestScript.",
"items": {
"$ref": "#/definitions/TestScript_Common1"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"TestScript_Origin": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"index": {
"description": "Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.",
"$ref": "#/definitions/integer"
},
"_index": {
"description": "Extensions for index",
"$ref": "Element.schema.json#/definitions/Element"
},
"profile": {
"description": "The type of origin profile the test system supports.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"url": {
"description": "The explicit url path of the origin server used in this test script.",
"$ref": "#/definitions/url"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"profile"
]
},
"TestScript_Destination": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"index": {
"description": "Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.",
"$ref": "#/definitions/integer"
},
"_index": {
"description": "Extensions for index",
"$ref": "Element.schema.json#/definitions/Element"
},
"profile": {
"description": "The type of destination profile the test system supports.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"url": {
"description": "The explicit url path of the destination server used in this test script.",
"$ref": "#/definitions/url"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"profile"
]
},
"TestScript_Metadata": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"link": {
"description": "A link to the FHIR specification that this test is covering.",
"items": {
"$ref": "#/definitions/TestScript_Link"
},
"type": "array"
},
"capability": {
"description": "Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.",
"items": {
"$ref": "#/definitions/TestScript_Capability"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"capability"
]
},
"TestScript_Link": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "URL to a particular requirement or feature within the FHIR specification.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "Short description of the link.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Capability": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"required": {
"description": "Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.",
"$ref": "#/definitions/boolean"
},
"_required": {
"description": "Extensions for required",
"$ref": "Element.schema.json#/definitions/Element"
},
"validated": {
"description": "Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.",
"$ref": "#/definitions/boolean"
},
"_validated": {
"description": "Extensions for validated",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "Description of the capabilities that this test script is requiring the server to support.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"origin": {
"description": "Which origin server these requirements apply to.",
"items": {
"$ref": "#/definitions/integer"
},
"type": "array"
},
"_origin": {
"description": "Extensions for origin",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"destination": {
"description": "Which server these requirements apply to.",
"$ref": "#/definitions/integer"
},
"_destination": {
"description": "Extensions for destination",
"$ref": "Element.schema.json#/definitions/Element"
},
"link": {
"description": "Links to the FHIR specification that describes this interaction and the resources involved in more detail.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_link": {
"description": "Extensions for link",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"capabilities": {
"description": "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.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"capabilities"
]
},
"TestScript_Scope": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"artifact": {
"description": "The specific conformance artifact being tested. The canonical reference can be version-specific.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"conformance": {
"description": "The expectation of whether the test must pass for the system to be considered conformant with the artifact: required - all tests are expected to pass, optional - all test are expected to pass but non-pass status may be allowed, strict - all tests are expected to pass and warnings are treated as a failure.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"phase": {
"description": "The phase of testing for this artifact: unit - development / implementation phase, integration - internal system to system phase, production - live system to system phase (Note, this may involve pii/phi data).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"artifact"
]
},
"TestScript_Fixture": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"autocreate": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_autocreate": {
"description": "Extensions for autocreate",
"$ref": "Element.schema.json#/definitions/Element"
},
"autodelete": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_autodelete": {
"description": "Extensions for autodelete",
"$ref": "Element.schema.json#/definitions/Element"
},
"resource": {
"description": "Reference to the resource (containing the contents of the resource needed for operations). This is allowed to be a Parameters resource.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Variable": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "Descriptive name for this variable.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"defaultValue": {
"description": "A default, hard-coded, or user-defined value for this variable.",
"$ref": "#/definitions/string"
},
"_defaultValue": {
"description": "Extensions for defaultValue",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A free text natural language description of the variable and its purpose.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"expression": {
"description": "The FHIRPath expression for a specific value to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.",
"$ref": "#/definitions/string"
},
"_expression": {
"description": "Extensions for expression",
"$ref": "Element.schema.json#/definitions/Element"
},
"headerField": {
"description": "Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.",
"$ref": "#/definitions/string"
},
"_headerField": {
"description": "Extensions for headerField",
"$ref": "Element.schema.json#/definitions/Element"
},
"hint": {
"description": "Displayable text string with hint help information to the user when entering a default value.",
"$ref": "#/definitions/string"
},
"_hint": {
"description": "Extensions for hint",
"$ref": "Element.schema.json#/definitions/Element"
},
"path": {
"description": "XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "Element.schema.json#/definitions/Element"
},
"sourceId": {
"description": "Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.",
"$ref": "#/definitions/id"
},
"_sourceId": {
"description": "Extensions for sourceId",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Setup": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"action": {
"description": "Action would contain either a common or operation or an assertion.",
"items": {
"$ref": "#/definitions/TestScript_Action"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Action": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"common": {
"description": "Links or references to common collection(s) of actions in this or an external TestScript instance.",
"$ref": "#/definitions/TestScript_Common"
},
"operation": {
"description": "The operation to perform.",
"$ref": "#/definitions/TestScript_Operation"
},
"assert": {
"description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"$ref": "#/definitions/TestScript_Assert"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Common": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"testScript": {
"description": "Canonical reference providing traceability to the common TestScript instance containing the commonKey.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"keyRef": {
"description": "Common key reference that identifies the common collection of actions to perform as defined the this or the common testScript.",
"$ref": "#/definitions/id"
},
"_keyRef": {
"description": "Extensions for keyRef",
"$ref": "Element.schema.json#/definitions/Element"
},
"parameter": {
"description": "Optional named parameter(s) to provide input values to the identified common collection of actions from this or an external TestScript.",
"items": {
"$ref": "#/definitions/TestScript_Parameter"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Parameter": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of this parameter from the identified common collection of actions from this or an external TestScript.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"value": {
"description": "The value to assign to this parameter from the identified common collection of actions from this or an external TestScript.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Operation": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "Server interaction or operation type.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"resource": {
"description": "The type of the FHIR resource. See the [resource list](resourcelist.html). Data type of uri is needed when non-HL7 artifacts are identified.",
"$ref": "#/definitions/uri"
},
"_resource": {
"description": "Extensions for resource",
"$ref": "Element.schema.json#/definitions/Element"
},
"label": {
"description": "The label would be used for tracking/logging purposes by test engines.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "The description would be used by test engines for tracking and reporting purposes.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"accept": {
"description": "The mime-type to use for RESTful operation in the \u0027Accept\u0027 header.",
"$ref": "#/definitions/code"
},
"_accept": {
"description": "Extensions for accept",
"$ref": "Element.schema.json#/definitions/Element"
},
"contentType": {
"description": "The mime-type to use for RESTful operation in the \u0027Content-Type\u0027 header.",
"$ref": "#/definitions/code"
},
"_contentType": {
"description": "Extensions for contentType",
"$ref": "Element.schema.json#/definitions/Element"
},
"destination": {
"description": "The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.",
"$ref": "#/definitions/integer"
},
"_destination": {
"description": "Extensions for destination",
"$ref": "Element.schema.json#/definitions/Element"
},
"encodeRequestUrl": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_encodeRequestUrl": {
"description": "Extensions for encodeRequestUrl",
"$ref": "Element.schema.json#/definitions/Element"
},
"method": {
"description": "The HTTP method the test engine MUST use for this operation regardless of any other operation details.",
"$ref": "#/definitions/code"
},
"_method": {
"description": "Extensions for method",
"$ref": "Element.schema.json#/definitions/Element"
},
"origin": {
"description": "The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.",
"$ref": "#/definitions/integer"
},
"_origin": {
"description": "Extensions for origin",
"$ref": "Element.schema.json#/definitions/Element"
},
"params": {
"description": "Path plus parameters after [type]. Used to set parts of the request URL explicitly.",
"$ref": "#/definitions/string"
},
"_params": {
"description": "Extensions for params",
"$ref": "Element.schema.json#/definitions/Element"
},
"requestHeader": {
"description": "Header elements would be used to set HTTP headers.",
"items": {
"$ref": "#/definitions/TestScript_RequestHeader"
},
"type": "array"
},
"requestId": {
"description": "The fixture id (maybe new) to map to the request.",
"$ref": "#/definitions/id"
},
"_requestId": {
"description": "Extensions for requestId",
"$ref": "Element.schema.json#/definitions/Element"
},
"responseId": {
"description": "The fixture id (maybe new) to map to the response.",
"$ref": "#/definitions/id"
},
"_responseId": {
"description": "Extensions for responseId",
"$ref": "Element.schema.json#/definitions/Element"
},
"sourceId": {
"description": "The id of the fixture used as the body of a PUT or POST request.",
"$ref": "#/definitions/id"
},
"_sourceId": {
"description": "Extensions for sourceId",
"$ref": "Element.schema.json#/definitions/Element"
},
"targetId": {
"description": "Id of fixture used for extracting the [id], [type], and [vid] for GET requests.",
"$ref": "#/definitions/id"
},
"_targetId": {
"description": "Extensions for targetId",
"$ref": "Element.schema.json#/definitions/Element"
},
"url": {
"description": "Complete request URL.",
"$ref": "#/definitions/string"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_RequestHeader": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"field": {
"description": "The HTTP header field e.g. \"Accept\".",
"$ref": "#/definitions/string"
},
"_field": {
"description": "Extensions for field",
"$ref": "Element.schema.json#/definitions/Element"
},
"value": {
"description": "The value of the header e.g. \"application/fhir+xml\".",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Assert": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"label": {
"description": "The label would be used for tracking/logging purposes by test engines.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "The description would be used by test engines for tracking and reporting purposes.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"direction": {
"description": "The direction to use for the assertion.",
"$ref": "#/definitions/code"
},
"_direction": {
"description": "Extensions for direction",
"$ref": "Element.schema.json#/definitions/Element"
},
"compareToSourceId": {
"description": "Id of the source fixture used as the contents to be evaluated by either the \"source/expression\" or \"sourceId/path\" definition.",
"$ref": "#/definitions/string"
},
"_compareToSourceId": {
"description": "Extensions for compareToSourceId",
"$ref": "Element.schema.json#/definitions/Element"
},
"compareToSourceExpression": {
"description": "The FHIRPath expression for a specific value to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.",
"$ref": "#/definitions/string"
},
"_compareToSourceExpression": {
"description": "Extensions for compareToSourceExpression",
"$ref": "Element.schema.json#/definitions/Element"
},
"compareToSourcePath": {
"description": "XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.",
"$ref": "#/definitions/string"
},
"_compareToSourcePath": {
"description": "Extensions for compareToSourcePath",
"$ref": "Element.schema.json#/definitions/Element"
},
"contentType": {
"description": "The mime-type contents to compare against the request or response message \u0027Content-Type\u0027 header.",
"$ref": "#/definitions/code"
},
"_contentType": {
"description": "Extensions for contentType",
"$ref": "Element.schema.json#/definitions/Element"
},
"defaultManualCompletion": {
"description": "The default manual completion outcome applied to this assertion.",
"$ref": "#/definitions/code"
},
"_defaultManualCompletion": {
"description": "Extensions for defaultManualCompletion",
"$ref": "Element.schema.json#/definitions/Element"
},
"expression": {
"description": "The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.",
"$ref": "#/definitions/string"
},
"_expression": {
"description": "Extensions for expression",
"$ref": "Element.schema.json#/definitions/Element"
},
"headerField": {
"description": "The HTTP header field name e.g. \u0027Location\u0027.",
"$ref": "#/definitions/string"
},
"_headerField": {
"description": "Extensions for headerField",
"$ref": "Element.schema.json#/definitions/Element"
},
"minimumId": {
"description": "The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.",
"$ref": "#/definitions/string"
},
"_minimumId": {
"description": "Extensions for minimumId",
"$ref": "Element.schema.json#/definitions/Element"
},
"navigationLinks": {
"description": "Whether or not the test execution performs validation on the bundle navigation links.",
"$ref": "#/definitions/boolean"
},
"_navigationLinks": {
"description": "Extensions for navigationLinks",
"$ref": "Element.schema.json#/definitions/Element"
},
"operator": {
"description": "The operator type defines the conditional behavior of the assert.",
"$ref": "#/definitions/code"
},
"_operator": {
"description": "Extensions for operator",
"$ref": "Element.schema.json#/definitions/Element"
},
"path": {
"description": "The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "Element.schema.json#/definitions/Element"
},
"requestMethod": {
"description": "The request method or HTTP operation code to compare against that used by the client system under test.",
"$ref": "#/definitions/code"
},
"_requestMethod": {
"description": "Extensions for requestMethod",
"$ref": "Element.schema.json#/definitions/Element"
},
"requestURL": {
"description": "The value to use in a comparison against the request URL path string.",
"$ref": "#/definitions/string"
},
"_requestURL": {
"description": "Extensions for requestURL",
"$ref": "Element.schema.json#/definitions/Element"
},
"resource": {
"description": "The type of the resource. See the [resource list](resourcelist.html).",
"$ref": "#/definitions/uri"
},
"_resource": {
"description": "Extensions for resource",
"$ref": "Element.schema.json#/definitions/Element"
},
"response": {
"description": "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.",
"$ref": "#/definitions/code"
},
"_response": {
"description": "Extensions for response",
"$ref": "Element.schema.json#/definitions/Element"
},
"responseCode": {
"description": "The value of the HTTP response code to be tested.",
"$ref": "#/definitions/string"
},
"_responseCode": {
"description": "Extensions for responseCode",
"$ref": "Element.schema.json#/definitions/Element"
},
"sourceId": {
"description": "Fixture to evaluate the XPath/JSONPath expression or the headerField against.",
"$ref": "#/definitions/id"
},
"_sourceId": {
"description": "Extensions for sourceId",
"$ref": "Element.schema.json#/definitions/Element"
},
"stopTestOnFail": {
"description": "Whether or not the current test execution will stop on failure for this assert.",
"$ref": "#/definitions/boolean"
},
"_stopTestOnFail": {
"description": "Extensions for stopTestOnFail",
"$ref": "Element.schema.json#/definitions/Element"
},
"validateProfileId": {
"description": "The ID of the Profile to validate against.",
"$ref": "#/definitions/id"
},
"_validateProfileId": {
"description": "Extensions for validateProfileId",
"$ref": "Element.schema.json#/definitions/Element"
},
"value": {
"description": "The value to compare to.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "Element.schema.json#/definitions/Element"
},
"warningOnly": {
"description": "Whether or not the test execution will produce a warning only on error for this assert.",
"$ref": "#/definitions/boolean"
},
"_warningOnly": {
"description": "Extensions for warningOnly",
"$ref": "Element.schema.json#/definitions/Element"
},
"requirement": {
"description": "Links or references providing traceability to the testing requirements for this assert.",
"items": {
"$ref": "#/definitions/TestScript_Requirement"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Requirement": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"reference": {
"description": "Canonical reference providing traceability to the testing requirement for this assert.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"key": {
"description": "Requirements.statement.key that identifies the statement that this assert satisfies.",
"$ref": "#/definitions/id"
},
"_key": {
"description": "Extensions for key",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"reference"
]
},
"TestScript_Test": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of this test used for tracking/logging purposes by test engines.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A short description of the test used by test engines for tracking and reporting purposes.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"action": {
"description": "Action would contain either an operation or an assertion.",
"items": {
"$ref": "#/definitions/TestScript_Action1"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Action1": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"common": {
"description": "Links or references to common collection(s) of actions in this or an external TestScript instance.",
"$ref": "#/definitions/TestScript_Common"
},
"operation": {
"description": "An operation would involve a REST request to a server.",
"$ref": "#/definitions/TestScript_Operation"
},
"assert": {
"description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"$ref": "#/definitions/TestScript_Assert"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Teardown": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"action": {
"description": "The teardown action will only contain an operation.",
"items": {
"$ref": "#/definitions/TestScript_Action2"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"action"
]
},
"TestScript_Action2": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"common": {
"description": "Links or references to common collection(s) of actions in this or an external TestScript instance. Action asserts SHALL be ignored for the TestScript.teardown.",
"$ref": "#/definitions/TestScript_Common"
},
"operation": {
"description": "An operation would involve a REST request to a server.",
"$ref": "#/definitions/TestScript_Operation"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"operation"
]
},
"TestScript_Common1": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"key": {
"description": "Key that identifies this common collection of actions (unique within this resource).",
"$ref": "#/definitions/id"
},
"_key": {
"description": "Extensions for key",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "The name of this this common collection of actions used for tracking/logging purposes by test engines.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A short description of this common collection of actions used by test engines for tracking and reporting purposes.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"parameter": {
"description": "Optional named parameter(s) to provide input values to this common collection of actions from this or an external TestScript.",
"items": {
"$ref": "#/definitions/TestScript_Parameter1"
},
"type": "array"
},
"action": {
"description": "An action will contain either an operation or an assertion but not both.",
"items": {
"$ref": "#/definitions/TestScript_Action3"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"action"
]
},
"TestScript_Parameter1": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "The name of this parameter that will referenced in this common collection of actions using the TestScript variable nomenclature \u0027${name}.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "An optional short description of this parameter to be used this common collection of actions used by test engines for tracking and reporting purposes.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"TestScript_Action3": {
"description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"operation": {
"description": "An operation would involve a REST request to a server.",
"$ref": "#/definitions/TestScript_Operation"
},
"assert": {
"description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"$ref": "#/definitions/TestScript_Assert"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Tue, Nov 12, 2024 03:30+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change