Onconova Implementation Guide
0.2.0 - ci-build

Onconova Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Lifestyle Profile

Official URL: http://onconova.github.io/fhir/StructureDefinition/onconova-lifestyle Version: 0.2.0
Active as of 2025-10-17 Computable Name: OnconovaLifestyle

A profile representing a (reported) observation on certain lifestyle characteristics of a cancer patient (e.g. smoking, drinking, and sleeping habits, environmental exposures, etc.).

It directly profiles the base FHIR Observation resource as this resource is not represented in mCODE, to add relevant observation components for the different lifestyle characteristics.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) assessment observation
Constraints: obs-6, obs-7, o-lif-req-1, o-lif-req-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SΣ 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept (USCDI) Type of observation (code / type)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA32823-9
..... display 1..1 string Representation defined by the system
Fixed Value: Lifestyle
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Cancer Patient Profile(0.2.0)) (USCDI) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) Not used in this profile
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SΣ 0..1 dateTime S (USCDI) Clinically relevant time/time-period for observation
... issued Σ 0..1 instant Not used in this profile
... performer SΣ 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) Not used in this profile
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... interpretation 0..* CodeableConcept Not used in this profile
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... bodySite 0..1 CodeableConcept Not used in this profile
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... specimen 0..1 Reference(Specimen) Not used in this profile
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange C 0..* BackboneElement Not used in this profile
Constraints: obs-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:smokingStatus SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 72166-2
....... display 1..1 string Representation defined by the system
Fixed Value: Tobacco smoking status
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: SmokingStatus (0.2.0) (required)
.... component:smokingPackyears SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8664-5
....... display 1..1 string Representation defined by the system
Fixed Value: Cigarettes smoked total (pack per year) - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Required Pattern: {pack-year}
.... component:smokingQuited SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 107339-4
....... display 1..1 string Representation defined by the system
Fixed Value: Temporary smoking cessation [Time]
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:alcoholConsumption SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1106630-7
....... display 1..1 string Representation defined by the system
Fixed Value: Alcohol use pattern
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: LOINC Answer List LL2179-1 (required)
.... component:nightSleep SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93832-4
....... display 1..1 string Representation defined by the system
Fixed Value: Sleep duration
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:recreationalDrug SΣ 0..* BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C84368
....... display 1..1 string Representation defined by the system
Fixed Value: Recreational Drug
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: RecreationalDrugs (0.2.0) (required)
.... component:exposures SΣ 0..* BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C16552
....... display 1..1 string Representation defined by the system
Fixed Value: Environmental Exposure
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: ExposureAgents (0.2.0) (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​value[x] Base required Smoking status 📍0.2.0 This IG
Observation.component:smokingPackyears.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​value[x] Base required ​ LOINC Answer Codes for LL2179-1 (missing link) 📦 unknown?
Observation.component:nightSleep.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​value[x] Base required Recreational Drugs 📍0.2.0 This IG
Observation.component:exposures.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:exposures.​value[x] Base required Exposure Agents 📍0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.implicitRules, Observation.modifierExtension, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.issued, Observation.performer, Observation.value[x], Observation.interpretation, Observation.bodySite, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.modifierExtension, Observation.hasMember, Observation.component, Observation.component.modifierExtension, Observation.component.code, Observation.component:smokingStatus, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingStatus.code, Observation.component:smokingStatus.value[x], Observation.component:smokingPackyears, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingPackyears.code, Observation.component:smokingPackyears.value[x], Observation.component:smokingPackyears.value[x].comparator, Observation.component:smokingPackyears.value[x].system, Observation.component:smokingPackyears.value[x].code, Observation.component:smokingQuited, Observation.component:smokingQuited.modifierExtension, Observation.component:smokingQuited.code, Observation.component:smokingQuited.value[x], Observation.component:alcoholConsumption, Observation.component:alcoholConsumption.modifierExtension, Observation.component:alcoholConsumption.code, Observation.component:alcoholConsumption.value[x], Observation.component:nightSleep, Observation.component:nightSleep.modifierExtension, Observation.component:nightSleep.code, Observation.component:nightSleep.value[x], Observation.component:recreationalDrug, Observation.component:recreationalDrug.modifierExtension, Observation.component:recreationalDrug.code, Observation.component:recreationalDrug.value[x], Observation.component:exposures, Observation.component:exposures.modifierExtension, Observation.component:exposures.code, Observation.component:exposures.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.modifierExtension, Observation.referenceRange.modifierExtension, Observation.component.modifierExtension, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingQuited.modifierExtension, Observation.component:alcoholConsumption.modifierExtension, Observation.component:nightSleep.modifierExtension, Observation.component:recreationalDrug.modifierExtension, Observation.component:exposures.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-lif-req-1 error Observation The subject element is required and must be provided. subject.exists() and subject.resolve().is(Patient)
o-lif-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) assessment observation
... status 1..1 code (USCDI) registered | preliminary | final | amended +
Required Pattern: final
... code 1..1 CodeableConcept (USCDI) Type of observation (code / type)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA32823-9
..... display 1..1 string Representation defined by the system
Fixed Value: Lifestyle
... subject 1..1 Reference(Cancer Patient Profile(0.2.0)) (USCDI) Who and/or what the observation is about
... encounter 0..1 Reference(Encounter) Not used in this profile
... effective[x] 0..1 dateTime (USCDI) Clinically relevant time/time-period for observation
... issued 0..1 instant Not used in this profile
... performer 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) Not used in this profile
... interpretation 0..* CodeableConcept Not used in this profile
... bodySite 0..1 CodeableConcept Not used in this profile
... specimen 0..1 Reference(Specimen) Not used in this profile
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange 0..* BackboneElement Not used in this profile
... hasMember 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:smokingStatus S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 72166-2
....... display 1..1 string Representation defined by the system
Fixed Value: Tobacco smoking status
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: SmokingStatus (0.2.0) (required)
.... component:smokingPackyears S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8664-5
....... display 1..1 string Representation defined by the system
Fixed Value: Cigarettes smoked total (pack per year) - Reported
..... value[x] S 0..1 Quantity Actual component result
...... system 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Required Pattern: {pack-year}
.... component:smokingQuited S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 107339-4
....... display 1..1 string Representation defined by the system
Fixed Value: Temporary smoking cessation [Time]
..... value[x] S 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:alcoholConsumption S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1106630-7
....... display 1..1 string Representation defined by the system
Fixed Value: Alcohol use pattern
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: LOINC Answer List LL2179-1 (required)
.... component:nightSleep S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93832-4
....... display 1..1 string Representation defined by the system
Fixed Value: Sleep duration
..... value[x] S 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:recreationalDrug S 0..* BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C84368
....... display 1..1 string Representation defined by the system
Fixed Value: Recreational Drug
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: RecreationalDrugs (0.2.0) (required)
.... component:exposures S 0..* BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C16552
....... display 1..1 string Representation defined by the system
Fixed Value: Environmental Exposure
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: ExposureAgents (0.2.0) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.component:smokingStatus.​value[x] Base required Smoking status 📍0.2.0 This IG
Observation.component:smokingQuited.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​value[x] Base required ​ LOINC Answer Codes for LL2179-1 (missing link) 📦 unknown?
Observation.component:nightSleep.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​value[x] Base required Recreational Drugs 📍0.2.0 This IG
Observation.component:exposures.​value[x] Base required Exposure Agents 📍0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
o-lif-req-1 error Observation The subject element is required and must be provided. subject.exists() and subject.resolve().is(Patient)
o-lif-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) assessment observation
Constraints: obs-6, obs-7, o-lif-req-1, o-lif-req-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept (USCDI) Type of observation (code / type)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA32823-9
..... display 1..1 string Representation defined by the system
Fixed Value: Lifestyle
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Cancer Patient Profile(0.2.0)) (USCDI) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) Not used in this profile
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SΣ 0..1 dateTime S (USCDI) Clinically relevant time/time-period for observation
... issued Σ 0..1 instant Not used in this profile
... performer SΣ 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) Not used in this profile
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept Not used in this profile
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Not used in this profile
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Not used in this profile
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange C 0..* BackboneElement Not used in this profile
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile(6.1.0) | US Core QuestionnaireResponse Profile(6.1.0) | ImagingStudy | Media | MolecularSequence) (USCDI) US Core Profiles or other resource the observation is made from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:smokingStatus SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 72166-2
....... display 1..1 string Representation defined by the system
Fixed Value: Tobacco smoking status
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: SmokingStatus (0.2.0) (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:smokingPackyears SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8664-5
....... display 1..1 string Representation defined by the system
Fixed Value: Cigarettes smoked total (pack per year) - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit Σ 0..1 string Unit representation
...... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Required Pattern: {pack-year}
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:smokingQuited SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 107339-4
....... display 1..1 string Representation defined by the system
Fixed Value: Temporary smoking cessation [Time]
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:alcoholConsumption SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1106630-7
....... display 1..1 string Representation defined by the system
Fixed Value: Alcohol use pattern
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: LOINC Answer List LL2179-1 (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:nightSleep SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93832-4
....... display 1..1 string Representation defined by the system
Fixed Value: Sleep duration
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:recreationalDrug SΣ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C84368
....... display 1..1 string Representation defined by the system
Fixed Value: Recreational Drug
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: RecreationalDrugs (0.2.0) (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:exposures SΣ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C16552
....... display 1..1 string Representation defined by the system
Fixed Value: Environmental Exposure
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: ExposureAgents (0.2.0) (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​value[x] Base required Smoking status 📍0.2.0 This IG
Observation.component:smokingStatus.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​value[x] Base required ​ LOINC Answer Codes for LL2179-1 (missing link) 📦 unknown?
Observation.component:alcoholConsumption.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​value[x] Base required Recreational Drugs 📍0.2.0 This IG
Observation.component:recreationalDrug.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:exposures.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:exposures.​value[x] Base required Exposure Agents 📍0.2.0 This IG
Observation.component:exposures.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:exposures.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.meta, Observation.implicitRules, Observation.language, Observation.text, Observation.extension, Observation.modifierExtension, Observation.identifier, Observation.basedOn, Observation.partOf, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.issued, Observation.performer, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.bodySite, Observation.method, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange, Observation.component:smokingStatus, Observation.component:smokingStatus.extension, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingStatus.code, Observation.component:smokingStatus.value[x], Observation.component:smokingStatus.dataAbsentReason, Observation.component:smokingStatus.interpretation, Observation.component:smokingStatus.referenceRange, Observation.component:smokingPackyears, Observation.component:smokingPackyears.extension, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingPackyears.code, Observation.component:smokingPackyears.value[x], Observation.component:smokingPackyears.value[x].extension, Observation.component:smokingPackyears.value[x].value, Observation.component:smokingPackyears.value[x].comparator, Observation.component:smokingPackyears.value[x].unit, Observation.component:smokingPackyears.value[x].system, Observation.component:smokingPackyears.value[x].code, Observation.component:smokingPackyears.dataAbsentReason, Observation.component:smokingPackyears.interpretation, Observation.component:smokingPackyears.referenceRange, Observation.component:smokingQuited, Observation.component:smokingQuited.extension, Observation.component:smokingQuited.modifierExtension, Observation.component:smokingQuited.code, Observation.component:smokingQuited.value[x], Observation.component:smokingQuited.dataAbsentReason, Observation.component:smokingQuited.interpretation, Observation.component:smokingQuited.referenceRange, Observation.component:alcoholConsumption, Observation.component:alcoholConsumption.extension, Observation.component:alcoholConsumption.modifierExtension, Observation.component:alcoholConsumption.code, Observation.component:alcoholConsumption.value[x], Observation.component:alcoholConsumption.dataAbsentReason, Observation.component:alcoholConsumption.interpretation, Observation.component:alcoholConsumption.referenceRange, Observation.component:nightSleep, Observation.component:nightSleep.extension, Observation.component:nightSleep.modifierExtension, Observation.component:nightSleep.code, Observation.component:nightSleep.value[x], Observation.component:nightSleep.dataAbsentReason, Observation.component:nightSleep.interpretation, Observation.component:nightSleep.referenceRange, Observation.component:recreationalDrug, Observation.component:recreationalDrug.extension, Observation.component:recreationalDrug.modifierExtension, Observation.component:recreationalDrug.code, Observation.component:recreationalDrug.value[x], Observation.component:recreationalDrug.dataAbsentReason, Observation.component:recreationalDrug.interpretation, Observation.component:recreationalDrug.referenceRange, Observation.component:exposures, Observation.component:exposures.extension, Observation.component:exposures.modifierExtension, Observation.component:exposures.code, Observation.component:exposures.value[x], Observation.component:exposures.dataAbsentReason, Observation.component:exposures.interpretation, Observation.component:exposures.referenceRange All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.extension, Observation.modifierExtension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.component.extension, Observation.component.modifierExtension, Observation.component:smokingStatus.extension, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingPackyears.extension, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingPackyears.value[x].extension, Observation.component:smokingQuited.extension, Observation.component:smokingQuited.modifierExtension, Observation.component:alcoholConsumption.extension, Observation.component:alcoholConsumption.modifierExtension, Observation.component:nightSleep.extension, Observation.component:nightSleep.modifierExtension, Observation.component:recreationalDrug.extension, Observation.component:recreationalDrug.modifierExtension, Observation.component:exposures.extension, Observation.component:exposures.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-lif-req-1 error Observation The subject element is required and must be provided. subject.exists() and subject.resolve().is(Patient)
o-lif-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from USCoreSimpleObservationProfile

Summary

Must-Support: 21 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.component

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) assessment observation
Constraints: obs-6, obs-7, o-lif-req-1, o-lif-req-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SΣ 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept (USCDI) Type of observation (code / type)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA32823-9
..... display 1..1 string Representation defined by the system
Fixed Value: Lifestyle
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Cancer Patient Profile(0.2.0)) (USCDI) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) Not used in this profile
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SΣ 0..1 dateTime S (USCDI) Clinically relevant time/time-period for observation
... issued Σ 0..1 instant Not used in this profile
... performer SΣ 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) Not used in this profile
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... interpretation 0..* CodeableConcept Not used in this profile
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... bodySite 0..1 CodeableConcept Not used in this profile
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... specimen 0..1 Reference(Specimen) Not used in this profile
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange C 0..* BackboneElement Not used in this profile
Constraints: obs-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:smokingStatus SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 72166-2
....... display 1..1 string Representation defined by the system
Fixed Value: Tobacco smoking status
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: SmokingStatus (0.2.0) (required)
.... component:smokingPackyears SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8664-5
....... display 1..1 string Representation defined by the system
Fixed Value: Cigarettes smoked total (pack per year) - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Required Pattern: {pack-year}
.... component:smokingQuited SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 107339-4
....... display 1..1 string Representation defined by the system
Fixed Value: Temporary smoking cessation [Time]
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:alcoholConsumption SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1106630-7
....... display 1..1 string Representation defined by the system
Fixed Value: Alcohol use pattern
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: LOINC Answer List LL2179-1 (required)
.... component:nightSleep SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93832-4
....... display 1..1 string Representation defined by the system
Fixed Value: Sleep duration
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:recreationalDrug SΣ 0..* BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C84368
....... display 1..1 string Representation defined by the system
Fixed Value: Recreational Drug
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: RecreationalDrugs (0.2.0) (required)
.... component:exposures SΣ 0..* BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C16552
....... display 1..1 string Representation defined by the system
Fixed Value: Environmental Exposure
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: ExposureAgents (0.2.0) (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​value[x] Base required Smoking status 📍0.2.0 This IG
Observation.component:smokingPackyears.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​value[x] Base required ​ LOINC Answer Codes for LL2179-1 (missing link) 📦 unknown?
Observation.component:nightSleep.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​value[x] Base required Recreational Drugs 📍0.2.0 This IG
Observation.component:exposures.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:exposures.​value[x] Base required Exposure Agents 📍0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.implicitRules, Observation.modifierExtension, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.issued, Observation.performer, Observation.value[x], Observation.interpretation, Observation.bodySite, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.modifierExtension, Observation.hasMember, Observation.component, Observation.component.modifierExtension, Observation.component.code, Observation.component:smokingStatus, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingStatus.code, Observation.component:smokingStatus.value[x], Observation.component:smokingPackyears, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingPackyears.code, Observation.component:smokingPackyears.value[x], Observation.component:smokingPackyears.value[x].comparator, Observation.component:smokingPackyears.value[x].system, Observation.component:smokingPackyears.value[x].code, Observation.component:smokingQuited, Observation.component:smokingQuited.modifierExtension, Observation.component:smokingQuited.code, Observation.component:smokingQuited.value[x], Observation.component:alcoholConsumption, Observation.component:alcoholConsumption.modifierExtension, Observation.component:alcoholConsumption.code, Observation.component:alcoholConsumption.value[x], Observation.component:nightSleep, Observation.component:nightSleep.modifierExtension, Observation.component:nightSleep.code, Observation.component:nightSleep.value[x], Observation.component:recreationalDrug, Observation.component:recreationalDrug.modifierExtension, Observation.component:recreationalDrug.code, Observation.component:recreationalDrug.value[x], Observation.component:exposures, Observation.component:exposures.modifierExtension, Observation.component:exposures.code, Observation.component:exposures.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.modifierExtension, Observation.referenceRange.modifierExtension, Observation.component.modifierExtension, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingQuited.modifierExtension, Observation.component:alcoholConsumption.modifierExtension, Observation.component:nightSleep.modifierExtension, Observation.component:recreationalDrug.modifierExtension, Observation.component:exposures.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-lif-req-1 error Observation The subject element is required and must be provided. subject.exists() and subject.resolve().is(Patient)
o-lif-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) assessment observation
... status 1..1 code (USCDI) registered | preliminary | final | amended +
Required Pattern: final
... code 1..1 CodeableConcept (USCDI) Type of observation (code / type)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA32823-9
..... display 1..1 string Representation defined by the system
Fixed Value: Lifestyle
... subject 1..1 Reference(Cancer Patient Profile(0.2.0)) (USCDI) Who and/or what the observation is about
... encounter 0..1 Reference(Encounter) Not used in this profile
... effective[x] 0..1 dateTime (USCDI) Clinically relevant time/time-period for observation
... issued 0..1 instant Not used in this profile
... performer 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) Not used in this profile
... interpretation 0..* CodeableConcept Not used in this profile
... bodySite 0..1 CodeableConcept Not used in this profile
... specimen 0..1 Reference(Specimen) Not used in this profile
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange 0..* BackboneElement Not used in this profile
... hasMember 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:smokingStatus S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 72166-2
....... display 1..1 string Representation defined by the system
Fixed Value: Tobacco smoking status
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: SmokingStatus (0.2.0) (required)
.... component:smokingPackyears S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8664-5
....... display 1..1 string Representation defined by the system
Fixed Value: Cigarettes smoked total (pack per year) - Reported
..... value[x] S 0..1 Quantity Actual component result
...... system 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Required Pattern: {pack-year}
.... component:smokingQuited S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 107339-4
....... display 1..1 string Representation defined by the system
Fixed Value: Temporary smoking cessation [Time]
..... value[x] S 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:alcoholConsumption S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1106630-7
....... display 1..1 string Representation defined by the system
Fixed Value: Alcohol use pattern
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: LOINC Answer List LL2179-1 (required)
.... component:nightSleep S 0..1 BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93832-4
....... display 1..1 string Representation defined by the system
Fixed Value: Sleep duration
..... value[x] S 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
.... component:recreationalDrug S 0..* BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C84368
....... display 1..1 string Representation defined by the system
Fixed Value: Recreational Drug
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: RecreationalDrugs (0.2.0) (required)
.... component:exposures S 0..* BackboneElement Component results
..... code S 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C16552
....... display 1..1 string Representation defined by the system
Fixed Value: Environmental Exposure
..... value[x] S 0..1 CodeableConcept Actual component result
Binding: ExposureAgents (0.2.0) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.component:smokingStatus.​value[x] Base required Smoking status 📍0.2.0 This IG
Observation.component:smokingQuited.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​value[x] Base required ​ LOINC Answer Codes for LL2179-1 (missing link) 📦 unknown?
Observation.component:nightSleep.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​value[x] Base required Recreational Drugs 📍0.2.0 This IG
Observation.component:exposures.​value[x] Base required Exposure Agents 📍0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
o-lif-req-1 error Observation The subject element is required and must be provided. subject.exists() and subject.resolve().is(Patient)
o-lif-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) assessment observation
Constraints: obs-6, obs-7, o-lif-req-1, o-lif-req-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept (USCDI) Type of observation (code / type)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA32823-9
..... display 1..1 string Representation defined by the system
Fixed Value: Lifestyle
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Cancer Patient Profile(0.2.0)) (USCDI) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) Not used in this profile
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SΣ 0..1 dateTime S (USCDI) Clinically relevant time/time-period for observation
... issued Σ 0..1 instant Not used in this profile
... performer SΣ 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) Not used in this profile
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept Not used in this profile
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Not used in this profile
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Not used in this profile
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange C 0..* BackboneElement Not used in this profile
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile(6.1.0) | US Core QuestionnaireResponse Profile(6.1.0) | ImagingStudy | Media | MolecularSequence) (USCDI) US Core Profiles or other resource the observation is made from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:smokingStatus SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 72166-2
....... display 1..1 string Representation defined by the system
Fixed Value: Tobacco smoking status
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: SmokingStatus (0.2.0) (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:smokingPackyears SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8664-5
....... display 1..1 string Representation defined by the system
Fixed Value: Cigarettes smoked total (pack per year) - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit Σ 0..1 string Unit representation
...... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Required Pattern: {pack-year}
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:smokingQuited SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 107339-4
....... display 1..1 string Representation defined by the system
Fixed Value: Temporary smoking cessation [Time]
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:alcoholConsumption SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1106630-7
....... display 1..1 string Representation defined by the system
Fixed Value: Alcohol use pattern
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: LOINC Answer List LL2179-1 (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:nightSleep SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 93832-4
....... display 1..1 string Representation defined by the system
Fixed Value: Sleep duration
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 Quantity Actual component result
Binding: UnitsOfTime (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:recreationalDrug SΣ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C84368
....... display 1..1 string Representation defined by the system
Fixed Value: Recreational Drug
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: RecreationalDrugs (0.2.0) (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:exposures SΣ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C16552
....... display 1..1 string Representation defined by the system
Fixed Value: Environmental Exposure
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] SΣ 0..1 CodeableConcept Actual component result
Binding: ExposureAgents (0.2.0) (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​value[x] Base required Smoking status 📍0.2.0 This IG
Observation.component:smokingStatus.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:smokingStatus.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:smokingPackyears.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:smokingQuited.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​value[x] Base required ​ LOINC Answer Codes for LL2179-1 (missing link) 📦 unknown?
Observation.component:alcoholConsumption.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:alcoholConsumption.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​value[x] Base required UnitsOfTime 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:nightSleep.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​value[x] Base required Recreational Drugs 📍0.2.0 This IG
Observation.component:recreationalDrug.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:recreationalDrug.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:exposures.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:exposures.​value[x] Base required Exposure Agents 📍0.2.0 This IG
Observation.component:exposures.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:exposures.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.meta, Observation.implicitRules, Observation.language, Observation.text, Observation.extension, Observation.modifierExtension, Observation.identifier, Observation.basedOn, Observation.partOf, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.issued, Observation.performer, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.bodySite, Observation.method, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange, Observation.component:smokingStatus, Observation.component:smokingStatus.extension, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingStatus.code, Observation.component:smokingStatus.value[x], Observation.component:smokingStatus.dataAbsentReason, Observation.component:smokingStatus.interpretation, Observation.component:smokingStatus.referenceRange, Observation.component:smokingPackyears, Observation.component:smokingPackyears.extension, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingPackyears.code, Observation.component:smokingPackyears.value[x], Observation.component:smokingPackyears.value[x].extension, Observation.component:smokingPackyears.value[x].value, Observation.component:smokingPackyears.value[x].comparator, Observation.component:smokingPackyears.value[x].unit, Observation.component:smokingPackyears.value[x].system, Observation.component:smokingPackyears.value[x].code, Observation.component:smokingPackyears.dataAbsentReason, Observation.component:smokingPackyears.interpretation, Observation.component:smokingPackyears.referenceRange, Observation.component:smokingQuited, Observation.component:smokingQuited.extension, Observation.component:smokingQuited.modifierExtension, Observation.component:smokingQuited.code, Observation.component:smokingQuited.value[x], Observation.component:smokingQuited.dataAbsentReason, Observation.component:smokingQuited.interpretation, Observation.component:smokingQuited.referenceRange, Observation.component:alcoholConsumption, Observation.component:alcoholConsumption.extension, Observation.component:alcoholConsumption.modifierExtension, Observation.component:alcoholConsumption.code, Observation.component:alcoholConsumption.value[x], Observation.component:alcoholConsumption.dataAbsentReason, Observation.component:alcoholConsumption.interpretation, Observation.component:alcoholConsumption.referenceRange, Observation.component:nightSleep, Observation.component:nightSleep.extension, Observation.component:nightSleep.modifierExtension, Observation.component:nightSleep.code, Observation.component:nightSleep.value[x], Observation.component:nightSleep.dataAbsentReason, Observation.component:nightSleep.interpretation, Observation.component:nightSleep.referenceRange, Observation.component:recreationalDrug, Observation.component:recreationalDrug.extension, Observation.component:recreationalDrug.modifierExtension, Observation.component:recreationalDrug.code, Observation.component:recreationalDrug.value[x], Observation.component:recreationalDrug.dataAbsentReason, Observation.component:recreationalDrug.interpretation, Observation.component:recreationalDrug.referenceRange, Observation.component:exposures, Observation.component:exposures.extension, Observation.component:exposures.modifierExtension, Observation.component:exposures.code, Observation.component:exposures.value[x], Observation.component:exposures.dataAbsentReason, Observation.component:exposures.interpretation, Observation.component:exposures.referenceRange All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.extension, Observation.modifierExtension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.component.extension, Observation.component.modifierExtension, Observation.component:smokingStatus.extension, Observation.component:smokingStatus.modifierExtension, Observation.component:smokingPackyears.extension, Observation.component:smokingPackyears.modifierExtension, Observation.component:smokingPackyears.value[x].extension, Observation.component:smokingQuited.extension, Observation.component:smokingQuited.modifierExtension, Observation.component:alcoholConsumption.extension, Observation.component:alcoholConsumption.modifierExtension, Observation.component:nightSleep.extension, Observation.component:nightSleep.modifierExtension, Observation.component:recreationalDrug.extension, Observation.component:recreationalDrug.modifierExtension, Observation.component:exposures.extension, Observation.component:exposures.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-lif-req-1 error Observation The subject element is required and must be provided. subject.exists() and subject.resolve().is(Patient)
o-lif-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from USCoreSimpleObservationProfile

Summary

Must-Support: 21 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.component

 

Other representations of profile: CSV, Excel, Schematron