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 Observation

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract Version: 4.0.0-ballot
Standards status: Trial-use 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

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

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

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

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

Simple Extension of 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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

This structure is derived from Extension

Summary

Simple Extension of 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 View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x]requiredObservationExtractRelationship (a valid code from Observation Extract Relationship Codes)
http://hl7.org/fhir/uv/sdc/ValueSet/observation-extract-relationship
from this IG