Structured Data Capture
4.0.0-ballot - STU 4 ballot International flag

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

Extension: Extract Definition

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-definitionExtract Version: 4.0.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: DefinitionExtractExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.81

Specifies the resource type/profile for the definition based extraction of a resource and optionally the fullUrl and other Bundle.entry.request properties as needed.

Context of Use

This extension may be used on the following element(s):

  • Element ID Questionnaire
  • Element ID Questionnaire.item
  • Element ID ElementDefinition

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

The extension replaces the sdc-questionnaire-itemContextExtension which was only able to provide the resource type to create, and was unable to define a profile or any of the bundle.entry.request properties. However either extension can be used to indicate a resource type should be extracted.

Scope and Usage

When defined at the root of a questionnaire, the resource will be created even if there are no answers, and then processing the item answers will populate any further properties not covered by the base profile.

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 skeleton 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:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: Specifies the resource type/profile for the definition based extraction of a resource and optionally the fullUrl and other Bundle.entry.request properties as needed.

  • definition: canonical: The resource type/profile canonical Url defining the resource type to be extracted.
  • 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.
  • 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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Details for a definition based resource extraction
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:definition 1..1 Extension Canonical URL of Resource type or profile to extract
..... extension 0..0
..... url 1..1 uri "definition"
..... value[x] 1..1 canonical() Resource Profile canonical URL
.... 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: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-definitionExtract"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Details for a definition based resource extraction
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 1..1 Extension Canonical URL of Resource type or profile to extract
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "definition"
..... value[x] 1..1 canonical() Resource Profile canonical URL
.... 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: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-definitionExtract"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Specifies the resource type/profile for the definition based extraction of a resource and optionally the fullUrl and other Bundle.entry.request properties as needed.

  • definition: canonical: The resource type/profile canonical Url defining the resource type to be extracted.
  • 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.
  • 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 View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Details for a definition based resource extraction
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:definition 1..1 Extension Canonical URL of Resource type or profile to extract
..... extension 0..0
..... url 1..1 uri "definition"
..... value[x] 1..1 canonical() Resource Profile canonical URL
.... 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: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-definitionExtract"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Details for a definition based resource extraction
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 1..1 Extension Canonical URL of Resource type or profile to extract
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "definition"
..... value[x] 1..1 canonical() Resource Profile canonical URL
.... 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: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-definitionExtract"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron