US Veterans Health Administration FHIR Map Set Implementation Guide
2.0.0 - 251201 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 2.0.0 See the Directory of published versions

Resource Profile: Vital Signs: SpO2

Official URL: http://va.gov/fhir/StructureDefinition/VitalSignsSpO2 Version: 2.0.0
Active as of 2025-12-02 Computable Name: VitalSignsSpO2

This StructureDefinition contains the maps for VistA file GMRV VITAL MEASUREMENT (120.5) to us-core-pulse-oximetry.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Vital Signs: SpO2«us-core-pulse-oximetry»VitalSignsSpO2performersubjectVAOrganizationVAPatient

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..* USCorePulseOximetryProfile(6.1.0) US Core Pulse Oximetry Profile
This profile also complies with the profile US Core Pulse Oximetry Profile (7.0.0)
Constraints: obs-6, obs-7, vs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observation-deviceCode S 0..1 (Complex) A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-deviceCode"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsMeasurementDevice FHIR (required): see mapping VF_VitalsMeasurementDevice
.... extension:observation-bodyPosition S 0..1 (Complex) The body position during the observation
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsBodyPosition FHIR (required): see mapping VF_VitalsBodyPosition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/fhir/sid/{sta3n}/120.5
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣC 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Constraints: vsso-14-655, vsso-14-656
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:VSCat S 1..1 CodeableConcept (USCDI) 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
..... coding SΣ 1..* Coding (USCDI) Code defined by a terminology system
...... system SΣ 1..1 uri (USCDI) Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code SΣ 1..1 code (USCDI) Symbol in syntax defined by the system
Fixed Value: vital-signs
... code SΣ 1..1 CodeableConcept (USCDI) Oxygen Saturation by Pulse Oximetry
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... Slices for coding SΣ 2..* Coding (USCDI) Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Binding: VitalsCodes FHIR (required): see mapping VF_VitalsCodes
..... coding:PulseOx SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 59408-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... coding:O2Sat SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 2708-6
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
... subject SΣ 1..1 Reference(VAPatient) (USCDI) Who and/or what the observation is about
... Slices for effective[x] SΣC 1..1 (USCDI) Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
Constraints: vs-1
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime S (USCDI) Often just a dateTime for Vital Signs
Constraints: vs-1
... issued SΣ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(VAOrganization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 (USCDI) Vital Signs Value
Slice: Unordered, Closed by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueQuantity SΣC 0..1 Quantity (USCDI) Oxygen Saturation by Pulse Oximetry Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
..... value SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-664
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string (USCDI) Unit representation
..... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code (USCDI) Coded form of the unit
Fixed Value: %
... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... bodySite S 0..1 CodeableConcept Observed body part
Binding: VitalsBodySite FHIR (required): see mapping VF_VitalsBodySite
... method S 0..1 CodeableConcept How it was done
Binding: VitalsMethod FHIR (required): see mapping VF_VitalsMethod
... Slices for component SΣC 0..* BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
Constraints: vs-3
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
..... value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:FlowRate SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen flow rate
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1239-3
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: 3151-8
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... value SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1239
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1239-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1239-1
Fixed Value: L/min
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:Concentration SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen concentration
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1240-3
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: 3150-0
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... value SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1240
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1240-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1240-1
Fixed Value: %
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:va-pre-condition SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsPrecondition FHIR (required): see mapping VF_VitalsPrecondition
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:va-pre-condition-device SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsQualifyingDevice FHIR (required): see mapping VF_VitalsQualifyingDevice
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component 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.extension:observation-deviceCode.​value[x] Base required VitalsMeasurementDevice FHIR 📦2.0.0 This IG
Observation.extension:observation-bodyPosition.​value[x] Base required VitalsBodyPosition FHIR 📦2.0.0 This IG
Observation.identifier.​use Base required IdentifierUse 📍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:VSCat Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.code.coding Base required VitalsCodes FHIR 📦2.0.0 This IG
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.bodySite Base required VitalsBodySite FHIR 📦2.0.0 This IG
Observation.method Base required VitalsMethod FHIR 📦2.0.0 This IG
Observation.component.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:FlowRate.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:FlowRate.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:Concentration.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:Concentration.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:Concentration.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:Concentration.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition.​value[x]:valueCodeableConcept Base required VitalsPrecondition FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition-device.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​value[x]:valueCodeableConcept Base required VitalsQualifyingDevice FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition-device.​dataAbsentReason Base extensible DataAbsentReason 📦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()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day ($this as dateTime).toString().length() >= 8
vs-2 error Observation If there is no component or hasMember element then either a value[x] or a data absent reason must be present. (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
vs-3 error Observation.component, Observation.component:FlowRate, Observation.component:Concentration, Observation.component:va-pre-condition, Observation.component:va-pre-condition-device If there is no a value a data absent reason must be present value.exists() or dataAbsentReason.exists()
vsso-14-655 best practice Observation.status If (120.5-4) is null then fixed value #final true
vsso-14-656 best practice Observation.status If (120.5-4) is not null then fixed value #entered-in-error true
vsso-14-664 best practice Observation.value[x]:valueQuantity.value If VUID not = 4500634 then source value from (120.5-1.2) true
vsso-14-1239 best practice Observation.component:FlowRate.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Flow() true
vsso-14-1240 best practice Observation.component:Concentration.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Consentration() true
vsso-14-1239-1 best practice Observation.component:FlowRate.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #L/min true
vsso-14-1239-2 best practice Observation.component:FlowRate.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value L/min true
vsso-14-1239-3 best practice Observation.component:FlowRate.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3151-8 true
vsso-14-1240-1 best practice Observation.component:Concentration.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #% true
vsso-14-1240-2 best practice Observation.component:Concentration.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value % true
vsso-14-1240-3 best practice Observation.component:Concentration.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3150-0 true

This structure is derived from USCorePulseOximetryProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCorePulseOximetryProfile(6.1.0) US Core Pulse Oximetry Profile
This profile also complies with the profile US Core Pulse Oximetry Profile (7.0.0)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observation-deviceCode S 0..1 (Complex) A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsMeasurementDevice FHIR (required): see mapping VF_VitalsMeasurementDevice
.... extension:observation-bodyPosition S 0..1 (Complex) The body position during the observation
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsBodyPosition FHIR (required): see mapping VF_VitalsBodyPosition
... identifier
.... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/fhir/sid/{sta3n}/120.5
.... value S 0..1 string The value that is unique
... status C 1..1 code (USCDI) registered | preliminary | final | amended +
Constraints: vsso-14-655, vsso-14-656
.... category:VSCat 1..1 CodeableConcept (USCDI) 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
... code
.... coding 2..* Coding (USCDI) Code defined by a terminology system
Binding: VitalsCodes FHIR (required): see mapping VF_VitalsCodes
... subject 1..1 Reference(VAPatient) (USCDI) Who and/or what the observation is about
... Slices for effective[x] 1..1 dateTime, Period (USCDI) Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime S (USCDI) Often just a dateTime for Vital Signs
... issued S 0..1 instant Date/Time this version was made available
... performer S 0..* Reference(VAOrganization) Who is responsible for the observation
... Slices for value[x] Content/Rules for all slices
.... value[x]:valueQuantity 0..1 Quantity (USCDI) Oxygen Saturation by Pulse Oximetry Value
..... value C 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-664
..... code 1..1 code (USCDI) Coded form of the unit
... bodySite S 0..1 CodeableConcept Observed body part
Binding: VitalsBodySite FHIR (required): see mapping VF_VitalsBodySite
... method S 0..1 CodeableConcept How it was done
Binding: VitalsMethod FHIR (required): see mapping VF_VitalsMethod
... Slices for component Content/Rules for all slices
.... component:FlowRate 0..1 BackboneElement (USCDI) Inhaled oxygen flow rate
..... code C 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Constraints: vsso-14-1239-3
..... value[x]
...... value C 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1239
...... unit C 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1239-2
...... code C 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1239-1
.... component:Concentration 0..1 BackboneElement (USCDI) Inhaled oxygen concentration
..... code C 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Constraints: vsso-14-1240-3
..... value[x]
...... value C 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1240
...... unit C 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1240-2
...... code C 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1240-1
.... component:va-pre-condition S 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
..... code 1..1 CodeableConcept (USCDI) 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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
..... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsPrecondition FHIR (required): see mapping VF_VitalsPrecondition
.... component:va-pre-condition-device S 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
..... code 1..1 CodeableConcept (USCDI) 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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
..... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsQualifyingDevice FHIR (required): see mapping VF_VitalsQualifyingDevice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.extension:observation-deviceCode.​value[x] Base required VitalsMeasurementDevice FHIR 📦2.0.0 This IG
Observation.extension:observation-bodyPosition.​value[x] Base required VitalsBodyPosition FHIR 📦2.0.0 This IG
Observation.code.coding Base required VitalsCodes FHIR 📦2.0.0 This IG
Observation.bodySite Base required VitalsBodySite FHIR 📦2.0.0 This IG
Observation.method Base required VitalsMethod FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition.​value[x]:valueCodeableConcept Base required VitalsPrecondition FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition-device.​value[x]:valueCodeableConcept Base required VitalsQualifyingDevice FHIR 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
vsso-14-655 best practice Observation.status If (120.5-4) is null then fixed value #final true
vsso-14-656 best practice Observation.status If (120.5-4) is not null then fixed value #entered-in-error true
vsso-14-664 best practice Observation.value[x]:valueQuantity.value If VUID not = 4500634 then source value from (120.5-1.2) true
vsso-14-1239 best practice Observation.component:FlowRate.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Flow() true
vsso-14-1240 best practice Observation.component:Concentration.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Consentration() true
vsso-14-1239-1 best practice Observation.component:FlowRate.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #L/min true
vsso-14-1239-2 best practice Observation.component:FlowRate.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value L/min true
vsso-14-1239-3 best practice Observation.component:FlowRate.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3151-8 true
vsso-14-1240-1 best practice Observation.component:Concentration.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #% true
vsso-14-1240-2 best practice Observation.component:Concentration.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value % true
vsso-14-1240-3 best practice Observation.component:Concentration.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3150-0 true
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCorePulseOximetryProfile(6.1.0) US Core Pulse Oximetry Profile
This profile also complies with the profile US Core Pulse Oximetry Profile (7.0.0)
Constraints: obs-6, obs-7, vs-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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observation-deviceCode S 0..1 (Complex) A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-deviceCode"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsMeasurementDevice FHIR (required): see mapping VF_VitalsMeasurementDevice
.... extension:observation-bodyPosition S 0..1 (Complex) The body position during the observation
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsBodyPosition FHIR (required): see mapping VF_VitalsBodyPosition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/fhir/sid/{sta3n}/120.5
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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ΣC 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Constraints: vsso-14-655, vsso-14-656
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:VSCat S 1..1 CodeableConcept (USCDI) 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..* Coding (USCDI) Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri (USCDI) 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 SΣ 1..1 code (USCDI) Symbol in syntax defined by the system
Fixed Value: vital-signs
...... display Σ 0..1 string Representation defined by the system
...... 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 (USCDI) Oxygen Saturation by Pulse Oximetry
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... 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 SΣ 2..* Coding (USCDI) Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Binding: VitalsCodes FHIR (required): see mapping VF_VitalsCodes
..... coding:PulseOx SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 59408-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... coding:O2Sat SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 2708-6
...... display 0..1 string Representation defined by the system
...... 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(VAPatient) (USCDI) 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
... Slices for effective[x] SΣC 1..1 (USCDI) Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
Constraints: vs-1
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime S (USCDI) Often just a dateTime for Vital Signs
Constraints: vs-1
... issued SΣ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(VAOrganization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 (USCDI) Vital Signs Value
Slice: Unordered, Closed by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueQuantity SΣC 0..1 Quantity (USCDI) Oxygen Saturation by Pulse Oximetry Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
..... 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 SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-664
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string (USCDI) Unit representation
..... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code (USCDI) Coded form of the unit
Fixed Value: %
... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the 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.
... note 0..* Annotation Comments about the observation
... bodySite S 0..1 CodeableConcept Observed body part
Binding: VitalsBodySite FHIR (required): see mapping VF_VitalsBodySite
... method S 0..1 CodeableConcept How it was done
Binding: VitalsMethod FHIR (required): see mapping VF_VitalsMethod
... 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 Low Range, if relevant
.... high C 0..1 SimpleQuantity 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(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Used when reporting vital signs panel components
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Related measurements the observation is made from
... Slices for component SΣC 0..* BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
Constraints: vs-3
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
..... value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:FlowRate SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen flow rate
Constraints: vs-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
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1239-3
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: 3151-8
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... 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 SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1239
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1239-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1239-1
Fixed Value: L/min
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:Concentration SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen concentration
Constraints: vs-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
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1240-3
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: 3150-0
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... 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 SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1240
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1240-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1240-1
Fixed Value: %
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:va-pre-condition SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-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
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsPrecondition FHIR (required): see mapping VF_VitalsPrecondition
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:va-pre-condition-device SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-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
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsQualifyingDevice FHIR (required): see mapping VF_VitalsQualifyingDevice
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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.extension:observation-deviceCode.​value[x] Base required VitalsMeasurementDevice FHIR 📦2.0.0 This IG
Observation.extension:observation-bodyPosition.​value[x] Base required VitalsBodyPosition FHIR 📦2.0.0 This IG
Observation.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Observation.identifier.​type Base extensible IdentifierType 📍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:VSCat Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.code.coding Base required VitalsCodes FHIR 📦2.0.0 This IG
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍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 required VitalsBodySite FHIR 📦2.0.0 This IG
Observation.method Base required VitalsMethod FHIR 📦2.0.0 This IG
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 extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component.​value[x] Base extensible Vital Signs Units 📍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:FlowRate.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:FlowRate.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:FlowRate.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component:Concentration.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:Concentration.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:Concentration.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:Concentration.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:Concentration.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition.​value[x]:valueCodeableConcept Base required VitalsPrecondition FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition-device.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​value[x]:valueCodeableConcept Base required VitalsQualifyingDevice FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition-device.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​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()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day ($this as dateTime).toString().length() >= 8
vs-2 error Observation If there is no component or hasMember element then either a value[x] or a data absent reason must be present. (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
vs-3 error Observation.component, Observation.component:FlowRate, Observation.component:Concentration, Observation.component:va-pre-condition, Observation.component:va-pre-condition-device If there is no a value a data absent reason must be present value.exists() or dataAbsentReason.exists()
vsso-14-655 best practice Observation.status If (120.5-4) is null then fixed value #final true
vsso-14-656 best practice Observation.status If (120.5-4) is not null then fixed value #entered-in-error true
vsso-14-664 best practice Observation.value[x]:valueQuantity.value If VUID not = 4500634 then source value from (120.5-1.2) true
vsso-14-1239 best practice Observation.component:FlowRate.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Flow() true
vsso-14-1240 best practice Observation.component:Concentration.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Consentration() true
vsso-14-1239-1 best practice Observation.component:FlowRate.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #L/min true
vsso-14-1239-2 best practice Observation.component:FlowRate.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value L/min true
vsso-14-1239-3 best practice Observation.component:FlowRate.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3151-8 true
vsso-14-1240-1 best practice Observation.component:Concentration.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #% true
vsso-14-1240-2 best practice Observation.component:Concentration.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value % true
vsso-14-1240-3 best practice Observation.component:Concentration.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3150-0 true

This structure is derived from USCorePulseOximetryProfile

Summary

Must-Support: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.effective[x]
  • The element 1 is sliced based on the value of Observation.component.value[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCorePulseOximetryProfile(6.1.0) US Core Pulse Oximetry Profile
This profile also complies with the profile US Core Pulse Oximetry Profile (7.0.0)
Constraints: obs-6, obs-7, vs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observation-deviceCode S 0..1 (Complex) A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-deviceCode"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsMeasurementDevice FHIR (required): see mapping VF_VitalsMeasurementDevice
.... extension:observation-bodyPosition S 0..1 (Complex) The body position during the observation
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsBodyPosition FHIR (required): see mapping VF_VitalsBodyPosition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/fhir/sid/{sta3n}/120.5
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣC 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Constraints: vsso-14-655, vsso-14-656
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:VSCat S 1..1 CodeableConcept (USCDI) 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
..... coding SΣ 1..* Coding (USCDI) Code defined by a terminology system
...... system SΣ 1..1 uri (USCDI) Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code SΣ 1..1 code (USCDI) Symbol in syntax defined by the system
Fixed Value: vital-signs
... code SΣ 1..1 CodeableConcept (USCDI) Oxygen Saturation by Pulse Oximetry
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... Slices for coding SΣ 2..* Coding (USCDI) Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Binding: VitalsCodes FHIR (required): see mapping VF_VitalsCodes
..... coding:PulseOx SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 59408-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... coding:O2Sat SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 2708-6
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
... subject SΣ 1..1 Reference(VAPatient) (USCDI) Who and/or what the observation is about
... Slices for effective[x] SΣC 1..1 (USCDI) Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
Constraints: vs-1
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime S (USCDI) Often just a dateTime for Vital Signs
Constraints: vs-1
... issued SΣ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(VAOrganization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 (USCDI) Vital Signs Value
Slice: Unordered, Closed by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueQuantity SΣC 0..1 Quantity (USCDI) Oxygen Saturation by Pulse Oximetry Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
..... value SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-664
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string (USCDI) Unit representation
..... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code (USCDI) Coded form of the unit
Fixed Value: %
... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... bodySite S 0..1 CodeableConcept Observed body part
Binding: VitalsBodySite FHIR (required): see mapping VF_VitalsBodySite
... method S 0..1 CodeableConcept How it was done
Binding: VitalsMethod FHIR (required): see mapping VF_VitalsMethod
... Slices for component SΣC 0..* BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
Constraints: vs-3
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
..... value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:FlowRate SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen flow rate
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1239-3
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: 3151-8
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... value SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1239
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1239-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1239-1
Fixed Value: L/min
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:Concentration SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen concentration
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1240-3
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: 3150-0
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... value SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1240
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1240-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1240-1
Fixed Value: %
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:va-pre-condition SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsPrecondition FHIR (required): see mapping VF_VitalsPrecondition
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... component:va-pre-condition-device SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsQualifyingDevice FHIR (required): see mapping VF_VitalsQualifyingDevice
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the component 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.extension:observation-deviceCode.​value[x] Base required VitalsMeasurementDevice FHIR 📦2.0.0 This IG
Observation.extension:observation-bodyPosition.​value[x] Base required VitalsBodyPosition FHIR 📦2.0.0 This IG
Observation.identifier.​use Base required IdentifierUse 📍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:VSCat Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.code.coding Base required VitalsCodes FHIR 📦2.0.0 This IG
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.bodySite Base required VitalsBodySite FHIR 📦2.0.0 This IG
Observation.method Base required VitalsMethod FHIR 📦2.0.0 This IG
Observation.component.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:FlowRate.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:FlowRate.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:Concentration.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:Concentration.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:Concentration.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:Concentration.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition.​value[x]:valueCodeableConcept Base required VitalsPrecondition FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition-device.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​value[x]:valueCodeableConcept Base required VitalsQualifyingDevice FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition-device.​dataAbsentReason Base extensible DataAbsentReason 📦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()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day ($this as dateTime).toString().length() >= 8
vs-2 error Observation If there is no component or hasMember element then either a value[x] or a data absent reason must be present. (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
vs-3 error Observation.component, Observation.component:FlowRate, Observation.component:Concentration, Observation.component:va-pre-condition, Observation.component:va-pre-condition-device If there is no a value a data absent reason must be present value.exists() or dataAbsentReason.exists()
vsso-14-655 best practice Observation.status If (120.5-4) is null then fixed value #final true
vsso-14-656 best practice Observation.status If (120.5-4) is not null then fixed value #entered-in-error true
vsso-14-664 best practice Observation.value[x]:valueQuantity.value If VUID not = 4500634 then source value from (120.5-1.2) true
vsso-14-1239 best practice Observation.component:FlowRate.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Flow() true
vsso-14-1240 best practice Observation.component:Concentration.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Consentration() true
vsso-14-1239-1 best practice Observation.component:FlowRate.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #L/min true
vsso-14-1239-2 best practice Observation.component:FlowRate.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value L/min true
vsso-14-1239-3 best practice Observation.component:FlowRate.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3151-8 true
vsso-14-1240-1 best practice Observation.component:Concentration.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #% true
vsso-14-1240-2 best practice Observation.component:Concentration.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value % true
vsso-14-1240-3 best practice Observation.component:Concentration.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3150-0 true

Differential View

This structure is derived from USCorePulseOximetryProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCorePulseOximetryProfile(6.1.0) US Core Pulse Oximetry Profile
This profile also complies with the profile US Core Pulse Oximetry Profile (7.0.0)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observation-deviceCode S 0..1 (Complex) A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsMeasurementDevice FHIR (required): see mapping VF_VitalsMeasurementDevice
.... extension:observation-bodyPosition S 0..1 (Complex) The body position during the observation
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsBodyPosition FHIR (required): see mapping VF_VitalsBodyPosition
... identifier
.... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/fhir/sid/{sta3n}/120.5
.... value S 0..1 string The value that is unique
... status C 1..1 code (USCDI) registered | preliminary | final | amended +
Constraints: vsso-14-655, vsso-14-656
.... category:VSCat 1..1 CodeableConcept (USCDI) 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
... code
.... coding 2..* Coding (USCDI) Code defined by a terminology system
Binding: VitalsCodes FHIR (required): see mapping VF_VitalsCodes
... subject 1..1 Reference(VAPatient) (USCDI) Who and/or what the observation is about
... Slices for effective[x] 1..1 dateTime, Period (USCDI) Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime S (USCDI) Often just a dateTime for Vital Signs
... issued S 0..1 instant Date/Time this version was made available
... performer S 0..* Reference(VAOrganization) Who is responsible for the observation
... Slices for value[x] Content/Rules for all slices
.... value[x]:valueQuantity 0..1 Quantity (USCDI) Oxygen Saturation by Pulse Oximetry Value
..... value C 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-664
..... code 1..1 code (USCDI) Coded form of the unit
... bodySite S 0..1 CodeableConcept Observed body part
Binding: VitalsBodySite FHIR (required): see mapping VF_VitalsBodySite
... method S 0..1 CodeableConcept How it was done
Binding: VitalsMethod FHIR (required): see mapping VF_VitalsMethod
... Slices for component Content/Rules for all slices
.... component:FlowRate 0..1 BackboneElement (USCDI) Inhaled oxygen flow rate
..... code C 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Constraints: vsso-14-1239-3
..... value[x]
...... value C 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1239
...... unit C 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1239-2
...... code C 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1239-1
.... component:Concentration 0..1 BackboneElement (USCDI) Inhaled oxygen concentration
..... code C 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Constraints: vsso-14-1240-3
..... value[x]
...... value C 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1240
...... unit C 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1240-2
...... code C 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1240-1
.... component:va-pre-condition S 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
..... code 1..1 CodeableConcept (USCDI) 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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
..... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsPrecondition FHIR (required): see mapping VF_VitalsPrecondition
.... component:va-pre-condition-device S 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
..... code 1..1 CodeableConcept (USCDI) 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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
..... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsQualifyingDevice FHIR (required): see mapping VF_VitalsQualifyingDevice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.extension:observation-deviceCode.​value[x] Base required VitalsMeasurementDevice FHIR 📦2.0.0 This IG
Observation.extension:observation-bodyPosition.​value[x] Base required VitalsBodyPosition FHIR 📦2.0.0 This IG
Observation.code.coding Base required VitalsCodes FHIR 📦2.0.0 This IG
Observation.bodySite Base required VitalsBodySite FHIR 📦2.0.0 This IG
Observation.method Base required VitalsMethod FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition.​value[x]:valueCodeableConcept Base required VitalsPrecondition FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition-device.​value[x]:valueCodeableConcept Base required VitalsQualifyingDevice FHIR 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
vsso-14-655 best practice Observation.status If (120.5-4) is null then fixed value #final true
vsso-14-656 best practice Observation.status If (120.5-4) is not null then fixed value #entered-in-error true
vsso-14-664 best practice Observation.value[x]:valueQuantity.value If VUID not = 4500634 then source value from (120.5-1.2) true
vsso-14-1239 best practice Observation.component:FlowRate.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Flow() true
vsso-14-1240 best practice Observation.component:Concentration.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Consentration() true
vsso-14-1239-1 best practice Observation.component:FlowRate.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #L/min true
vsso-14-1239-2 best practice Observation.component:FlowRate.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value L/min true
vsso-14-1239-3 best practice Observation.component:FlowRate.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3151-8 true
vsso-14-1240-1 best practice Observation.component:Concentration.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #% true
vsso-14-1240-2 best practice Observation.component:Concentration.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value % true
vsso-14-1240-3 best practice Observation.component:Concentration.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3150-0 true

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCorePulseOximetryProfile(6.1.0) US Core Pulse Oximetry Profile
This profile also complies with the profile US Core Pulse Oximetry Profile (7.0.0)
Constraints: obs-6, obs-7, vs-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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:observation-deviceCode S 0..1 (Complex) A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`
URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-deviceCode"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsMeasurementDevice FHIR (required): see mapping VF_VitalsMeasurementDevice
.... extension:observation-bodyPosition S 0..1 (Complex) The body position during the observation
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: VitalsBodyPosition FHIR (required): see mapping VF_VitalsBodyPosition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/fhir/sid/{sta3n}/120.5
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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ΣC 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Constraints: vsso-14-655, vsso-14-656
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:VSCat S 1..1 CodeableConcept (USCDI) 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 1..* Coding (USCDI) Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri (USCDI) 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 SΣ 1..1 code (USCDI) Symbol in syntax defined by the system
Fixed Value: vital-signs
...... display Σ 0..1 string Representation defined by the system
...... 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 (USCDI) Oxygen Saturation by Pulse Oximetry
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... 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 SΣ 2..* Coding (USCDI) Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
Binding: VitalsCodes FHIR (required): see mapping VF_VitalsCodes
..... coding:PulseOx SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 59408-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... coding:O2Sat SΣ 1..1 Coding (USCDI) Code defined by a terminology system

Required Pattern: At least the following
...... 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: 2708-6
...... display 0..1 string Representation defined by the system
...... 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(VAPatient) (USCDI) 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
... Slices for effective[x] SΣC 1..1 (USCDI) Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
Constraints: vs-1
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime S (USCDI) Often just a dateTime for Vital Signs
Constraints: vs-1
... issued SΣ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(VAOrganization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 (USCDI) Vital Signs Value
Slice: Unordered, Closed by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueQuantity SΣC 0..1 Quantity (USCDI) Oxygen Saturation by Pulse Oximetry Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
..... 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 SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-664
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string (USCDI) Unit representation
..... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code (USCDI) Coded form of the unit
Fixed Value: %
... dataAbsentReason SC 0..1 CodeableConcept (USCDI) Why the 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.
... note 0..* Annotation Comments about the observation
... bodySite S 0..1 CodeableConcept Observed body part
Binding: VitalsBodySite FHIR (required): see mapping VF_VitalsBodySite
... method S 0..1 CodeableConcept How it was done
Binding: VitalsMethod FHIR (required): see mapping VF_VitalsMethod
... 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 Low Range, if relevant
.... high C 0..1 SimpleQuantity 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(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Used when reporting vital signs panel components
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Related measurements the observation is made from
... Slices for component SΣC 0..* BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
Constraints: vs-3
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
..... value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:FlowRate SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen flow rate
Constraints: vs-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
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1239-3
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: 3151-8
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... 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 SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1239
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1239-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1239-1
Fixed Value: L/min
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:Concentration SΣC 0..1 BackboneElement (USCDI) Inhaled oxygen concentration
Constraints: vs-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
..... code SΣC 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
Constraints: vsso-14-1240-3
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: 3150-0
....... display 0..1 string Representation defined by the system
....... 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ΣC 0..1 Quantity S (USCDI) Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... 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 SΣC 1..1 decimal (USCDI) Numerical value (with implicit precision)
Constraints: vsso-14-1240
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
...... unit SΣC 1..1 string (USCDI) Unit representation
Constraints: vsso-14-1240-2
...... system SΣC 1..1 uri (USCDI) System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣC 1..1 code (USCDI) Coded form of the unit
Constraints: vsso-14-1240-1
Fixed Value: %
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:va-pre-condition SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-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
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsPrecondition FHIR (required): see mapping VF_VitalsPrecondition
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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:va-pre-condition-device SΣC 0..1 BackboneElement (USCDI) Used when reporting flow rates or oxygen concentration.
Constraints: vs-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
..... code SΣ 1..1 CodeableConcept (USCDI) Type of component observation (code / type)
Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
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: 104158-1
....... display 1..1 string Representation defined by the system
Fixed Value: Associated precondition - Reported
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] SΣC 0..1 (USCDI) Vital Sign Component Value
Slice: Unordered, Open by type:$this
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
...... valueQuantity Quantity S
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept (USCDI) Vital Sign Component Value
Binding: VitalsQualifyingDevice FHIR (required): see mapping VF_VitalsQualifyingDevice
..... dataAbsentReason SC 0..1 CodeableConcept (USCDI) 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.extension:observation-deviceCode.​value[x] Base required VitalsMeasurementDevice FHIR 📦2.0.0 This IG
Observation.extension:observation-bodyPosition.​value[x] Base required VitalsBodyPosition FHIR 📦2.0.0 This IG
Observation.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Observation.identifier.​type Base extensible IdentifierType 📍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:VSCat Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.code.coding Base required VitalsCodes FHIR 📦2.0.0 This IG
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍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 required VitalsBodySite FHIR 📦2.0.0 This IG
Observation.method Base required VitalsMethod FHIR 📦2.0.0 This IG
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 extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component.​value[x] Base extensible Vital Signs Units 📍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:FlowRate.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:FlowRate.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:FlowRate.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:FlowRate.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component:Concentration.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:Concentration.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:Concentration.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.component:Concentration.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:Concentration.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition.​value[x]:valueCodeableConcept Base required VitalsPrecondition FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​code Base extensible US Core Vital Signs ValueSet 📦6.1.0 US Core v6.1
Observation.component:va-pre-condition-device.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​value[x]:valueCodeableConcept Base required VitalsQualifyingDevice FHIR 📦2.0.0 This IG
Observation.component:va-pre-condition-device.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component:va-pre-condition-device.​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()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day ($this as dateTime).toString().length() >= 8
vs-2 error Observation If there is no component or hasMember element then either a value[x] or a data absent reason must be present. (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
vs-3 error Observation.component, Observation.component:FlowRate, Observation.component:Concentration, Observation.component:va-pre-condition, Observation.component:va-pre-condition-device If there is no a value a data absent reason must be present value.exists() or dataAbsentReason.exists()
vsso-14-655 best practice Observation.status If (120.5-4) is null then fixed value #final true
vsso-14-656 best practice Observation.status If (120.5-4) is not null then fixed value #entered-in-error true
vsso-14-664 best practice Observation.value[x]:valueQuantity.value If VUID not = 4500634 then source value from (120.5-1.2) true
vsso-14-1239 best practice Observation.component:FlowRate.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Flow() true
vsso-14-1240 best practice Observation.component:Concentration.value[x].value If VUID = 4500637 then transform (120.5-1.4) using Split_SpO2_value.Consentration() true
vsso-14-1239-1 best practice Observation.component:FlowRate.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #L/min true
vsso-14-1239-2 best practice Observation.component:FlowRate.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value L/min true
vsso-14-1239-3 best practice Observation.component:FlowRate.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3151-8 true
vsso-14-1240-1 best practice Observation.component:Concentration.value[x].code If (120.5-1.4) is VUID = 4500637 then fixed value #% true
vsso-14-1240-2 best practice Observation.component:Concentration.value[x].unit If (120.5-1.4) is VUID = 4500637 then fixed value % true
vsso-14-1240-3 best practice Observation.component:Concentration.code If (120.5-1.4) is VUID = 4500637 then fixed value http://loinc.org#3150-0 true

This structure is derived from USCorePulseOximetryProfile

Summary

Must-Support: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.effective[x]
  • The element 1 is sliced based on the value of Observation.component.value[x]

 

Other representations of profile: CSV, Excel, Schematron