Skip to main content

TestScript

PropertyValue
Publisher
NameTestScript
URLhttp://hl7.org/fhir/StructureDefinition/TestScript
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
TestScript0..*TestScriptA structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
TestScript.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
TestScript.meta0..1MetaThe 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.
TestScript.implicitRules0..1uriA 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.language0..1codeThe base language in which the resource is written.
TestScript.text0..1NarrativeA 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.
TestScript.contained0..*ResourceThese 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.
TestScript.extension0..*ExtensionMay 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.
TestScript.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.url1..1uriAn 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.
TestScript.identifier0..1IdentifierA 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.
TestScript.version0..1stringThe 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.
TestScript.name1..1stringA 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.
TestScript.title0..1stringA short, descriptive, user-friendly title for the test script.
TestScript.status1..1codeThe status of this test script. Enables tracking the life-cycle of the content.
TestScript.experimental0..1booleanA 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.
TestScript.date0..1dateTimeThe 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.
TestScript.publisher0..1stringThe name of the organization or individual that published the test script.
TestScript.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
TestScript.description0..1markdownA free text natural language description of the test script from a consumer's perspective.
TestScript.useContext0..*UsageContextThe 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.
TestScript.jurisdiction0..*CodeableConceptA legal or geographic region in which the test script is intended to be used.
TestScript.purpose0..1markdownExplanation of why this test script is needed and why it has been designed as it has.
TestScript.copyright0..1markdownA 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.
TestScript.origin0..*BackboneElementAn abstract server used in operations within this test script in the origin element.
TestScript.origin.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.origin.extension0..*ExtensionMay 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 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.
TestScript.origin.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.origin.index1..1integerAbstract name given to an origin server in this test script. The name is provided as a number starting at 1.
TestScript.origin.profile1..1CodingThe type of origin profile the test system supports.
TestScript.destination0..*BackboneElementAn abstract server used in operations within this test script in the destination element.
TestScript.destination.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.destination.extension0..*ExtensionMay 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 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.
TestScript.destination.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.destination.index1..1integerAbstract name given to a destination server in this test script. The name is provided as a number starting at 1.
TestScript.destination.profile1..1CodingThe type of destination profile the test system supports.
TestScript.metadata0..1BackboneElementThe required capability must exist and are assumed to function correctly on the FHIR server being tested.
TestScript.metadata.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.metadata.extension0..*ExtensionMay 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 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.
TestScript.metadata.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.metadata.link0..*BackboneElementA link to the FHIR specification that this test is covering.
TestScript.metadata.link.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.metadata.link.extension0..*ExtensionMay 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 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.
TestScript.metadata.link.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.metadata.link.url1..1uriURL to a particular requirement or feature within the FHIR specification.
TestScript.metadata.link.description0..1stringShort description of the link.
TestScript.metadata.capability1..*BackboneElementCapabilities that must exist and are assumed to function correctly on the FHIR server being tested.
TestScript.metadata.capability.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.metadata.capability.extension0..*ExtensionMay 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 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.
TestScript.metadata.capability.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.metadata.capability.required1..1booleanWhether or not the test execution will require the given capabilities of the server in order for this test script to execute.
TestScript.metadata.capability.validated1..1booleanWhether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
TestScript.metadata.capability.description0..1stringDescription of the capabilities that this test script is requiring the server to support.
TestScript.metadata.capability.origin0..*integerWhich origin server these requirements apply to.
TestScript.metadata.capability.destination0..1integerWhich server these requirements apply to.
TestScript.metadata.capability.link0..*uriLinks to the FHIR specification that describes this interaction and the resources involved in more detail.
TestScript.metadata.capability.capabilities1..1canonicalMinimum 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.
TestScript.fixture0..*BackboneElementFixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
TestScript.fixture.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.fixture.extension0..*ExtensionMay 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 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.
TestScript.fixture.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.fixture.autocreate1..1booleanWhether 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.
TestScript.fixture.autodelete1..1booleanWhether 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.
TestScript.fixture.resource0..1ReferenceReference to the resource (containing the contents of the resource needed for operations).
TestScript.profile0..*ReferenceReference to the profile to be used for validation.
TestScript.variable0..*BackboneElementVariable is set based either on element value in response body or on header field value in the response headers.
TestScript.variable.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.variable.extension0..*ExtensionMay 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 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.
TestScript.variable.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.variable.name1..1stringDescriptive name for this variable.
TestScript.variable.defaultValue0..1stringA default, hard-coded, or user-defined value for this variable.
TestScript.variable.description0..1stringA free text natural language description of the variable and its purpose.
TestScript.variable.expression0..1stringThe FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
TestScript.variable.headerField0..1stringWill be used to grab the HTTP header field value from the headers that sourceId is pointing to.
TestScript.variable.hint0..1stringDisplayable text string with hint help information to the user when entering a default value.
TestScript.variable.path0..1stringXPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
TestScript.variable.sourceId0..1idFixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
TestScript.setup0..1BackboneElementA series of required setup operations before tests are executed.
TestScript.setup.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.setup.extension0..*ExtensionMay 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 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.
TestScript.setup.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.setup.action1..*BackboneElementAction would contain either an operation or an assertion.
TestScript.setup.action.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.setup.action.extension0..*ExtensionMay 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 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.
TestScript.setup.action.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.setup.action.operation0..1BackboneElementThe operation to perform.
TestScript.setup.action.operation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.setup.action.operation.extension0..*ExtensionMay 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 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.
TestScript.setup.action.operation.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.setup.action.operation.type0..1CodingServer interaction or operation type.
TestScript.setup.action.operation.resource0..1codeThe type of the resource. See http://build.fhir.org/resourcelist.html.
TestScript.setup.action.operation.label0..1stringThe label would be used for tracking/logging purposes by test engines.
TestScript.setup.action.operation.description0..1stringThe description would be used by test engines for tracking and reporting purposes.
TestScript.setup.action.operation.accept0..1codeThe mime-type to use for RESTful operation in the 'Accept' header.
TestScript.setup.action.operation.contentType0..1codeThe mime-type to use for RESTful operation in the 'Content-Type' header.
TestScript.setup.action.operation.destination0..1integerThe server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
TestScript.setup.action.operation.encodeRequestUrl1..1booleanWhether 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.
TestScript.setup.action.operation.method0..1codeThe HTTP method the test engine MUST use for this operation regardless of any other operation details.
TestScript.setup.action.operation.origin0..1integerThe server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
TestScript.setup.action.operation.params0..1stringPath plus parameters after [type]. Used to set parts of the request URL explicitly.
TestScript.setup.action.operation.requestHeader0..*BackboneElementHeader elements would be used to set HTTP headers.
TestScript.setup.action.operation.requestHeader.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.setup.action.operation.requestHeader.extension0..*ExtensionMay 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 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.
TestScript.setup.action.operation.requestHeader.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.setup.action.operation.requestHeader.field1..1stringThe HTTP header field e.g. "Accept".
TestScript.setup.action.operation.requestHeader.value1..1stringThe value of the header e.g. "application/fhir+xml".
TestScript.setup.action.operation.requestId0..1idThe fixture id (maybe new) to map to the request.
TestScript.setup.action.operation.responseId0..1idThe fixture id (maybe new) to map to the response.
TestScript.setup.action.operation.sourceId0..1idThe id of the fixture used as the body of a PUT or POST request.
TestScript.setup.action.operation.targetId0..1idId of fixture used for extracting the [id], [type], and [vid] for GET requests.
TestScript.setup.action.operation.url0..1stringComplete request URL.
TestScript.setup.action.assert0..1BackboneElementEvaluates the results of previous operations to determine if the server under test behaves appropriately.
TestScript.setup.action.assert.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.setup.action.assert.extension0..*ExtensionMay 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 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.
TestScript.setup.action.assert.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.setup.action.assert.label0..1stringThe label would be used for tracking/logging purposes by test engines.
TestScript.setup.action.assert.description0..1stringThe description would be used by test engines for tracking and reporting purposes.
TestScript.setup.action.assert.direction0..1codeThe direction to use for the assertion.
TestScript.setup.action.assert.compareToSourceId0..1stringId of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.
TestScript.setup.action.assert.compareToSourceExpression0..1stringThe FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
TestScript.setup.action.assert.compareToSourcePath0..1stringXPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
TestScript.setup.action.assert.contentType0..1codeThe mime-type contents to compare against the request or response message 'Content-Type' header.
TestScript.setup.action.assert.expression0..1stringThe FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.
TestScript.setup.action.assert.headerField0..1stringThe HTTP header field name e.g. 'Location'.
TestScript.setup.action.assert.minimumId0..1stringThe ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
TestScript.setup.action.assert.navigationLinks0..1booleanWhether or not the test execution performs validation on the bundle navigation links.
TestScript.setup.action.assert.operator0..1codeThe operator type defines the conditional behavior of the assert. If not defined, the default is equals.
TestScript.setup.action.assert.path0..1stringThe XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
TestScript.setup.action.assert.requestMethod0..1codeThe request method or HTTP operation code to compare against that used by the client system under test.
TestScript.setup.action.assert.requestURL0..1stringThe value to use in a comparison against the request URL path string.
TestScript.setup.action.assert.resource0..1codeThe type of the resource. See http://build.fhir.org/resourcelist.html.
TestScript.setup.action.assert.response0..1codeokay / created / noContent / notModified / bad / forbidden / notFound / methodNotAllowed / conflict / gone / preconditionFailed / unprocessable.
TestScript.setup.action.assert.responseCode0..1stringThe value of the HTTP response code to be tested.
TestScript.setup.action.assert.sourceId0..1idFixture to evaluate the XPath/JSONPath expression or the headerField against.
TestScript.setup.action.assert.validateProfileId0..1idThe ID of the Profile to validate against.
TestScript.setup.action.assert.value0..1stringThe value to compare to.
TestScript.setup.action.assert.warningOnly1..1booleanWhether or not the test execution will produce a warning only on error for this assert.
TestScript.test0..*BackboneElementA test in this script.
TestScript.test.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.test.extension0..*ExtensionMay 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 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.
TestScript.test.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.test.name0..1stringThe name of this test used for tracking/logging purposes by test engines.
TestScript.test.description0..1stringA short description of the test used by test engines for tracking and reporting purposes.
TestScript.test.action1..*BackboneElementAction would contain either an operation or an assertion.
TestScript.test.action.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.test.action.extension0..*ExtensionMay 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 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.
TestScript.test.action.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.test.action.operation0..1TestScriptAn operation would involve a REST request to a server.
TestScript.test.action.assert0..1TestScriptEvaluates the results of previous operations to determine if the server under test behaves appropriately.
TestScript.teardown0..1BackboneElementA series of operations required to clean up after all the tests are executed (successfully or otherwise).
TestScript.teardown.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.teardown.extension0..*ExtensionMay 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 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.
TestScript.teardown.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.teardown.action1..*BackboneElementThe teardown action will only contain an operation.
TestScript.teardown.action.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TestScript.teardown.action.extension0..*ExtensionMay 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 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.
TestScript.teardown.action.modifierExtension0..*ExtensionMay 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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
TestScript.teardown.action.operation1..1TestScriptAn operation would involve a REST request to a server.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
contexttokenA use context assigned to the test script(TestScript.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the test script(TestScript.useContext.value.ofType(Quantity)) / (TestScript.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the test scriptTestScript.useContext.code
datedateThe test script publication dateTestScript.date
descriptionstringThe description of the test scriptTestScript.description
identifiertokenExternal identifier for the test scriptTestScript.identifier
jurisdictiontokenIntended jurisdiction for the test scriptTestScript.jurisdiction
namestringComputationally friendly name of the test scriptTestScript.name
publisherstringName of the publisher of the test scriptTestScript.publisher
statustokenThe current status of the test scriptTestScript.status
testscript-capabilitystringTestScript required and validated capabilityTestScript.metadata.capability.description
titlestringThe human-friendly name of the test scriptTestScript.title
urluriThe uri that identifies the test scriptTestScript.url
versiontokenThe business version of the test scriptTestScript.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the test scriptTestScript.useContext
context-type-valuecompositeA use context type and value assigned to the test scriptTestScript.useContext