This page is part of the Structured Data Capture FHIR IG (v4.0.0-ballot: STU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract | Version: 4.0.0-ballot | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: TemplateExtractExtension | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.85 |
Specifies a reference to a contained resource template (or set of resources for a repeating item) to be extracted from this item once the QuestionnaireResponse is complete. The template will be cloned into the output extraction bundle, and any template values will be replaced with the values from the QuestionnaireResponse. Optionally the fullUrl
and other Bundle.entry.request
properties can be also included.
Context of Use
This extension may be used on the following element(s):
Using this extension marks the point in a questionnaire at which a new resource will be created using the template-based extraction process.
When defined at the root of a questionnaire, the resource will be created even if there are no answers, and then iteratively processing the template properties will populate any further properties not covered by the base template.
When defined on a repeating item, a new resource will be created for each iteration of the item in the QuestionnaireResponse answers, if there is no answer in the QuestionnaireResponse, then no resource is created.
Before this extension is processed, any sdc-questionnaire-allocateId extensions will be processed.
Additional details on the use of this extension can be found on the Data Extraction page.
After the resource is created, and all the properties have been extracted from the item answers in the QuestionnaireResponse, the bundle.entry
properties can be populated:
request.method
- if the resource created has no Id
property, then the method will be POST
, otherwise it will be PUT
request.url
- if the resource is being updated, then the url will be the resource type and the Id
property e.g. Patient/123
,
otherwise it will be the resource type e.g. Patient
request.ifNoneMatch
- the ifNoneMatch
value to use (default is none)request.ifModifiedSince
- the ifModifiedSince
value to use (default is none)request.ifMatch
- the ifMatch
value to use (default is none)request.ifNoneExist
- the ifNoneExist
value to use (default is none)fullUrl
- the fullUrl
value to use, if the expression is missing, or evaluates to empty, then assign a new uuid.Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Complex Extension: Specifies a reference to a contained resource template (or set of resources for a repeating item) to be extracted from this item once the QuestionnaireResponse is complete. The template will be cloned into the output extraction bundle, and any template values will be replaced with the values from the QuestionnaireResponse. Optionally the fullUrl
and other Bundle.entry.request
properties can be also included.
Maturity: 0
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Establishes extract context for a Questionnaire/item using an extraction template resource | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:template | 1..1 | Extension | Reference to contained resource template | |
extension | 0..0 | |||
url | 1..1 | uri | "template" | |
value[x] | 1..1 | Reference() {c} | Contained reference to the resource template | |
extension:fullUrl | 0..1 | Extension | A fhirpath expression to evaluate to populate the fullUrl property in the `Bundle.entry` (uri/string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "fullUrl" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:resourceId | 0..1 | Extension | A fhirpath expression to evaluate to populate the resourceId property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "resourceId" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneMatch property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifModifiedSince | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifModifiedSince property (instant result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifModifiedSince" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifMatch property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneExist | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneExist property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneExist" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract" | |
value[x] | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Establishes extract context for a Questionnaire/item using an extraction template resource | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:template | 1..1 | Extension | Reference to contained resource template | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "template" | |
value[x] | 1..1 | Reference() {c} | Contained reference to the resource template | |
extension:fullUrl | 0..1 | Extension | A fhirpath expression to evaluate to populate the fullUrl property in the `Bundle.entry` (uri/string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "fullUrl" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:resourceId | 0..1 | Extension | A fhirpath expression to evaluate to populate the resourceId property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "resourceId" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneMatch property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifModifiedSince | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifModifiedSince property (instant result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifModifiedSince" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifMatch property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneExist | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneExist property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneExist" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract" | |
Documentation for this format |
This structure is derived from Extension
Summary
Complex Extension: Specifies a reference to a contained resource template (or set of resources for a repeating item) to be extracted from this item once the QuestionnaireResponse is complete. The template will be cloned into the output extraction bundle, and any template values will be replaced with the values from the QuestionnaireResponse. Optionally the fullUrl
and other Bundle.entry.request
properties can be also included.
Maturity: 0
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Establishes extract context for a Questionnaire/item using an extraction template resource | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:template | 1..1 | Extension | Reference to contained resource template | |
extension | 0..0 | |||
url | 1..1 | uri | "template" | |
value[x] | 1..1 | Reference() {c} | Contained reference to the resource template | |
extension:fullUrl | 0..1 | Extension | A fhirpath expression to evaluate to populate the fullUrl property in the `Bundle.entry` (uri/string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "fullUrl" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:resourceId | 0..1 | Extension | A fhirpath expression to evaluate to populate the resourceId property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "resourceId" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneMatch property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifModifiedSince | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifModifiedSince property (instant result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifModifiedSince" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifMatch property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneExist | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneExist property (string result) | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneExist" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract" | |
value[x] | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Establishes extract context for a Questionnaire/item using an extraction template resource | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:template | 1..1 | Extension | Reference to contained resource template | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "template" | |
value[x] | 1..1 | Reference() {c} | Contained reference to the resource template | |
extension:fullUrl | 0..1 | Extension | A fhirpath expression to evaluate to populate the fullUrl property in the `Bundle.entry` (uri/string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "fullUrl" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:resourceId | 0..1 | Extension | A fhirpath expression to evaluate to populate the resourceId property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "resourceId" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneMatch property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifModifiedSince | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifModifiedSince property (instant result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifModifiedSince" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifMatch | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifMatch property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifMatch" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
extension:ifNoneExist | 0..1 | Extension | A fhirpath expression to evaluate to populate the ifNoneExist property (string result) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "ifNoneExist" | |
value[x] | 1..1 | string | Fhirpath Expression value | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract" | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron