Complex
Primitive
ActivityDefinition
CapabilityStatement
CodeSystem
Composition
ConceptMap
Encounter
Library
List
Measure
MessageHeader
Observation
Patient
PlanDefinition
Questionnaire
Resource
ServiceDefinition
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for TestScript Resource
TestScript
Path
TestScript
Id
TestScript
Cardinality
0 - *
Definition
A structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1 [error]
If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Path
TestScript.url
Id
TestScript.url
Type
Cardinality
1 - 1
Definition
An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions).
Comment
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.
Requirements
Allows the test script to be referenced by a single globally unique identifier.
Path
TestScript.identifier
Id
TestScript.identifier
Type
Cardinality
0 - 1
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.
Comment
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this test script outside of FHIR, where it is not possible to use the logical URI.
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Path
TestScript.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
TestScript.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
TestScript.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
TestScript.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
TestScript.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
TestScript.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
TestScript.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
TestScript.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
TestScript.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
TestScript.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
TestScript.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
TestScript.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
TestScript.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
TestScript.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
TestScript.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
TestScript.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
TestScript.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
TestScript.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
TestScript.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
TestScript.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
TestScript.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.version
Id
TestScript.version
Type
Cardinality
0 - 1
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.
Comment
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 refrence to a particular business version of the test script with the format [url]|[version].
Path
TestScript.name
Id
TestScript.name
Type
Cardinality
1 - 1
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.
Comment
The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.
Requirements
Support human navigation and code generation.
Path
TestScript.title
Id
TestScript.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the test script.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Path
TestScript.status
Id
TestScript.status
Type
Cardinality
1 - 1
Definition
The status of this test script. Enables tracking the life-cycle of the content.
Comment
Allows filtering of test scripts that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired test script without due consideration.
Path
TestScript.experimental
Id
TestScript.experimental
Type
Cardinality
0 - 1
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.
Comment
Allows filtering of test script that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental test script in production.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script.
Path
TestScript.date
Id
TestScript.date
Type
Cardinality
0 - 1
Definition
The date (and optionally time) when the test script was published. The date must change if and 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.
Comment
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.
Path
TestScript.publisher
Id
TestScript.publisher
Type
Cardinality
0 - 1
Definition
The name of the individual or organization that published the test script.
Comment
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.
Requirements
Helps establish the "authority/credibility" of the test script. May also allow for contact.
Path
TestScript.contact
Id
TestScript.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
Path
TestScript.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Path
TestScript.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Condition
cpt-2
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
TestScript.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
TestScript.description
Id
TestScript.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the test script from a consumer's perspective.
Comment
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 profile is presumed to be the predominant language in the place the profile was created).
Path
TestScript.useContext
Id
TestScript.useContext
Type
Cardinality
0 - *
Definition
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances.
Comment
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Path
TestScript.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Path
TestScript.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
TestScript.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
TestScript.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
TestScript.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
TestScript.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
TestScript.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Path
TestScript.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
TestScript.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
TestScript.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
TestScript.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
TestScript.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
TestScript.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
TestScript.jurisdiction
Id
TestScript.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the test script is intended to be used.
Comment
It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended.
Path
TestScript.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
TestScript.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
TestScript.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
TestScript.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
TestScript.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
TestScript.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
TestScript.purpose
Id
TestScript.purpose
Type
Cardinality
0 - 1
Definition
Explaination of why this test script is needed and why it has been designed as it has.
Comment
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.
Path
TestScript.copyright
Id
TestScript.copyright
Type
Cardinality
0 - 1
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.
Comment
Requirements
Consumers must be able to determine any legal restrictions on the use of the test script and/or its content.
Path
TestScript.origin
Id
TestScript.origin
Type
Cardinality
0 - *
Definition
An abstract server used in operations within this test script in the origin element.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.origin.index
Id
TestScript.origin.index
Type
Cardinality
1 - 1
Definition
Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.
Comment
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 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.
Path
TestScript.origin.profile
Id
TestScript.origin.profile
Type
Cardinality
1 - 1
Definition
The type of origin profile the test system supports.
Comment
Must be a "sender"/"client" profile.
Path
TestScript.origin.profile.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
TestScript.origin.profile.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
TestScript.origin.profile.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
TestScript.origin.profile.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
TestScript.origin.profile.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
destination
An abstract server representing a destination or receiver in a message exchange
Path
TestScript.destination
Id
TestScript.destination
Type
Cardinality
0 - *
Definition
An abstract server used in operations within this test script in the destination element.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.destination.index
Id
TestScript.destination.index
Type
Cardinality
1 - 1
Definition
Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
Comment
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.
Path
TestScript.destination.profile
Id
TestScript.destination.profile
Type
Cardinality
1 - 1
Definition
The type of destination profile the test system supports.
Comment
Must be a "receiver"/"server" profile.
Path
TestScript.destination.profile.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
TestScript.destination.profile.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
TestScript.destination.profile.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
TestScript.destination.profile.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
TestScript.destination.profile.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
metadata
Required capability that is assumed to function correctly on the FHIR server being tested
Path
TestScript.metadata
Id
TestScript.metadata
Type
Cardinality
0 - 1
Definition
The required capability must exist and are assumed to function correctly on the FHIR server being tested.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
inv-4 [error]
TestScript metadata capability SHALL contain required or validated or both.
Path
TestScript.metadata.link
Id
TestScript.metadata.link
Type
Cardinality
0 - *
Definition
A link to the FHIR specification that this test is covering.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.metadata.link.url
Id
TestScript.metadata.link.url
Type
Cardinality
1 - 1
Definition
URL to a particular requirement or feature within the FHIR specification.
Comment
Path
TestScript.metadata.link.description
Id
TestScript.metadata.link.description
Type
Cardinality
0 - 1
Definition
Short description of the link.
Comment
capability
Capabilities that are assumed to function correctly on the FHIR server being tested
Path
TestScript.metadata.capability
Id
TestScript.metadata.capability
Type
Cardinality
1 - *
Definition
Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.metadata.capability.required
Id
TestScript.metadata.capability.required
Type
Cardinality
0 - 1
Definition
Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
Comment
Path
TestScript.metadata.capability.validated
Id
TestScript.metadata.capability.validated
Type
Cardinality
0 - 1
Definition
Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
Comment
Path
TestScript.metadata.capability.description
Id
TestScript.metadata.capability.description
Type
Cardinality
0 - 1
Definition
Description of the capabilities that this test script is requiring the server to support.
Comment
Path
TestScript.metadata.capability.origin
Id
TestScript.metadata.capability.origin
Type
Cardinality
0 - *
Definition
Which origin server these requirements apply to.
Comment
Path
TestScript.metadata.capability.destination
Id
TestScript.metadata.capability.destination
Type
Cardinality
0 - 1
Definition
Which server these requirements apply to.
Comment
Path
TestScript.metadata.capability.link
Id
TestScript.metadata.capability.link
Type
Cardinality
0 - *
Definition
Links to the FHIR specification that describes this interaction and the resources involved in more detail.
Comment
Path
TestScript.metadata.capability.capabilities
Id
TestScript.metadata.capability.capabilities
Type
Cardinality
1 - 1
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.
Comment
The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.
Path
TestScript.metadata.capability.capabilities.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.metadata.capability.capabilities.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.metadata.capability.capabilities.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.fixture
Id
TestScript.fixture
Type
Cardinality
0 - *
Definition
Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.fixture.autocreate
Id
TestScript.fixture.autocreate
Type
Cardinality
0 - 1
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.
Comment
Path
TestScript.fixture.autodelete
Id
TestScript.fixture.autodelete
Type
Cardinality
0 - 1
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.
Comment
Path
TestScript.fixture.resource
Id
TestScript.fixture.resource
Type
Cardinality
0 - 1
Definition
Reference to the resource (containing the contents of the resource needed for operations).
Comment
See http://hl7.org/fhir/STU3/resourcelist.html for complete list of resource types.
Path
TestScript.fixture.resource.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.fixture.resource.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.fixture.resource.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
TestScript.fixture.resource.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
TestScript.fixture.resource.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
TestScript.fixture.resource.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
TestScript.fixture.resource.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
TestScript.fixture.resource.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
TestScript.fixture.resource.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.profile
Id
TestScript.profile
Type
Cardinality
0 - *
Definition
Reference to the profile to be used for validation.
Comment
See http://hl7.org/fhir/STU3/resourcelist.html for complete list of resource types.
Path
TestScript.profile.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.profile.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.profile.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
TestScript.profile.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
TestScript.profile.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
TestScript.profile.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
TestScript.profile.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
TestScript.profile.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
TestScript.profile.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
TestScript.profile.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
TestScript.profile.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
TestScript.profile.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.profile.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.profile.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.profile.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.variable
Id
TestScript.variable
Type
Cardinality
0 - *
Definition
Variable is set based either on element value in response body or on header field value in the response headers.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
inv-3 [error]
Variable can only contain one of expression, headerField or path.
Path
TestScript.variable.name
Id
TestScript.variable.name
Type
Cardinality
1 - 1
Definition
Descriptive name for this variable.
Comment
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.
Path
TestScript.variable.defaultValue
Id
TestScript.variable.defaultValue
Type
Cardinality
0 - 1
Definition
A default, hard-coded, or user-defined value for this variable.
Comment
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.
Path
TestScript.variable.description
Id
TestScript.variable.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the variable and its purpose.
Comment
Path
TestScript.variable.expression
Id
TestScript.variable.expression
Type
Cardinality
0 - 1
Definition
The fluentpath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
Comment
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.
Path
TestScript.variable.headerField
Id
TestScript.variable.headerField
Type
Cardinality
0 - 1
Definition
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
Comment
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.
Path
TestScript.variable.hint
Id
TestScript.variable.hint
Type
Cardinality
0 - 1
Definition
Displayable text string with hint help information to the user when entering a default value.
Comment
Path
TestScript.variable.path
Id
TestScript.variable.path
Type
Cardinality
0 - 1
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.
Comment
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.
Path
TestScript.variable.sourceId
Id
TestScript.variable.sourceId
Type
Cardinality
0 - 1
Definition
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
Comment
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.
Path
TestScript.rule
Id
TestScript.rule
Type
Cardinality
0 - *
Definition
Assert rule to be used in one or more asserts within the test script.
Comment
Each rule should be treated by test engines as one assertion regardless of how many assertions are contained within the external rule template. The impact of negative rule evaluation on test script execution is the same as an assertion failure which is described elsewhere in the TestScript resource.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.rule.resource
Id
TestScript.rule.resource
Type
Cardinality
1 - 1
Definition
Reference to the resource (containing the contents of the rule needed for assertions).
Comment
Path
TestScript.rule.resource.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.rule.resource.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.rule.resource.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
TestScript.rule.resource.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
TestScript.rule.resource.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
TestScript.rule.resource.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
TestScript.rule.resource.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
TestScript.rule.resource.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
TestScript.rule.resource.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.rule.param
Id
TestScript.rule.param
Type
Cardinality
0 - *
Definition
Each rule template can take one or more parameters for rule evaluation.
Comment
The parameter value can be dynamic at runtime.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.rule.param.name
Id
TestScript.rule.param.name
Type
Cardinality
1 - 1
Definition
Descriptive name for this parameter that matches the external assert rule parameter name.
Comment
The external rule template would be looking for the parameter by this name.
Path
TestScript.rule.param.value
Id
TestScript.rule.param.value
Type
Cardinality
0 - 1
Definition
The explicit or dynamic value for the parameter that will be passed on to the external rule template.
Comment
This value can be overwritten by the assert.rule.param.value i.e. TestScript.rule.param.value will be used if assert.rule.param.value is not specified. The param value can be a 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 supplying this value to the external rule template.
Path
TestScript.ruleset
Id
TestScript.ruleset
Type
Cardinality
0 - *
Definition
Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied.
Comment
Each rule within a ruleset should be treated by test engines as one assertion regardless of how many assertions are contained within the external rule template. The impact of negative rule evaluation on test script execution is the same as an assertion failure which is described elsewhere in the TestScript resource.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.ruleset.resource
Id
TestScript.ruleset.resource
Type
Cardinality
1 - 1
Definition
Reference to the resource (containing the contents of the ruleset needed for assertions).
Comment
Path
TestScript.ruleset.resource.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
TestScript.ruleset.resource.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
TestScript.ruleset.resource.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
TestScript.ruleset.resource.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
TestScript.ruleset.resource.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
TestScript.ruleset.resource.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
TestScript.ruleset.resource.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
TestScript.ruleset.resource.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
TestScript.ruleset.resource.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
TestScript.ruleset.rule
Id
TestScript.ruleset.rule
Type
Cardinality
1 - *
Definition
The referenced rule within the external ruleset template.
Comment
This qualifies each param name so that a parameter with the same name can be used differently by the different rules with the ruleset.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.ruleset.rule.ruleId
Id
TestScript.ruleset.rule.ruleId
Type
Cardinality
1 - 1
Definition
Id of the referenced rule within the external ruleset template.
Comment
Path
TestScript.ruleset.rule.param
Id
TestScript.ruleset.rule.param
Type
Cardinality
0 - *
Definition
Each rule template can take one or more parameters for rule evaluation.
Comment
The parameter value can be dynamic at runtime.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.ruleset.rule.param.name
Id
TestScript.ruleset.rule.param.name
Type
Cardinality
1 - 1
Definition
Descriptive name for this parameter that matches the external assert ruleset rule parameter name.
Comment
The external rule template would be looking for the parameter by this name.
Path
TestScript.ruleset.rule.param.value
Id
TestScript.ruleset.rule.param.value
Type
Cardinality
0 - 1
Definition
The value for the parameter that will be passed on to the external ruleset rule template.
Comment
This value can be overwritten by the assert.ruleset.rule.param.value i.e. TestScript.ruleset.rule.param.value will be used if assert.ruleset.rule.param.value is not specified. The param value can be a 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 supplying this value to the external rule template.
Path
TestScript.setup
Id
TestScript.setup
Type
Cardinality
0 - 1
Definition
A series of required setup operations before tests are executed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action
Id
TestScript.setup.action
Type
Cardinality
1 - *
Definition
Action would contain either an operation or an assertion.
Comment
An action should contain either an operation or an assertion but not both. It can contain any number of variables.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
inv-1 [error]
Setup action SHALL contain either an operation or assert but not both.
Path
TestScript.setup.action.operation
Id
TestScript.setup.action.operation
Type
Cardinality
0 - 1
Definition
The operation to perform.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
inv-7 [error]
Setup operation SHALL contain either sourceId or targetId or params or url.
Path
TestScript.setup.action.operation.type
Id
TestScript.setup.action.operation.type
Type
Cardinality
0 - 1
Definition
Server interaction or operation type.
Comment
See http://hl7.org/fhir/STU3/http.html for list of server interactions.
Path
TestScript.setup.action.operation.resource
Id
TestScript.setup.action.operation.resource
Type
Cardinality
0 - 1
Definition
The type of the resource. See http://hl7.org/fhir/STU3/resourcelist.html.
Comment
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.
Path
TestScript.setup.action.operation.label
Id
TestScript.setup.action.operation.label
Type
Cardinality
0 - 1
Definition
The label would be used for tracking/logging purposes by test engines.
Comment
This has no impact on the verification itself.
Path
TestScript.setup.action.operation.description
Id
TestScript.setup.action.operation.description
Type
Cardinality
0 - 1
Definition
The description would be used by test engines for tracking and reporting purposes.
Comment
This has no impact on the verification itself.
Path
TestScript.setup.action.operation.accept
Id
TestScript.setup.action.operation.accept
Type
Cardinality
0 - 1
Definition
The content-type or mime-type to use for RESTful operation in the 'Accept' header.
Comment
If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If 'xml' is specified, then 'Accept' header of 'application/fhir+xml' will be set. If 'json' is specified, then 'application/fhir+json' will be used. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element.
Path
TestScript.setup.action.operation.contentType
Id
TestScript.setup.action.operation.contentType
Type
Cardinality
0 - 1
Definition
The content-type or mime-type to use for RESTful operation in the 'Content-Type' header.
Comment
If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If 'xml' is specified, then 'Content-Type' header of 'application/fhir+xml' will be set. If 'json' is specified, then 'application/fhir+json' will be used. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element.
Path
TestScript.setup.action.operation.destination
Id
TestScript.setup.action.operation.destination
Type
Cardinality
0 - 1
Definition
The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
Comment
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.
Path
TestScript.setup.action.operation.encodeRequestUrl
Id
TestScript.setup.action.operation.encodeRequestUrl
Type
Cardinality
0 - 1
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.
Comment
Path
TestScript.setup.action.operation.origin
Id
TestScript.setup.action.operation.origin
Type
Cardinality
0 - 1
Definition
The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
Comment
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.
Path
TestScript.setup.action.operation.params
Id
TestScript.setup.action.operation.params
Type
Cardinality
0 - 1
Definition
Path plus parameters after [type]. Used to set parts of the request URL explicitly.
Comment
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.
Path
TestScript.setup.action.operation.requestHeader
Id
TestScript.setup.action.operation.requestHeader
Type
Cardinality
0 - *
Definition
Header elements would be used to set HTTP headers.
Comment
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://hl7.org/fhir/STU3/http.html#2.1.0.5.1 - "If-Match" header. See http://hl7.org/fhir/STU3/http.html#2.1.0.11 - Conditional Create using "If-None-Exist". See http://hl7.org/fhir/STU3/http.html#2.1.0.13.1 - Invalid "Content-Type" header for negative testing. - etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action.operation.requestHeader.field
Id
TestScript.setup.action.operation.requestHeader.field
Type
Cardinality
1 - 1
Definition
The HTTP header field e.g. "Accept".
Comment
If header element is specified, then field is required.
Path
TestScript.setup.action.operation.requestHeader.value
Id
TestScript.setup.action.operation.requestHeader.value
Type
Cardinality
1 - 1
Definition
The value of the header e.g. "application/fhir+xml".
Comment
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.
Path
TestScript.setup.action.operation.requestId
Id
TestScript.setup.action.operation.requestId
Type
Cardinality
0 - 1
Definition
The fixture id (maybe new) to map to the request.
Comment
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.
Path
TestScript.setup.action.operation.responseId
Id
TestScript.setup.action.operation.responseId
Type
Cardinality
0 - 1
Definition
The fixture id (maybe new) to map to the response.
Comment
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.
Path
TestScript.setup.action.operation.sourceId
Id
TestScript.setup.action.operation.sourceId
Type
Cardinality
0 - 1
Definition
The id of the fixture used as the body of a PUT or POST request.
Comment
Path
TestScript.setup.action.operation.targetId
Id
TestScript.setup.action.operation.targetId
Type
Cardinality
0 - 1
Definition
Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
Comment
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.
Path
TestScript.setup.action.operation.url
Id
TestScript.setup.action.operation.url
Type
Cardinality
0 - 1
Definition
Complete request URL.
Comment
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.
Path
TestScript.setup.action.assert
Id
TestScript.setup.action.assert
Type
Cardinality
0 - 1
Definition
Evaluates the results of previous operations to determine if the server under test behaves appropriately.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
inv-5 [error]
Only a single assertion SHALL be present within setup action assert element.
inv-10 [error]
Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
inv-12 [error]
Setup action assert response and responseCode SHALL be empty when direction equals request
Path
TestScript.setup.action.assert.label
Id
TestScript.setup.action.assert.label
Type
Cardinality
0 - 1
Definition
The label would be used for tracking/logging purposes by test engines.
Comment
This has no impact on the verification itself.
Path
TestScript.setup.action.assert.description
Id
TestScript.setup.action.assert.description
Type
Cardinality
0 - 1
Definition
The description would be used by test engines for tracking and reporting purposes.
Comment
This has no impact on the verification itself.
Path
TestScript.setup.action.assert.direction
Id
TestScript.setup.action.assert.direction
Type
Cardinality
0 - 1
Definition
The direction to use for the assertion.
Comment
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.
Path
TestScript.setup.action.assert.compareToSourceId
Id
TestScript.setup.action.assert.compareToSourceId
Type
Cardinality
0 - 1
Definition
Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.
Comment
Path
TestScript.setup.action.assert.compareToSourceExpression
Id
TestScript.setup.action.assert.compareToSourceExpression
Type
Cardinality
0 - 1
Definition
The fluentpath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
Comment
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.
Path
TestScript.setup.action.assert.compareToSourcePath
Id
TestScript.setup.action.assert.compareToSourcePath
Type
Cardinality
0 - 1
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.
Comment
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.
Path
TestScript.setup.action.assert.contentType
Id
TestScript.setup.action.assert.contentType
Type
Cardinality
0 - 1
Definition
The content-type or mime-type to use for RESTful operation in the 'Content-Type' header.
Comment
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 'xml' is specified, then 'Content-Type' header of 'application/fhir+xml' will be confirmed. If 'json' is specified, then 'application/fhir+json' will be used. If you'd like to have more control over the string, then use 'assert.headerField' instead.
Path
TestScript.setup.action.assert.expression
Id
TestScript.setup.action.assert.expression
Type
Cardinality
0 - 1
Definition
The fluentpath expression to be evaluated against the request or response message contents - HTTP headers and payload.
Comment
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.
Path
TestScript.setup.action.assert.headerField
Id
TestScript.setup.action.assert.headerField
Type
Cardinality
0 - 1
Definition
The HTTP header field name e.g. 'Location'.
Comment
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.
Path
TestScript.setup.action.assert.minimumId
Id
TestScript.setup.action.assert.minimumId
Type
Cardinality
0 - 1
Definition
The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
Comment
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.
Path
TestScript.setup.action.assert.navigationLinks
Id
TestScript.setup.action.assert.navigationLinks
Type
Cardinality
0 - 1
Definition
Whether or not the test execution performs validation on the bundle navigation links.
Comment
Asserts that the Bundle contains first, last, and next links.
operator
equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
Path
TestScript.setup.action.assert.operator
Id
TestScript.setup.action.assert.operator
Type
Cardinality
0 - 1
Definition
The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
Comment
Operators are useful especially for negative testing. If operator is not specified, then the "equals" operator is assumed; e.g.
.
Path
TestScript.setup.action.assert.path
Id
TestScript.setup.action.assert.path
Type
Cardinality
0 - 1
Definition
The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
Comment
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.
Path
TestScript.setup.action.assert.requestMethod
Id
TestScript.setup.action.assert.requestMethod
Type
Cardinality
0 - 1
Definition
The request method or HTTP operation code to compare against that used by the client system under test.
Comment
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.
Path
TestScript.setup.action.assert.requestURL
Id
TestScript.setup.action.assert.requestURL
Type
Cardinality
0 - 1
Definition
The value to use in a comparison against the request URL path string.
Comment
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.
Path
TestScript.setup.action.assert.resource
Id
TestScript.setup.action.assert.resource
Type
Cardinality
0 - 1
Definition
The type of the resource. See http://hl7.org/fhir/STU3/resourcelist.html.
Comment
This will be expected resource type in response body e.g. in read, vread, search, etc. See http://hl7.org/fhir/STU3/resourcelist.html for complete list of resource types; e.g. .
response
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
Path
TestScript.setup.action.assert.response
Id
TestScript.setup.action.assert.response
Type
Cardinality
0 - 1
Definition
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
Comment
This is a shorter way of achieving similar verifications via "assert.responseCode". If you need more control, then use "assert.responseCode" e.g. .
Path
TestScript.setup.action.assert.responseCode
Id
TestScript.setup.action.assert.responseCode
Type
Cardinality
0 - 1
Definition
The value of the HTTP response code to be tested.
Comment
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.
Path
TestScript.setup.action.assert.rule
Id
TestScript.setup.action.assert.rule
Type
Cardinality
0 - 1
Definition
The TestScript.rule this assert will evaluate.
Comment
Each rule should get evaluated by test engines as one assertion regardless of how many assertions are contained within the external rule template. The impact of negative rule evaluation on test script execution is the same as an assertion failure which is descibed elsewhere in the TestScript resource.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action.assert.rule.ruleId
Id
TestScript.setup.action.assert.rule.ruleId
Type
Cardinality
1 - 1
Definition
The TestScript.rule id value this assert will evaluate.
Comment
Path
TestScript.setup.action.assert.rule.param
Id
TestScript.setup.action.assert.rule.param
Type
Cardinality
0 - *
Definition
Each rule template can take one or more parameters for rule evaluation.
Comment
The parameter value can be dynamic at runtime.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action.assert.rule.param.name
Id
TestScript.setup.action.assert.rule.param.name
Type
Cardinality
1 - 1
Definition
Descriptive name for this parameter that matches the external assert rule parameter name.
Comment
The external rule template would be looking for the parameter by this name.
Path
TestScript.setup.action.assert.rule.param.value
Id
TestScript.setup.action.assert.rule.param.value
Type
Cardinality
1 - 1
Definition
The value for the parameter that will be passed on to the external rule template.
Comment
This value overwrites the value (if any) specified in TestScript.rule.param.value. The param value can be a 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 supplying this value to the external rule template.
Path
TestScript.setup.action.assert.ruleset
Id
TestScript.setup.action.assert.ruleset
Type
Cardinality
0 - 1
Definition
The TestScript.ruleset this assert will evaluate.
Comment
Each rule within a ruleset should get evaluated by test engines as a separate assertion. The impact of negative rule evaluation on test script execution is the same as an assertion failure which is descibed elsewhere in the TestScript resource. If the first rule within the ruleset results in a failed assertion, then test engines do not have to evaluate the rest of the rules within the ruleset.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action.assert.ruleset.rulesetId
Id
TestScript.setup.action.assert.ruleset.rulesetId
Type
Cardinality
1 - 1
Definition
The TestScript.ruleset id value this assert will evaluate.
Comment
Path
TestScript.setup.action.assert.ruleset.rule
Id
TestScript.setup.action.assert.ruleset.rule
Type
Cardinality
0 - *
Definition
The referenced rule within the external ruleset template.
Comment
This qualifies each param name so that a parameter with the same name can be used differently by the different rules with the ruleset.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action.assert.ruleset.rule.ruleId
Id
TestScript.setup.action.assert.ruleset.rule.ruleId
Type
Cardinality
1 - 1
Definition
Id of the referenced rule within the external ruleset template.
Comment
Path
TestScript.setup.action.assert.ruleset.rule.param
Id
TestScript.setup.action.assert.ruleset.rule.param
Type
Cardinality
0 - *
Definition
Each rule template can take one or more parameters for rule evaluation.
Comment
The parameter value can be dynamic at runtime.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.setup.action.assert.ruleset.rule.param.name
Id
TestScript.setup.action.assert.ruleset.rule.param.name
Type
Cardinality
1 - 1
Definition
Descriptive name for this parameter that matches the external assert ruleset rule parameter name.
Comment
The external rule template would be looking for the parameter by this name.
Path
TestScript.setup.action.assert.ruleset.rule.param.value
Id
TestScript.setup.action.assert.ruleset.rule.param.value
Type
Cardinality
1 - 1
Definition
The value for the parameter that will be passed on to the external ruleset rule template.
Comment
This value overwrites the value (if any) specified in TestScript.ruleset.rule.param.value. The param value can be a 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 supplying this value to the external rule template.
Path
TestScript.setup.action.assert.sourceId
Id
TestScript.setup.action.assert.sourceId
Type
Cardinality
0 - 1
Definition
Fixture to evaluate the XPath/JSONPath expression or the headerField against.
Comment
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.
Path
TestScript.setup.action.assert.validateProfileId
Id
TestScript.setup.action.assert.validateProfileId
Type
Cardinality
0 - 1
Definition
The ID of the Profile to validate against.
Comment
The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.
Path
TestScript.setup.action.assert.value
Id
TestScript.setup.action.assert.value
Type
Cardinality
0 - 1
Definition
The value to compare to.
Comment
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.
Path
TestScript.setup.action.assert.warningOnly
Id
TestScript.setup.action.assert.warningOnly
Type
Cardinality
0 - 1
Definition
Whether or not the test execution will produce a warning only on error for this assert.
Comment
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.
Path
TestScript.test
Id
TestScript.test
Type
Cardinality
0 - *
Definition
A test in this script.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.test.name
Id
TestScript.test.name
Type
Cardinality
0 - 1
Definition
The name of this test used for tracking/logging purposes by test engines.
Comment
Path
TestScript.test.description
Id
TestScript.test.description
Type
Cardinality
0 - 1
Definition
A short description of the test used by test engines for tracking and reporting purposes.
Comment
Path
TestScript.test.action
Id
TestScript.test.action
Type
Cardinality
1 - *
Definition
Action would contain either an operation or an assertion.
Comment
An action should contain either an operation or an assertion but not both. It can contain any number of variables.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
inv-2 [error]
Test action SHALL contain either an operation or assert but not both.
Path
TestScript.test.action.operation
Id
TestScript.test.action.operation
Type
Cardinality
0 - 1
Definition
An operation would involve a REST request to a server.
Comment
Constraint
inv-8 [error]
Test operation SHALL contain either sourceId or targetId or params or url.
Path
TestScript.test.action.assert
Id
TestScript.test.action.assert
Type
Cardinality
0 - 1
Definition
Evaluates the results of previous operations to determine if the server under test behaves appropriately.
Comment
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.
Constraint
inv-6 [error]
Only a single assertion SHALL be present within test action assert element.
inv-11 [error]
Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
inv-13 [error]
Test action assert response and response and responseCode SHALL be empty when direction equals request
Path
TestScript.teardown
Id
TestScript.teardown
Type
Cardinality
0 - 1
Definition
A series of operations required to clean up after the all the tests are executed (successfully or otherwise).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.teardown.action
Id
TestScript.teardown.action
Type
Cardinality
1 - *
Definition
The teardown action will only contain an operation.
Comment
An action should contain either an operation or an assertion but not both. It can contain any number of variables.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TestScript.teardown.action.operation
Id
TestScript.teardown.action.operation
Type
Cardinality
1 - 1
Definition
An operation would involve a REST request to a server.
Comment
Constraint
inv-9 [error]
Teardown operation SHALL contain either sourceId or targetId or params or url.