Structured Data Capture
4.0.0 - International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Extension: Extract Template - Resource

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract Version: 4.0.0
Standards status: Draft Draft as of 2025-10-22 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

Using this extension marks the point in a questionnaire at which a new resource will be created using the template-based extraction process.

Scope and Usage

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.

Populating the transaction bundle entry

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

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.

  • template: Reference: A reference to a contained resource to use as a template to put into the output transaction bundle.
  • fullUrl: string: A fhirpath expression to evaluate to extract the value into the fullUrl property. If no value is evaluated, then the element is not extracted.
  • resourceId: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneMatch: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifModifiedSince: string: A fhirpath expression to evaluate to extract the value into the ifModifiedSince property. If no value is evaluated, then the element is not extracted.
  • ifMatch: string: A fhirpath expression to evaluate to extract the value into the ifMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneExist: string: A fhirpath expression to evaluate to extract the value into the ifNoneExist property. If no value is evaluated, then the element is not extracted.

Maturity: 0

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

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.

  • template: Reference: A reference to a contained resource to use as a template to put into the output transaction bundle.
  • fullUrl: string: A fhirpath expression to evaluate to extract the value into the fullUrl property. If no value is evaluated, then the element is not extracted.
  • resourceId: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneMatch: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifModifiedSince: string: A fhirpath expression to evaluate to extract the value into the ifModifiedSince property. If no value is evaluated, then the element is not extracted.
  • ifMatch: string: A fhirpath expression to evaluate to extract the value into the ifMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneExist: string: A fhirpath expression to evaluate to extract the value into the ifNoneExist property. If no value is evaluated, then the element is not extracted.

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron