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 Observation

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract Version: 4.0.0
Standards status: Trial-use Active as of 2025-10-22 Maturity Level: 4 Computable Name: ObservationExtractExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.40

Indicates how the observation-based extraction approach should be applied to an item or all items in a questionnaire. When set to true, the item is extracted as an independent Observation with no relationship to a parent Observation (If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present)). When set to a code value (e.g., member or component), the extracted Observation is related to a parent Observation according to the specified relationship. Mixing boolean and code values within the same item is invalid and will result in an error.

Context of Use

Additional details on the use of this extension can be found on the Data Extraction page.

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..1 Extension Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract"
... value[x] 0..1 Value of extension
Binding: Observation Extract Relationship Value Set (required)
.... valueBoolean boolean
.... valueCode code

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.value[x] Base required Observation Extract Relationship Value Set 📦4.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract"
.... valueBoolean boolean
.... valueCode code

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x] Base required Observation Extract Relationship Value Set 📦4.0.0 This IG

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

Simple Extension with the type boolean, code: Indicates how the observation-based extraction approach should be applied to an item or all items in a questionnaire. When set to true, the item is extracted as an independent Observation with no relationship to a parent Observation (If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present)). When set to a code value (e.g., member or component), the extracted Observation is related to a parent Observation according to the specified relationship. Mixing boolean and code values within the same item is invalid and will result in an error.

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract"
... value[x] 0..1 Value of extension
Binding: Observation Extract Relationship Value Set (required)
.... valueBoolean boolean
.... valueCode code

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.value[x] Base required Observation Extract Relationship Value Set 📦4.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract"
.... valueBoolean boolean
.... valueCode code

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x] Base required Observation Extract Relationship Value Set 📦4.0.0 This IG

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

Simple Extension with the type boolean, code: Indicates how the observation-based extraction approach should be applied to an item or all items in a questionnaire. When set to true, the item is extracted as an independent Observation with no relationship to a parent Observation (If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present)). When set to a code value (e.g., member or component), the extracted Observation is related to a parent Observation according to the specified relationship. Mixing boolean and code values within the same item is invalid and will result in an error.

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron