Touchstone FHIR Testing
2.0.0 - current
Touchstone FHIR Testing v2.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Active as of 2023-06-29 |
Definitions for the testscript resource profile.
Guidance on how to interpret the contents of this table can be found here
0. TestScript | |
Definition | Defines constraints and extensions on the TestScript resource for use in the Touchstone Testing Platform. |
Short | Touchstone Testing TestScript Profile |
Is Modifier | false |
Must Support | false |
2. TestScript.extension:testscript-dynamic-fixture | |
Slice Name | testscript-dynamic-fixture |
Control | 0..* |
Type | Extension(AEGIS Touchstone Testing TestScript Dynamic Fixture Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
4. TestScript.extension:testscript-rule | |
Slice Name | testscript-rule |
Control | 0..* |
Type | Extension(AEGIS Touchstone Testing TestScript Rule Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
6. TestScript.extension:testscript-ruleset | |
Slice Name | testscript-ruleset |
Control | 0..* |
Type | Extension(AEGIS Touchstone Testing TestScript Ruleset Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
8. TestScript.origin | |
Control | 0..* |
Type | BackboneElement |
10. TestScript.origin.profile | |
Definition | The type of origin profile the test system supports. |
Short | FHIR-Client | FHIR-SDC-FormFiller | CDSH-Client | HL7V2-Client | HL7V3-Client |
Comments | Must be a "sender"/"client" profile. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Profile Origin Types ValueSet: The type of origin profile the test system supports. |
Type | Coding |
12. TestScript.destination | |
Control | 0..* |
Type | BackboneElement |
14. TestScript.destination.profile | |
Definition | The type of destination profile the test system supports. |
Short | FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor | CDSH-Server | HL7V2-Server | HL7V3-Server |
Comments | Must be a "receiver"/"server" profile. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Profile Destination Types ValueSet: The type of destination profile the test system supports. |
Type | Coding |
16. TestScript.variable | |
18. TestScript.variable.extension:testscript-variable-paramField | |
Slice Name | testscript-variable-paramField |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Variable ParamField Extension) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
20. TestScript.setup | |
22. TestScript.setup.extension:testscript-test-manualCompletion | |
Slice Name | testscript-test-manualCompletion |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Test Manual Completion Extension) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
24. TestScript.setup.action | |
26. TestScript.setup.action.operation | |
Control | 0..1 |
Type | BackboneElement |
Invariants | ttt-0: HL7 V2 setup operation SHALL NOT contain resource or accept or contentType or method or params or requestHeader or targetId. (type.code.empty() or type.code != 'hl7v2' or (resource.count() + accept.count() + contentType.count() + method.count() + params.count() + requestHeader.field.count() + requestHeader.value.count() + targetId.count() = 0) )ttt-1: HL7 V3 setup operation SHALL NOT contain resource or targetId. ( type.code.empty() or type.code != 'hl7v3' or (resource.count() + targetId.count() = 0) ) |
28. TestScript.setup.action.operation.id | |
Control | 0..1 |
XML Format | In the XML format, this property is represented as an attribute. |
30. TestScript.setup.action.operation.extension:testscript-operation-authorizeInNewTab | |
Slice Name | testscript-operation-authorizeInNewTab |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation AuthorizeInNewTab Extension) (Extension Type: boolean) |
Is Modifier | false |
Must Support | true |
32. TestScript.setup.action.operation.extension:testscript-operation-oauth2AuthzRedirectId | |
Slice Name | testscript-operation-oauth2AuthzRedirectId |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation Oauth2AuthzRedirectId Extension) (Extension Type: id) |
Is Modifier | false |
Must Support | true |
34. TestScript.setup.action.operation.extension:testscript-operation-oauth2AuthzRequestId | |
Slice Name | testscript-operation-oauth2AuthzRequestId |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation Oauth2AuthzRequestId Extension) (Extension Type: id) |
Is Modifier | false |
Must Support | true |
36. TestScript.setup.action.operation.extension:testscript-operation-pagesNext | |
Slice Name | testscript-operation-pagesNext |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation pagesNext Extension) (Extension Type: positiveInt) |
Is Modifier | false |
Must Support | true |
38. TestScript.setup.action.operation.extension:testscript-operation-protocol | |
Slice Name | testscript-operation-protocol |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation protocol Extension) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
40. TestScript.setup.action.operation.extension:testscript-operation-smartLaunchRequestId | |
Slice Name | testscript-operation-smartLaunchRequestId |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation SmartLaunchRequestId Extension) (Extension Type: id) |
Is Modifier | false |
Must Support | true |
42. TestScript.setup.action.operation.type | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Operation Codes ValueSet: The allowable operation code types. |
Type | Coding |
44. TestScript.setup.action.assert | |
46. TestScript.setup.action.assert.extension:testscript-assert-rule | |
Slice Name | testscript-assert-rule |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Rule Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
48. TestScript.setup.action.assert.extension:testscript-assert-ruleset | |
Slice Name | testscript-assert-ruleset |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Ruleset Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
50. TestScript.setup.action.assert.extension:testscript-assert-stopTestOnFail | |
Slice Name | testscript-assert-stopTestOnFail |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Stop Test On Error Extension) (Extension Type: boolean) |
Is Modifier | false |
Must Support | true |
52. TestScript.setup.action.assert.extension:testscript-assert-variable | |
Slice Name | testscript-assert-variable |
Control | 0..1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Variable Extension) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
54. TestScript.test | |
56. TestScript.test.action | |
58. TestScript.test.action.operation | |
Invariants | ttt-2: HL7 V2 test operation SHALL NOT contain resource or accept or contentType or method or params or requestHeader or targetId. (type.code.empty() or type.code != 'hl7v2' or (resource.count() + accept.count() + contentType.count() + method.count() + params.count() + requestHeader.field.count() + requestHeader.value.count() + targetId.count() = 0) )ttt-3: HL7 V3 test operation SHALL NOT contain resource or targetId. ( type.code.empty() or type.code != 'hl7v3' or (resource.count() + targetId.count() = 0) ) |
Guidance on how to interpret the contents of this table can be found here
0. TestScript | |
Definition | Defines constraints and extensions on the TestScript resource for use in the Touchstone Testing Platform. A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. |
Short | Touchstone Testing TestScript ProfileDescribes a set of tests |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) tst-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ( name.matches('[A-Z]([A-Za-z0-9_]){0,254}') )tst-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}')) |
2. TestScript.implicitRules | |
Definition | 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. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. TestScript.extension:testscript-dynamic-fixture | |
Slice Name | testscript-dynamic-fixture |
Definition | TestScript dynamic-fixture definition used by the Test Engine to dynamically prompt for a fixture' contents. |
Short | Dynamic fixture used within the test script |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Dynamic Fixture Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
6. TestScript.extension:testscript-rule | |
Slice Name | testscript-rule |
Definition | TestScript rule definition used as asserts within the TestScript. The rule must define the external reference to the executable rule script file. |
Short | Assert rule used within the test script |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Rule Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
8. TestScript.extension:testscript-ruleset | |
Slice Name | testscript-ruleset |
Definition | TestScript ruleset definition used as asserts within the TestScript. The rule must define the external reference to the ruleset structure file. |
Short | Assert ruleset used within the test script |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Ruleset Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
10. TestScript.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. TestScript.url | |
Definition | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers. |
Short | Canonical identifier for this test script, represented as a URI (globally unique) |
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the test script to be referenced by a single globally unique identifier. |
Alternate Names | url, authoritative-url, destination, identity |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. TestScript.name | |
Definition | 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. |
Short | Name for this test script (computer friendly) |
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
Control | 1..1 This element is affected by the following invariants: inv-0 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Support human navigation and code generation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. TestScript.status | |
Definition | The status of this test script. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Comments | Allows filtering of test scripts that are appropriate for use versus not. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 The lifecycle status of an artifact. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. TestScript.origin | |
Definition | An abstract server used in operations within this test script in the origin element. |
Short | An abstract server representing a client or sender in a message exchange |
Comments | The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. TestScript.origin.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
22. TestScript.origin.index | |
Definition | Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. |
Short | The index of the abstract origin server starting at 1 |
Comments | A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration). Different origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler). The origin indices provided elsewhere in the test script must be one of these origin indices. |
Control | 1..1 |
Type | integer |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. TestScript.origin.profile | |
Definition | The type of origin profile the test system supports. |
Short | FHIR-Client | FHIR-SDC-FormFiller | CDSH-Client | HL7V2-Client | HL7V3-Client |
Comments | Must be a "sender"/"client" profile. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Profile Origin Types ValueSethttp://hl7.org/fhir/ValueSet/testscript-profile-origin-types The type of origin profile the test system supports. |
Type | Coding |
Is Modifier | false |
Summary | false |
Meaning if Missing | FHIR-Client |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. TestScript.destination | |
Definition | An abstract server used in operations within this test script in the destination element. |
Short | An abstract server representing a destination or receiver in a message exchange |
Comments | The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. TestScript.destination.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
30. TestScript.destination.index | |
Definition | Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. |
Short | The index of the abstract destination server starting at 1 |
Comments | A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration). Different destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager). The destination indices provided elsewhere in the test script must be one of these destination indices. |
Control | 1..1 |
Type | integer |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. TestScript.destination.profile | |
Definition | The type of destination profile the test system supports. |
Short | FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor | CDSH-Server | HL7V2-Server | HL7V3-Server |
Comments | Must be a "receiver"/"server" profile. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Profile Destination Types ValueSethttp://hl7.org/fhir/ValueSet/testscript-profile-destination-types The type of destination profile the test system supports. |
Type | Coding |
Is Modifier | false |
Summary | false |
Meaning if Missing | FHIR-Server |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. TestScript.variable | |
Definition | Variable is set based either on element value in response body or on header field value in the response headers. |
Short | Placeholder for evaluated elements |
Comments | Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tst-3: Variable can only contain one of expression, headerField or path. ( expression.empty() or headerField.empty() or path.empty() )tst-3: Variable can only contain one of expression, headerField or path. (expression.empty() or headerField.empty() or path.empty()) |
36. TestScript.variable.extension:testscript-variable-paramField | |
Slice Name | testscript-variable-paramField |
Definition | TestScript fixture firstUsage definition used as asserts within the TestScript. The firstUsage boolean defines whether this is the first time the referenced fixture is used. |
Short | Fixture firstUsage used within the test script |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Variable ParamField Extension) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
38. TestScript.variable.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
40. TestScript.variable.name | |
Definition | Descriptive name for this variable. |
Short | Descriptive name for this variable |
Comments | Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed. |
Control | 1..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. TestScript.setup | |
Definition | A series of required setup operations before tests are executed. |
Short | A series of required setup operations before tests are executed |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. TestScript.setup.extension:testscript-test-manualCompletion | |
Slice Name | testscript-test-manualCompletion |
Definition | TestScript test manualCompletion definition used within the TestScript. The manualCompletion defines an override of the default behavior of the TestScript.test execution. |
Short | Override the default behavior of the TestScript.test execution |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Test Manual Completion Extension) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
46. TestScript.setup.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
48. TestScript.setup.action | |
Definition | Action would contain either an operation or an assertion. |
Short | A setup operation or assert to perform |
Comments | An action should contain either an operation or an assertion but not both. It can contain any number of variables. |
Control | 1..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tst-1: Setup action SHALL contain either an operation or assert but not both. ( operation.exists() xor assert.exists() )tst-1: Setup action SHALL contain either an operation or assert but not both. (operation.exists() xor assert.exists()) |
50. TestScript.setup.action.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
52. TestScript.setup.action.operation | |
Definition | The operation to perform. |
Short | The setup operation to perform |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tst-7: Setup operation SHALL contain either sourceId or targetId or params or url. ( sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history')) )ttt-0: HL7 V2 setup operation SHALL NOT contain resource or accept or contentType or method or params or requestHeader or targetId. ( type.code.empty() or type.code != 'hl7v2' or (resource.count() + accept.count() + contentType.count() + method.count() + params.count() + requestHeader.field.count() + requestHeader.value.count() + targetId.count() = 0) )ttt-1: HL7 V3 setup operation SHALL NOT contain resource or targetId. ( type.code.empty() or type.code != 'hl7v3' or (resource.count() + targetId.count() = 0) )tst-7: Setup operation SHALL contain either sourceId or targetId or params or url. (sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history'))) |
54. TestScript.setup.action.operation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
56. TestScript.setup.action.operation.extension:testscript-operation-authorizeInNewTab | |
Slice Name | testscript-operation-authorizeInNewTab |
Definition | TestScript operation authorizeInNewTab definition used within the TestScript. The authorizeInNewTab defines additional behavior of the oauth2-authorization operation. If true, then OAuth2 Authorization will be done in a new tab. |
Short | Authorize in new tab for specific oauth2-authorize operation |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation AuthorizeInNewTab Extension) (Extension Type: boolean) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
58. TestScript.setup.action.operation.extension:testscript-operation-oauth2AuthzRedirectId | |
Slice Name | testscript-operation-oauth2AuthzRedirectId |
Definition | TestScript operation oauth2AuthzRedirectId definition used within the TestScript. The oauth2AuthzRedirectId defines the reference id of the oauth2-authorization operation redirect context to be used in subsequent sourceId elements. |
Short | Request id for specific oauth2-authorize operation |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation Oauth2AuthzRedirectId Extension) (Extension Type: id) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
60. TestScript.setup.action.operation.extension:testscript-operation-oauth2AuthzRequestId | |
Slice Name | testscript-operation-oauth2AuthzRequestId |
Definition | TestScript operation oauth2AuthzRequestId definition used within the TestScript. The oauth2AuthzRequestId defines the reference id of the oauth2-authorization operation request context to be used in subsequent sourceId elements. |
Short | Request id for specific oauth2-authorize operation |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation Oauth2AuthzRequestId Extension) (Extension Type: id) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
62. TestScript.setup.action.operation.extension:testscript-operation-pagesNext | |
Slice Name | testscript-operation-pagesNext |
Definition | Touchstone TestScript operation testscript-operation-pagesNext extension for use within the TestScript.setup.action.operation and TestScript.test.action.operation elements. The testscript-operation-pagesNext extension defines additional behavior of the 'history' and 'search' operations. If present, the positive integer value defines the maximum number of search pages to auto retrieve and process. This extension is only valid when used with the 'history' and 'search' operations. |
Short | The maximum number of search pages to auto retrieve and process. Only valid when used with the 'history' or 'search' operation code values. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation pagesNext Extension) (Extension Type: positiveInt) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
64. TestScript.setup.action.operation.extension:testscript-operation-protocol | |
Slice Name | testscript-operation-protocol |
Definition | Touchstone TestScript operation testscript-operation-protocol extension for use within the TestScript.setup.action.operation and TestScript.test.action.operation elements. The testscript-operation-protocol extension defines the message protocol to be used in sending or evaluating the sent operation request. If present, this protocol overrides the default protocol for the given operation.type code value. This extension is valid for all operations. |
Short | The testscript-operation-protocol extension defines the message protocol to be used in sending or evaluating the sent operation request. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation protocol Extension) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
66. TestScript.setup.action.operation.extension:testscript-operation-smartLaunchRequestId | |
Slice Name | testscript-operation-smartLaunchRequestId |
Definition | TestScript operation smartLaunchRequestId definition used within the TestScript. The smartLaunchRequestId defines the reference id of the SMART-on-FHIR launch operation request context to be used in subsequent sourceId elements. |
Short | Request id for specific oauth2-authorize operation |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Operation SmartLaunchRequestId Extension) (Extension Type: id) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
68. TestScript.setup.action.operation.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
70. TestScript.setup.action.operation.type | |
Definition | Server interaction or operation type. |
Short | The operation code type that will be executed |
Comments | See http://build.fhir.org/http.html for list of server interactions. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Operation Codes ValueSethttp://hl7.org/fhir/ValueSet/testscript-operation-codes The allowable operation code types. |
Type | Coding |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. TestScript.setup.action.operation.encodeRequestUrl | |
Definition | 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. |
Short | Whether or not to send the request url in encoded format |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. TestScript.setup.action.assert | |
Definition | Evaluates the results of previous operations to determine if the server under test behaves appropriately. |
Short | The assertion to perform |
Comments | In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine. |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tst-5: Only a single assertion SHALL be present within setup action assert element. ( extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) )tst-10: Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. ( compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists()) )tst-12: Setup action assert response and responseCode SHALL be empty when direction equals request ( (response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response' )tst-5: Only a single assertion SHALL be present within setup action assert element. (extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1)) tst-10: Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. (compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())) tst-12: Setup action assert response and responseCode SHALL be empty when direction equals request ((response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response') |
76. TestScript.setup.action.assert.extension:testscript-assert-rule | |
Slice Name | testscript-assert-rule |
Definition | TestScript assert rule definition used within TestScript asserts. The rule must reference the id of the TestScript rule extension. |
Short | Rule used within the test script assert |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Rule Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
78. TestScript.setup.action.assert.extension:testscript-assert-ruleset | |
Slice Name | testscript-assert-ruleset |
Definition | TestScript assert ruleset definition used within TestScript asserts. The ruleset must reference the id of the TestScript ruleset extension. |
Short | Ruleset used within the test script assert |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Ruleset Extension) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
80. TestScript.setup.action.assert.extension:testscript-assert-stopTestOnFail | |
Slice Name | testscript-assert-stopTestOnFail |
Definition | TestScript assert stopTestOnFail definition used within TestScript asserts. The stopTestOnFail is a boolean where true forces the current TestScript.test execution to stop and false allows subsequent actions to be evaluated if this assert produces an error. |
Short | Stop Test On Error boolean used within the test script assert |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Stop Test On Error Extension) (Extension Type: boolean) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
82. TestScript.setup.action.assert.extension:testscript-assert-variable | |
Slice Name | testscript-assert-variable |
Definition | TestScript assert variable definition used within the TestScript. The variable defines a direct comparison value to use against the value element value. |
Short | Comparison value used within the test script assert |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(AEGIS Touchstone Testing TestScript Assert Variable Extension) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
84. TestScript.setup.action.assert.modifierExtension | |
Definition | 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'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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
86. TestScript.setup.action.assert.warningOnly | |
Definition | Whether or not the test execution will produce a warning only on error for this assert. |
Short | Will this assert produce a warning only on error? |
Comments | If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. TestScript | |||||
Definition | Defines constraints and extensions on the TestScript resource for use in the Touchstone Testing Platform. | ||||
Short | Touchstone Testing TestScript Profile | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )tst-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ( name.matches('[A-Z]([A-Za-z0-9_]){0,254}') ) | ||||
2. TestScript.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. TestScript.meta | |||||
Definition | 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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. TestScript.implicitRules | |||||
Definition | 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. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. TestScript.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages: A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. TestScript.text | |||||
Definition | 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. TestScript.contained | |||||
Definition | These 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. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. TestScript.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on TestScript.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
16. TestScript.extension:testscript-dynamic-fixture | |||||
Slice Name | testscript-dynamic-fixture | ||||
Definition | TestScript dynamic-fixture definition used by the Test Engine to dynamically prompt for a fixture' contents. | ||||
Short | Dynamic fixture used within the test script | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Dynamic Fixture Extension) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. TestScript.extension:testscript-rule | |||||
Slice Name | testscript-rule | ||||
Definition | TestScript rule definition used as asserts within the TestScript. The rule must define the external reference to the executable rule script file. | ||||
Short | Assert rule used within the test script | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Rule Extension) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
20. TestScript.extension:testscript-ruleset | |||||
Slice Name | testscript-ruleset | ||||
Definition | TestScript ruleset definition used as asserts within the TestScript. The rule must define the external reference to the ruleset structure file. | ||||
Short | Assert ruleset used within the test script | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Ruleset Extension) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
22. TestScript.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
24. TestScript.url | |||||
Definition | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers. | ||||
Short | Canonical identifier for this test script, represented as a URI (globally unique) | ||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the test script to be referenced by a single globally unique identifier. | ||||
Alternate Names | url, authoritative-url, destination, identity | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. TestScript.identifier | |||||
Definition | 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. | ||||
Short | Additional identifier for the test script | ||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. TestScript.version | |||||
Definition | 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. | ||||
Short | Business version of the test script | ||||
Comments | There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version]. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. TestScript.name | |||||
Definition | 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. | ||||
Short | Name for this test script (computer friendly) | ||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||
Control | 1..1 This element is affected by the following invariants: inv-0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Support human navigation and code generation. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. TestScript.title | |||||
Definition | A short, descriptive, user-friendly title for the test script. | ||||
Short | Name for this test script (human friendly) | ||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. TestScript.status | |||||
Definition | The status of this test script. Enables tracking the life-cycle of the content. | ||||
Short | draft | active | retired | unknown | ||||
Comments | Allows filtering of test scripts that are appropriate for use versus not. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from PublicationStatus: The lifecycle status of an artifact. | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. TestScript.experimental | |||||
Definition | 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. | ||||
Short | For testing purposes, not real usage | ||||
Comments | Allows filtering of test scripts that are appropriate for use versus not. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. TestScript.date | |||||
Definition | The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes. | ||||
Short | Date last changed | ||||
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Revision Date | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. TestScript.publisher | |||||
Definition | The name of the organization or individual that published the test script. | ||||
Short | Name of the publisher (organization or individual) | ||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Helps establish the "authority/credibility" of the test script. May also allow for contact. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. TestScript.contact | |||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||
Short | Contact details for the publisher | ||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||
Control | 0..* | ||||
Type | ContactDetail | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. TestScript.description | |||||
Definition | A free text natural language description of the test script from a consumer's perspective. | ||||
Short | Natural language description of the test script | ||||
Comments | This description can be used to capture details such as why the test script was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test script as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created). | ||||
Control | 0..1 | ||||
Type | markdown | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. TestScript.useContext | |||||
Definition | 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. | ||||
Short | The context that the content is intended to support | ||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||
Control | 0..* | ||||
Type | UsageContext | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Assist in searching for appropriate content. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. TestScript.jurisdiction | |||||
Definition | A legal or geographic region in which the test script is intended to be used. | ||||
Short | Intended jurisdiction for test script (if applicable) | ||||
Comments | It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet: Countries and regions within which this artifact is targeted for use. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. TestScript.purpose | |||||
Definition | Explanation of why this test script is needed and why it has been designed as it has. | ||||
Short | Why this test script is defined | ||||
Comments | This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script. | ||||
Control | 0..1 | ||||
Type | markdown | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. TestScript.copyright | |||||
Definition | 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. | ||||
Short | Use and/or publishing restrictions | ||||
Control | 0..1 | ||||
Type | markdown | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the test script and/or its content. | ||||
Alternate Names | License, Restrictions | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. TestScript.origin | |||||
Definition | An abstract server used in operations within this test script in the origin element. | ||||
Short | An abstract server representing a client or sender in a message exchange | ||||
Comments | The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. TestScript.origin.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
58. TestScript.origin.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
60. TestScript.origin.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
62. TestScript.origin.index | |||||
Definition | Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. | ||||
Short | The index of the abstract origin server starting at 1 | ||||
Comments | A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration). | ||||
Control | 1..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
64. TestScript.origin.profile | |||||
Definition | The type of origin profile the test system supports. | ||||
Short | FHIR-Client | FHIR-SDC-FormFiller | CDSH-Client | HL7V2-Client | HL7V3-Client | ||||
Comments | Must be a "sender"/"client" profile. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Profile Origin Types ValueSet: The type of origin profile the test system supports. | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | false | ||||
Meaning if Missing | FHIR-Client | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. TestScript.destination | |||||
Definition | An abstract server used in operations within this test script in the destination element. | ||||
Short | An abstract server representing a destination or receiver in a message exchange | ||||
Comments | The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. TestScript.destination.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
70. TestScript.destination.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
72. TestScript.destination.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
74. TestScript.destination.index | |||||
Definition | Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. | ||||
Short | The index of the abstract destination server starting at 1 | ||||
Comments | A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration). | ||||
Control | 1..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
76. TestScript.destination.profile | |||||
Definition | The type of destination profile the test system supports. | ||||
Short | FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor | CDSH-Server | HL7V2-Server | HL7V3-Server | ||||
Comments | Must be a "receiver"/"server" profile. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Profile Destination Types ValueSet: The type of destination profile the test system supports. | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | false | ||||
Meaning if Missing | FHIR-Server | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
78. TestScript.metadata | |||||
Definition | The required capability must exist and are assumed to function correctly on the FHIR server being tested. | ||||
Short | Required capability that is assumed to function correctly on the FHIR server being tested | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-4: TestScript metadata capability SHALL contain required or validated or both. ( capability.required.exists() or capability.validated.exists() ) | ||||
80. TestScript.metadata.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
82. TestScript.metadata.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
84. TestScript.metadata.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
86. TestScript.metadata.link | |||||
Definition | A link to the FHIR specification that this test is covering. | ||||
Short | Links to the FHIR specification | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
88. TestScript.metadata.link.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
90. TestScript.metadata.link.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
92. TestScript.metadata.link.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
94. TestScript.metadata.link.url | |||||
Definition | URL to a particular requirement or feature within the FHIR specification. | ||||
Short | URL to the specification | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. TestScript.metadata.link.description | |||||
Definition | Short description of the link. | ||||
Short | Short description | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. TestScript.metadata.capability | |||||
Definition | Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. | ||||
Short | Capabilities that are assumed to function correctly on the FHIR server being tested | ||||
Comments | When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
100. TestScript.metadata.capability.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
102. TestScript.metadata.capability.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
104. TestScript.metadata.capability.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
106. TestScript.metadata.capability.required | |||||
Definition | Whether or not the test execution will require the given capabilities of the server in order for this test script to execute. | ||||
Short | Are the capabilities required? | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
108. TestScript.metadata.capability.validated | |||||
Definition | Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute. | ||||
Short | Are the capabilities validated? | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
110. TestScript.metadata.capability.description | |||||
Definition | Description of the capabilities that this test script is requiring the server to support. | ||||
Short | The expected capabilities of the server | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
112. TestScript.metadata.capability.origin | |||||
Definition | Which origin server these requirements apply to. | ||||
Short | Which origin server these requirements apply to | ||||
Control | 0..* | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
114. TestScript.metadata.capability.destination | |||||
Definition | Which server these requirements apply to. | ||||
Short | Which server these requirements apply to | ||||
Control | 0..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
116. TestScript.metadata.capability.link | |||||
Definition | Links to the FHIR specification that describes this interaction and the resources involved in more detail. | ||||
Short | Links to the FHIR specification | ||||
Control | 0..* | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
118. TestScript.metadata.capability.capabilities | |||||
Definition | 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. | ||||
Short | Required Capability Statement | ||||
Comments | The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element. | ||||
Control | 1..1 | ||||
Type | canonical(CapabilityStatement) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
120. TestScript.fixture | |||||
Definition | Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. | ||||
Short | Fixture in the test script - by reference (uri) | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
122. TestScript.fixture.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
124. TestScript.fixture.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
126. TestScript.fixture.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
128. TestScript.fixture.autocreate | |||||
Definition | 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. | ||||
Short | Whether or not to implicitly create the fixture during setup | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
130. TestScript.fixture.autodelete | |||||
Definition | 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. | ||||
Short | Whether or not to implicitly delete the fixture during teardown | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
132. TestScript.fixture.resource | |||||
Definition | Reference to the resource (containing the contents of the resource needed for operations). | ||||
Short | Reference of the resource | ||||
Comments | See http://build.fhir.org/resourcelist.html for complete list of resource types. | ||||
Control | 0..1 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
134. TestScript.profile | |||||
Definition | Reference to the profile to be used for validation. | ||||
Short | Reference of the validation profile | ||||
Comments | See http://build.fhir.org/resourcelist.html for complete list of resource types. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
136. TestScript.variable | |||||
Definition | Variable is set based either on element value in response body or on header field value in the response headers. | ||||
Short | Placeholder for evaluated elements | ||||
Comments | Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. This limits the places that test engines would need to look for placeholders "${}". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in "operation.params", "operation.requestHeader.value", and "operation.url" element values during operation calls and in "assert.value" during assertion evaluations. See example testscript-search.xml. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-3: Variable can only contain one of expression, headerField or path. ( expression.empty() or headerField.empty() or path.empty() ) | ||||
138. TestScript.variable.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
140. TestScript.variable.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on TestScript.variable.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
142. TestScript.variable.extension:testscript-variable-paramField | |||||
Slice Name | testscript-variable-paramField | ||||
Definition | TestScript fixture firstUsage definition used as asserts within the TestScript. The firstUsage boolean defines whether this is the first time the referenced fixture is used. | ||||
Short | Fixture firstUsage used within the test script | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Variable ParamField Extension) (Extension Type: string) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
144. TestScript.variable.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
146. TestScript.variable.name | |||||
Definition | Descriptive name for this variable. | ||||
Short | Descriptive name for this variable | ||||
Comments | Placeholders would contain the variable name wrapped in ${} in "operation.params", "operation.requestHeader.value", and "operation.url" elements. These placeholders would need to be replaced by the variable value before the operation is executed. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
148. TestScript.variable.defaultValue | |||||
Definition | A default, hard-coded, or user-defined value for this variable. | ||||
Short | Default, hard-coded, or user-defined value for this variable | ||||
Comments | The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
150. TestScript.variable.description | |||||
Definition | A free text natural language description of the variable and its purpose. | ||||
Short | Natural language description of the variable | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
152. TestScript.variable.expression | |||||
Definition | The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. | ||||
Short | The FHIRPath expression against the fixture body | ||||
Comments | If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
154. TestScript.variable.headerField | |||||
Definition | Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. | ||||
Short | HTTP header field name for source | ||||
Comments | If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
156. TestScript.variable.hint | |||||
Definition | Displayable text string with hint help information to the user when entering a default value. | ||||
Short | Hint help text for default value to enter | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
158. TestScript.variable.path | |||||
Definition | XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. | ||||
Short | XPath or JSONPath against the fixture body | ||||
Comments | If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
160. TestScript.variable.sourceId | |||||
Definition | Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. | ||||
Short | Fixture Id of source expression or headerField within this variable | ||||
Comments | This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
162. TestScript.setup | |||||
Definition | A series of required setup operations before tests are executed. | ||||
Short | A series of required setup operations before tests are executed | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
164. TestScript.setup.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
166. TestScript.setup.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on TestScript.setup.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
168. TestScript.setup.extension:testscript-test-manualCompletion | |||||
Slice Name | testscript-test-manualCompletion | ||||
Definition | TestScript test manualCompletion definition used within the TestScript. The manualCompletion defines an override of the default behavior of the TestScript.test execution. | ||||
Short | Override the default behavior of the TestScript.test execution | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Test Manual Completion Extension) (Extension Type: code) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
170. TestScript.setup.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
172. TestScript.setup.action | |||||
Definition | Action would contain either an operation or an assertion. | ||||
Short | A setup operation or assert to perform | ||||
Comments | An action should contain either an operation or an assertion but not both. It can contain any number of variables. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-1: Setup action SHALL contain either an operation or assert but not both. ( operation.exists() xor assert.exists() ) | ||||
174. TestScript.setup.action.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
176. TestScript.setup.action.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
178. TestScript.setup.action.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
180. TestScript.setup.action.operation | |||||
Definition | The operation to perform. | ||||
Short | The setup operation to perform | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-7: Setup operation SHALL contain either sourceId or targetId or params or url. ( sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history')) )ttt-0: HL7 V2 setup operation SHALL NOT contain resource or accept or contentType or method or params or requestHeader or targetId. ( type.code.empty() or type.code != 'hl7v2' or (resource.count() + accept.count() + contentType.count() + method.count() + params.count() + requestHeader.field.count() + requestHeader.value.count() + targetId.count() = 0) )ttt-1: HL7 V3 setup operation SHALL NOT contain resource or targetId. ( type.code.empty() or type.code != 'hl7v3' or (resource.count() + targetId.count() = 0) ) | ||||
182. TestScript.setup.action.operation.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
184. TestScript.setup.action.operation.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on TestScript.setup.action.operation.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
186. TestScript.setup.action.operation.extension:testscript-operation-authorizeInNewTab | |||||
Slice Name | testscript-operation-authorizeInNewTab | ||||
Definition | TestScript operation authorizeInNewTab definition used within the TestScript. The authorizeInNewTab defines additional behavior of the oauth2-authorization operation. If true, then OAuth2 Authorization will be done in a new tab. | ||||
Short | Authorize in new tab for specific oauth2-authorize operation | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Operation AuthorizeInNewTab Extension) (Extension Type: boolean) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
188. TestScript.setup.action.operation.extension:testscript-operation-oauth2AuthzRedirectId | |||||
Slice Name | testscript-operation-oauth2AuthzRedirectId | ||||
Definition | TestScript operation oauth2AuthzRedirectId definition used within the TestScript. The oauth2AuthzRedirectId defines the reference id of the oauth2-authorization operation redirect context to be used in subsequent sourceId elements. | ||||
Short | Request id for specific oauth2-authorize operation | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Operation Oauth2AuthzRedirectId Extension) (Extension Type: id) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
190. TestScript.setup.action.operation.extension:testscript-operation-oauth2AuthzRequestId | |||||
Slice Name | testscript-operation-oauth2AuthzRequestId | ||||
Definition | TestScript operation oauth2AuthzRequestId definition used within the TestScript. The oauth2AuthzRequestId defines the reference id of the oauth2-authorization operation request context to be used in subsequent sourceId elements. | ||||
Short | Request id for specific oauth2-authorize operation | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Operation Oauth2AuthzRequestId Extension) (Extension Type: id) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
192. TestScript.setup.action.operation.extension:testscript-operation-pagesNext | |||||
Slice Name | testscript-operation-pagesNext | ||||
Definition | Touchstone TestScript operation testscript-operation-pagesNext extension for use within the TestScript.setup.action.operation and TestScript.test.action.operation elements. The testscript-operation-pagesNext extension defines additional behavior of the 'history' and 'search' operations. If present, the positive integer value defines the maximum number of search pages to auto retrieve and process. This extension is only valid when used with the 'history' and 'search' operations. | ||||
Short | The maximum number of search pages to auto retrieve and process. Only valid when used with the 'history' or 'search' operation code values. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Operation pagesNext Extension) (Extension Type: positiveInt) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
194. TestScript.setup.action.operation.extension:testscript-operation-protocol | |||||
Slice Name | testscript-operation-protocol | ||||
Definition | Touchstone TestScript operation testscript-operation-protocol extension for use within the TestScript.setup.action.operation and TestScript.test.action.operation elements. The testscript-operation-protocol extension defines the message protocol to be used in sending or evaluating the sent operation request. If present, this protocol overrides the default protocol for the given operation.type code value. This extension is valid for all operations. | ||||
Short | The testscript-operation-protocol extension defines the message protocol to be used in sending or evaluating the sent operation request. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Operation protocol Extension) (Extension Type: code) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
196. TestScript.setup.action.operation.extension:testscript-operation-smartLaunchRequestId | |||||
Slice Name | testscript-operation-smartLaunchRequestId | ||||
Definition | TestScript operation smartLaunchRequestId definition used within the TestScript. The smartLaunchRequestId defines the reference id of the SMART-on-FHIR launch operation request context to be used in subsequent sourceId elements. | ||||
Short | Request id for specific oauth2-authorize operation | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Operation SmartLaunchRequestId Extension) (Extension Type: id) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
198. TestScript.setup.action.operation.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
200. TestScript.setup.action.operation.type | |||||
Definition | Server interaction or operation type. | ||||
Short | The operation code type that will be executed | ||||
Comments | See http://build.fhir.org/http.html for list of server interactions. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from AEGIS Touchstone Testing TestScript TestScript Operation Codes ValueSet: The allowable operation code types. | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
202. TestScript.setup.action.operation.resource | |||||
Definition | The type of the resource. See http://build.fhir.org/resourcelist.html. | ||||
Short | Resource type | ||||
Comments | If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from FHIRDefinedType: A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
204. TestScript.setup.action.operation.label | |||||
Definition | The label would be used for tracking/logging purposes by test engines. | ||||
Short | Tracking/logging operation label | ||||
Comments | This has no impact on the verification itself. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
206. TestScript.setup.action.operation.description | |||||
Definition | The description would be used by test engines for tracking and reporting purposes. | ||||
Short | Tracking/reporting operation description | ||||
Comments | This has no impact on the verification itself. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
208. TestScript.setup.action.operation.accept | |||||
Definition | The mime-type to use for RESTful operation in the 'Accept' header. | ||||
Short | Mime type to accept in the payload of the response, with charset etc. | ||||
Comments | If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Mime Types: The mime type of an attachment. Any valid mime type is allowed. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Example | <br/><b>General</b>:application/fhir+xml | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
210. TestScript.setup.action.operation.contentType | |||||
Definition | The mime-type to use for RESTful operation in the 'Content-Type' header. | ||||
Short | Mime type of the request payload contents, with charset etc. | ||||
Comments | If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Mime Types: The mime type of an attachment. Any valid mime type is allowed. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Example | <br/><b>General</b>:application/fhir+xml | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
212. TestScript.setup.action.operation.destination | |||||
Definition | The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. | ||||
Short | Server responding to the request | ||||
Comments | If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange. | ||||
Control | 0..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
214. TestScript.setup.action.operation.encodeRequestUrl | |||||
Definition | 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. | ||||
Short | Whether or not to send the request url in encoded format | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
216. TestScript.setup.action.operation.method | |||||
Definition | The HTTP method the test engine MUST use for this operation regardless of any other operation details. | ||||
Short | delete | get | options | patch | post | put | head | ||||
Comments | The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from TestScriptRequestMethodCode: The allowable request method or HTTP operation codes. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
218. TestScript.setup.action.operation.origin | |||||
Definition | The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. | ||||
Short | Server initiating the request | ||||
Comments | If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server. | ||||
Control | 0..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
220. TestScript.setup.action.operation.params | |||||
Definition | Path plus parameters after [type]. Used to set parts of the request URL explicitly. | ||||
Short | Explicitly defined path parameters | ||||
Comments | If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. Test engines would append whatever is specified for "params" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The "params" element does not correspond exactly to "search parameters". Nor is it the "path". It corresponds to the part of the URL that comes after the [type] (when "resource" element is specified); e.g. It corresponds to "/[id]/_history/[vid] {?_format=[mime-type]}" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
222. TestScript.setup.action.operation.requestHeader | |||||
Definition | Header elements would be used to set HTTP headers. | ||||
Short | Each operation can have one or more header elements | ||||
Comments | This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - "If-Modified-Since" and "If-None-Match" headers. See http://build.fhir.org/http.html#2.1.0.5.1 - "If-Match" header. See http://build.fhir.org/http.html#2.1.0.11 - Conditional Create using "If-None-Exist". See http://build.fhir.org/http.html#2.1.0.13.1 - Invalid "Content-Type" header for negative testing. - etc. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
224. TestScript.setup.action.operation.requestHeader.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
226. TestScript.setup.action.operation.requestHeader.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
228. TestScript.setup.action.operation.requestHeader.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
230. TestScript.setup.action.operation.requestHeader.field | |||||
Definition | The HTTP header field e.g. "Accept". | ||||
Short | HTTP header field name | ||||
Comments | If header element is specified, then field is required. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
232. TestScript.setup.action.operation.requestHeader.value | |||||
Definition | The value of the header e.g. "application/fhir+xml". | ||||
Short | HTTP headerfield value | ||||
Comments | If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
234. TestScript.setup.action.operation.requestId | |||||
Definition | The fixture id (maybe new) to map to the request. | ||||
Short | Fixture Id of mapped request | ||||
Comments | If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "requestId". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
236. TestScript.setup.action.operation.responseId | |||||
Definition | The fixture id (maybe new) to map to the response. | ||||
Short | Fixture Id of mapped response | ||||
Comments | If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by "responseId". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
238. TestScript.setup.action.operation.sourceId | |||||
Definition | The id of the fixture used as the body of a PUT or POST request. | ||||
Short | Fixture Id of body for PUT and POST requests | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
240. TestScript.setup.action.operation.targetId | |||||
Definition | Id of fixture used for extracting the [id], [type], and [vid] for GET requests. | ||||
Short | Id of fixture used for extracting the [id], [type], and [vid] for GET requests | ||||
Comments | If "url" element is specified, then "targetId", "params", and "resource" elements will be ignored as "url" element will have everything needed for constructing the request url. If "params" element is specified, then "targetId" element is ignored. For FHIR operations that require a resource (e.g. "read" and "vread" operations), the "resource" element must be specified when "params" element is specified. If "url" and "params" elements are absent, then the request url will be constructed from "targetId" fixture if present. For "read" operation, the resource and id values will be extracted from "targetId" fixture and used to construct the url. For "vread" and "history" operations, the versionId value will also be used. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
242. TestScript.setup.action.operation.url | |||||
Definition | Complete request URL. | ||||
Short | Request URL | ||||
Comments | Used to set the request URL explicitly. If "url" element is defined, then "targetId", "resource", and "params" elements will be ignored. Test engines would use whatever is specified in "url" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
244. TestScript.setup.action.assert | |||||
Definition | Evaluates the results of previous operations to determine if the server under test behaves appropriately. | ||||
Short | The assertion to perform | ||||
Comments | In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-5: Only a single assertion SHALL be present within setup action assert element. ( extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) )tst-10: Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. ( compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists()) )tst-12: Setup action assert response and responseCode SHALL be empty when direction equals request ( (response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response' ) | ||||
246. TestScript.setup.action.assert.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
248. TestScript.setup.action.assert.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on TestScript.setup.action.assert.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
250. TestScript.setup.action.assert.extension:testscript-assert-rule | |||||
Slice Name | testscript-assert-rule | ||||
Definition | TestScript assert rule definition used within TestScript asserts. The rule must reference the id of the TestScript rule extension. | ||||
Short | Rule used within the test script assert | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Assert Rule Extension) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
252. TestScript.setup.action.assert.extension:testscript-assert-ruleset | |||||
Slice Name | testscript-assert-ruleset | ||||
Definition | TestScript assert ruleset definition used within TestScript asserts. The ruleset must reference the id of the TestScript ruleset extension. | ||||
Short | Ruleset used within the test script assert | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Assert Ruleset Extension) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
254. TestScript.setup.action.assert.extension:testscript-assert-stopTestOnFail | |||||
Slice Name | testscript-assert-stopTestOnFail | ||||
Definition | TestScript assert stopTestOnFail definition used within TestScript asserts. The stopTestOnFail is a boolean where true forces the current TestScript.test execution to stop and false allows subsequent actions to be evaluated if this assert produces an error. | ||||
Short | Stop Test On Error boolean used within the test script assert | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Assert Stop Test On Error Extension) (Extension Type: boolean) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
256. TestScript.setup.action.assert.extension:testscript-assert-variable | |||||
Slice Name | testscript-assert-variable | ||||
Definition | TestScript assert variable definition used within the TestScript. The variable defines a direct comparison value to use against the value element value. | ||||
Short | Comparison value used within the test script assert | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AEGIS Touchstone Testing TestScript Assert Variable Extension) (Extension Type: string) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
258. TestScript.setup.action.assert.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
260. TestScript.setup.action.assert.label | |||||
Definition | The label would be used for tracking/logging purposes by test engines. | ||||
Short | Tracking/logging assertion label | ||||
Comments | This has no impact on the verification itself. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
262. TestScript.setup.action.assert.description | |||||
Definition | The description would be used by test engines for tracking and reporting purposes. | ||||
Short | Tracking/reporting assertion description | ||||
Comments | This has no impact on the verification itself. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
264. TestScript.setup.action.assert.direction | |||||
Definition | The direction to use for the assertion. | ||||
Short | response | request | ||||
Comments | If the direction is specified as "response" (the default), then the processing of this assert is against the received response message. If the direction is specified as "request", then the processing of this assert is against the sent request message. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AssertionDirectionType: The type of direction to use for assertion. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
266. TestScript.setup.action.assert.compareToSourceId | |||||
Definition | Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition. | ||||
Short | Id of the source fixture to be evaluated | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
268. TestScript.setup.action.assert.compareToSourceExpression | |||||
Definition | The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. | ||||
Short | The FHIRPath expression to evaluate against the source fixture | ||||
Comments | Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
270. TestScript.setup.action.assert.compareToSourcePath | |||||
Definition | XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. | ||||
Short | XPath or JSONPath expression to evaluate against the source fixture | ||||
Comments | The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if "assert.value" is used. The evaluation will be done before the assertion is evaluated. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
272. TestScript.setup.action.assert.contentType | |||||
Definition | The mime-type contents to compare against the request or response message 'Content-Type' header. | ||||
Short | Mime type to compare against the 'Content-Type' header | ||||
Comments | If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If "assert.sourceId" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Mime Types: The mime type of an attachment. Any valid mime type is allowed. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Example | <br/><b>General</b>:application/fhir+xml | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
274. TestScript.setup.action.assert.expression | |||||
Definition | The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. | ||||
Short | The FHIRPath expression to be evaluated | ||||
Comments | If both "expression" and a "fixtureId" are specified, then the expression will be evaluated against the request or response body mapped to the fixtureId. If "expression" is specified and a "fixtureId" is not, then the expression will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
276. TestScript.setup.action.assert.headerField | |||||
Definition | The HTTP header field name e.g. 'Location'. | ||||
Short | HTTP header field name | ||||
Comments | If "headerField" is specified then "value" must be specified. If "sourceId" is not specified, then "headerField" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
278. TestScript.setup.action.assert.minimumId | |||||
Definition | The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. | ||||
Short | Fixture Id of minimum content resource | ||||
Comments | Asserts that the response contains all the element/content in another fixture pointed to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
280. TestScript.setup.action.assert.navigationLinks | |||||
Definition | Whether or not the test execution performs validation on the bundle navigation links. | ||||
Short | Perform validation on navigation links? | ||||
Comments | Asserts that the Bundle contains first, last, and next links. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
282. TestScript.setup.action.assert.operator | |||||
Definition | The operator type defines the conditional behavior of the assert. If not defined, the default is equals. | ||||
Short | equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | ||||
Comments | Operators are useful especially for negative testing. If operator is not specified, then the "equals" operator is assumed; e.g. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AssertionOperatorType: The type of operator to use for assertion. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
284. TestScript.setup.action.assert.path | |||||
Definition | The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. | ||||
Short | XPath or JSONPath expression | ||||
Comments | If both "path" and a "fixtureId" are specified, then the path will be evaluated against the request or response body mapped to the fixtureId. If "path" is specified and a "fixtureId" is not, then the path will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
286. TestScript.setup.action.assert.requestMethod | |||||
Definition | The request method or HTTP operation code to compare against that used by the client system under test. | ||||
Short | delete | get | options | patch | post | put | head | ||||
Comments | If "requestMethod" is specified then it will be used in place of "value". The "requestMethod" will evaluate against the last operation's request HTTP operation. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from TestScriptRequestMethodCode: The allowable request method or HTTP operation codes. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
288. TestScript.setup.action.assert.requestURL | |||||
Definition | The value to use in a comparison against the request URL path string. | ||||
Short | Request URL comparison value | ||||
Comments | If "requestURL" is specified then it will be used in place of "value". The "requestURL" will evaluate against the last operation's full request URL path string. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
290. TestScript.setup.action.assert.resource | |||||
Definition | The type of the resource. See http://build.fhir.org/resourcelist.html. | ||||
Short | Resource type | ||||
Comments | This will be expected resource type in response body e.g. in read, vread, search, etc. See http://build.fhir.org/resourcelist.html for complete list of resource types; e.g. <assert > <resourceType value="Patient" </assert>. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from FHIRDefinedType: A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
292. TestScript.setup.action.assert.response | |||||
Definition | okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable. | ||||
Short | okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable | ||||
Comments | This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. <assert> <contentType value="json" /> <response value="okay"/> </assert>. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AssertionResponseTypes: The type of response code to use for assertion. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
294. TestScript.setup.action.assert.responseCode | |||||
Definition | The value of the HTTP response code to be tested. | ||||
Short | HTTP response code to test | ||||
Comments | To be used with "operator" attribute value. Asserts that the response code equals this value if "operator" is not specified. If the operator is "in" or "notIn" then the responseCode would be a comma-separated list of values e.g. "200,201". Otherwise, it's expected to be a numeric value. If "fixture" is not specified, then the "responseBodyId" value of the last operation is assumed. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
296. TestScript.setup.action.assert.sourceId | |||||
Definition | Fixture to evaluate the XPath/JSONPath expression or the headerField against. | ||||
Short | Fixture Id of source expression or headerField | ||||
Comments | This can be a statically defined fixture (at the top of the testscript) or a dynamically set fixture created by responseId of the action.operation element. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
298. TestScript.setup.action.assert.validateProfileId | |||||
Definition | The ID of the Profile to validate against. | ||||
Short | Profile Id of validation profile reference | ||||
Comments | The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
300. TestScript.setup.action.assert.value | |||||
Definition | The value to compare to. | ||||
Short | The value to compare to | ||||
Comments | The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
302. TestScript.setup.action.assert.warningOnly | |||||
Definition | Whether or not the test execution will produce a warning only on error for this assert. | ||||
Short | Will this assert produce a warning only on error? | ||||
Comments | If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning. | ||||
Control | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
304. TestScript.test | |||||
Definition | A test in this script. | ||||
Short | A test in this script | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
306. TestScript.test.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
308. TestScript.test.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
310. TestScript.test.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
312. TestScript.test.name | |||||
Definition | The name of this test used for tracking/logging purposes by test engines. | ||||
Short | Tracking/logging name of this test | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
314. TestScript.test.description | |||||
Definition | A short description of the test used by test engines for tracking and reporting purposes. | ||||
Short | Tracking/reporting short description of the test | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
316. TestScript.test.action | |||||
Definition | Action would contain either an operation or an assertion. | ||||
Short | A test operation or assert to perform | ||||
Comments | An action should contain either an operation or an assertion but not both. It can contain any number of variables. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-2: Test action SHALL contain either an operation or assert but not both. ( operation.exists() xor assert.exists() ) | ||||
318. TestScript.test.action.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
320. TestScript.test.action.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
322. TestScript.test.action.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
324. TestScript.test.action.operation | |||||
Definition | An operation would involve a REST request to a server. | ||||
Short | The setup operation to perform | ||||
Control | 0..1 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-8: Test operation SHALL contain either sourceId or targetId or params or url. ( sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history')) )ttt-2: HL7 V2 test operation SHALL NOT contain resource or accept or contentType or method or params or requestHeader or targetId. ( type.code.empty() or type.code != 'hl7v2' or (resource.count() + accept.count() + contentType.count() + method.count() + params.count() + requestHeader.field.count() + requestHeader.value.count() + targetId.count() = 0) )ttt-3: HL7 V3 test operation SHALL NOT contain resource or targetId. ( type.code.empty() or type.code != 'hl7v3' or (resource.count() + targetId.count() = 0) ) | ||||
326. TestScript.test.action.assert | |||||
Definition | Evaluates the results of previous operations to determine if the server under test behaves appropriately. | ||||
Short | The setup assertion to perform | ||||
Comments | In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine. | ||||
Control | 0..1 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.assert | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-6: Only a single assertion SHALL be present within test action assert element. ( extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1) )tst-11: Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. ( compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists()) )tst-13: Test action assert response and response and responseCode SHALL be empty when direction equals request ( (response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response' ) | ||||
328. TestScript.teardown | |||||
Definition | A series of operations required to clean up after all the tests are executed (successfully or otherwise). | ||||
Short | A series of required clean up steps | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
330. TestScript.teardown.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
332. TestScript.teardown.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
334. TestScript.teardown.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
336. TestScript.teardown.action | |||||
Definition | The teardown action will only contain an operation. | ||||
Short | One or more teardown operations to perform | ||||
Comments | An action should contain either an operation or an assertion but not both. It can contain any number of variables. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
338. TestScript.teardown.action.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
340. TestScript.teardown.action.extension | |||||
Definition | 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 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. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
342. TestScript.teardown.action.modifierExtension | |||||
Definition | 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'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. | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
344. TestScript.teardown.action.operation | |||||
Definition | An operation would involve a REST request to a server. | ||||
Short | The teardown operation to perform | ||||
Control | 1..1 | ||||
Type | See ttp://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tst-9: Teardown operation SHALL contain either sourceId or targetId or params or url. ( sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history')) ) |