HealthSense Implementation Guide (Taltech)
0.1.0 - ci-build

HealthSense Implementation Guide (Taltech), published by Taltech. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/e-medlab/healthsense/ and changes regularly. See the Directory of published versions

Resource Profile: Vital Signs - Tobacco Use Frequency

Official URL: https://healthsense.e-medlab.com/StructureDefinition/hs-tobacco-use-frequency Version: 0.1.0
Draft as of 2025-12-30 Computable Name: HsTobaccoUseFrequencyObservation

Tubakatarbimise sagedus

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..* HsObservation Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Fixed Value: final
.... 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://terminology.hl7.org/CodeSystem/observation-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
..... display 1..1 string Representation defined by the system
Fixed Value: Vital Signs
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... Slices for coding Σ 1..1 Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:moist SΣ 0..1 Coding Frequency of moist tobacco use

Fixed Value: As shown (Frequency of moist tobacco use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228505008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:snuff SΣ 0..1 Coding Frequency of snuff use

Fixed Value: As shown (Frequency of snuff use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228495001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:chewing SΣ 0..1 Coding Frequency of chewing tobacco

Fixed Value: As shown (Frequency of chewing tobacco)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228519008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
... subject SΣ 1..1 Reference(Patient) Who and/or what the observation is about
... effective[x] SΣ 1..1 dateTime Clinically relevant time/time-period for observation
... performer SΣ 1..1 Reference(Organization | PractitionerRole) Who is responsible for the observation
... value[x] SΣC 0..1 Quantity Actual 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
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC 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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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 HsObservation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* HsObservation Measurements and simple assertions
... status 1..1 code registered | preliminary | final | amended +
Fixed Value: final
... category 1..1 CodeableConcept Classification of type of observation
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://terminology.hl7.org/CodeSystem/observation-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
..... display 1..1 string Representation defined by the system
Fixed Value: Vital Signs
... code
.... Slices for coding 1..1 Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:moist S 0..1 Coding Frequency of moist tobacco use
Fixed Value: As shown (Frequency of moist tobacco use)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228505008
..... coding:snuff S 0..1 Coding Frequency of snuff use
Fixed Value: As shown (Frequency of snuff use)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228495001
..... coding:chewing S 0..1 Coding Frequency of chewing tobacco
Fixed Value: As shown (Frequency of chewing tobacco)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228519008
... value[x] 0..1 Quantity Actual result
.... system 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
... interpretation 0..0 High, low, normal, etc.
... bodySite 0..0 Observed body part
... method 0..0 How it was done
... hasMember 0..0 Related resource that belongs to the Observation group
... component 0..0 Component results

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* HsObservation Measurements and simple assertions
Constraints: obs-6, obs-7
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Fixed Value: final
... category S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

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://terminology.hl7.org/CodeSystem/observation-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
..... display 1..1 string Representation defined by the system
Fixed Value: Vital Signs
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..1 Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:moist SΣ 0..1 Coding Frequency of moist tobacco use

Fixed Value: As shown (Frequency of moist tobacco use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228505008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:snuff SΣ 0..1 Coding Frequency of snuff use

Fixed Value: As shown (Frequency of snuff use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228495001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:chewing SΣ 0..1 Coding Frequency of chewing tobacco

Fixed Value: As shown (Frequency of chewing tobacco)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228519008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 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(Patient) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 dateTime Clinically relevant time/time-period for observation
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 1..1 Reference(Organization | PractitionerRole) Who is responsible for the observation
... value[x] SΣC 0..1 Quantity Actual 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
.... 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
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... note 0..* Annotation Comments about the observation
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from

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.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍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.

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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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 HsObservation

Summary

Mandatory: 1 element
Must-Support: 3 elements
Fixed: 4 elements
Prohibited: 5 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* HsObservation Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Fixed Value: final
.... 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://terminology.hl7.org/CodeSystem/observation-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
..... display 1..1 string Representation defined by the system
Fixed Value: Vital Signs
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... Slices for coding Σ 1..1 Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:moist SΣ 0..1 Coding Frequency of moist tobacco use

Fixed Value: As shown (Frequency of moist tobacco use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228505008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:snuff SΣ 0..1 Coding Frequency of snuff use

Fixed Value: As shown (Frequency of snuff use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228495001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:chewing SΣ 0..1 Coding Frequency of chewing tobacco

Fixed Value: As shown (Frequency of chewing tobacco)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228519008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
... subject SΣ 1..1 Reference(Patient) Who and/or what the observation is about
... effective[x] SΣ 1..1 dateTime Clinically relevant time/time-period for observation
... performer SΣ 1..1 Reference(Organization | PractitionerRole) Who is responsible for the observation
... value[x] SΣC 0..1 Quantity Actual 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
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC 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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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 HsObservation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* HsObservation Measurements and simple assertions
... status 1..1 code registered | preliminary | final | amended +
Fixed Value: final
... category 1..1 CodeableConcept Classification of type of observation
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://terminology.hl7.org/CodeSystem/observation-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
..... display 1..1 string Representation defined by the system
Fixed Value: Vital Signs
... code
.... Slices for coding 1..1 Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:moist S 0..1 Coding Frequency of moist tobacco use
Fixed Value: As shown (Frequency of moist tobacco use)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228505008
..... coding:snuff S 0..1 Coding Frequency of snuff use
Fixed Value: As shown (Frequency of snuff use)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228495001
..... coding:chewing S 0..1 Coding Frequency of chewing tobacco
Fixed Value: As shown (Frequency of chewing tobacco)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228519008
... value[x] 0..1 Quantity Actual result
.... system 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
... interpretation 0..0 High, low, normal, etc.
... bodySite 0..0 Observed body part
... method 0..0 How it was done
... hasMember 0..0 Related resource that belongs to the Observation group
... component 0..0 Component results

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* HsObservation Measurements and simple assertions
Constraints: obs-6, obs-7
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Fixed Value: final
... category S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

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://terminology.hl7.org/CodeSystem/observation-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
..... display 1..1 string Representation defined by the system
Fixed Value: Vital Signs
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..1 Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:moist SΣ 0..1 Coding Frequency of moist tobacco use

Fixed Value: As shown (Frequency of moist tobacco use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228505008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:snuff SΣ 0..1 Coding Frequency of snuff use

Fixed Value: As shown (Frequency of snuff use)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228495001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... coding:chewing SΣ 0..1 Coding Frequency of chewing tobacco

Fixed Value: As shown (Frequency of chewing tobacco)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228519008
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 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(Patient) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 dateTime Clinically relevant time/time-period for observation
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 1..1 Reference(Organization | PractitionerRole) Who is responsible for the observation
... value[x] SΣC 0..1 Quantity Actual 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
.... 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
... dataAbsentReason SC 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... note 0..* Annotation Comments about the observation
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from

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.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍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.

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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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 HsObservation

Summary

Mandatory: 1 element
Must-Support: 3 elements
Fixed: 4 elements
Prohibited: 5 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron