US Core Implementation Guide
4.0.0 - STU4 Release

This page is part of the US Core (v4.0.0: STU4) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Resource Profile: US Core Pulse Oximetry Profile

Defining URL:http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry
Version:4.0.0
Name:USCorePulseOximetryProfile
Title:US Core Pulse Oximetry Profile
Status:Active as of 2020-11-18
Definition:

Defines constraints on the Observation resource to represent inspired O2 by pulse oximetry and inspired oxygen concentration observations with a standard LOINC codes and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

Publisher:HL7 International - US Realm Steering Committee
Copyright:

Used by permission of HL7 International, all rights reserved Creative Commons License

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry

This profile sets minimum expectations for the Observation resource to record, search, and fetch pulse oximetry and inspired oxygen observations associated with a patient. It is based on the US Core Vital Signs Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Observation resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core Pulse Oximetry Profile:

  • Query for pulse oximety observations for a patient
  • Record or update pulse oximety observations belonging to a patient

Mandatory and Must Support Data Elements

In addition to the mandatory and must support data elements in the FHIR Oxygen Saturation Profile, the following data-elements must always be present (Mandatory definition]) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Observation must have:

  1. a fixed code for oxygen saturation in arterial blood as defined in the FHIR oxygen saturation profile
  2. a additional coding for oxygen saturation in arterial blood by pulse oximetry

Each Observation must support:

  1. a code for inspired oxygen concentration
  2. a value for inspired oxygen concentration

Profile specific implementation guidance:

  • See the implementation guidance section for the US Core Vital Signs Profile
  • Inspired oxygen therapy may be represented with component observations when measured at the same time as the pulse oximetry measurements. They are expressed as inhaled oxygen flow rate (e.g., 6 liters/min) and as inhaled oxygen concentration (e.g., 40% oxygen).
    • This profile is technically non-conformant with the base FHIR vitals profile which defines a required binding that excludes the concept for L/min for Observation.component.value(x). This is a known issue and a change request has been logged to correct it. Validation errors may occur when validating against this version of the US Core Pulse Oximetry Profile until the next version of the base specification is published.
  • Many pulse oximetry readings are taken while the patient is breathing room air. The concept of “room air” (unmodified, ambient air) should be represented as an inhaled oxygen flow rate of 0 liters/min.
  • A pulse oximetry reading without component inspired oxygen observations may imply that the measurement was performed while the patient was breathing room air or that the inspired oxygen reading was omitted. To remove this uncertainty, the inspired oxygen component observations should be used.

Examples

Formal Views of Profile Content

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

This structure is derived from USCoreVitalSignsProfile

Summary

Mandatory: 2 elements (8 nested mandatory elements)
Must-Support: 19 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of pattern:$this
  • The element Observation.component is sliced based on the value of pattern:code

This structure is derived from USCoreVitalSignsProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreVitalSignsProfileUS Core Pulse Oximetry Profile
... code S1..1CodeableConceptOxygen Saturation by Pulse Oximetry
.... Slices for coding S0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:PulseOx S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 59408-5
..... coding:O2Sat S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
... Slices for component S0..*BackboneElementUsed when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
.... component:FlowRate S0..1BackboneElementInhaled oxygen flow rate
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3151-8
..... valueQuantity S0..1Quantity SVital Sign Component Value
...... value S1..1decimalNumerical value (with implicit precision)
...... unit S1..1stringUnit representation
...... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
Fixed Value: L/min
.... component:Concentration S0..1BackboneElementInhaled oxygen concentration
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3150-0
..... valueQuantity S0..1Quantity SVital Sign Component Value
...... value S1..1decimalNumerical value (with implicit precision)
...... unit S1..1stringUnit representation
...... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
Fixed Value: %

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*USCoreVitalSignsProfileUS Core Pulse Oximetry Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category S1..*CodeableConceptClassification 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 S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptOxygen 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:PulseOx SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 59408-5
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... coding:O2Sat SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Core Patient Profile)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1Often just a dateTime for Vital Signs
.... effectiveDateTimedateTime S
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

.... valueQuantityQuantity S
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText 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ΣI0..*BackboneElementUsed when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType 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ΣI0..1Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... valueQuantityQuantity S
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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ΣI0..1BackboneElementInhaled oxygen flow rate
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3151-8
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣI0..1Quantity SVital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit SΣ1..1stringUnit representation
...... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ1..1codeCoded form of the unit
Fixed Value: L/min
..... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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ΣI0..1BackboneElementInhaled oxygen concentration
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3150-0
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣI0..1Quantity SVital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit SΣ1..1stringUnit representation
...... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ1..1codeCoded form of the unit
Fixed Value: %
..... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*USCoreVitalSignsProfileUS Core Pulse Oximetry Profile
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category 1..*CodeableConceptClassification 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 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
... code Σ1..1CodeableConceptOxygen 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 Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:PulseOx Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 59408-5
..... coding:O2Sat Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
... subject Σ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] ΣI1..1Often just a dateTime for Vital Signs
.... effectiveDateTimedateTime
... value[x] ΣI0..1Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

.... valueQuantityQuantity
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... Slices for component ΣI0..*BackboneElementUsed when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... code Σ1..1CodeableConceptType 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] ΣI0..1Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... valueQuantityQuantity
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:FlowRate ΣI0..1BackboneElementInhaled oxygen flow rate
..... code Σ1..1CodeableConceptType 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3151-8
..... value[x] ΣI0..1QuantityVital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... value Σ1..1decimalNumerical value (with implicit precision)
...... unit Σ1..1stringUnit representation
...... system ΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ1..1codeCoded form of the unit
Fixed Value: L/min
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... component:Concentration ΣI0..1BackboneElementInhaled oxygen concentration
..... code Σ1..1CodeableConceptType 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3150-0
..... value[x] ΣI0..1QuantityVital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... value Σ1..1decimalNumerical value (with implicit precision)
...... unit Σ1..1stringUnit representation
...... system ΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ1..1codeCoded form of the unit
Fixed Value: %
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

This structure is derived from USCoreVitalSignsProfile

Summary

Mandatory: 2 elements (8 nested mandatory elements)
Must-Support: 19 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of pattern:$this
  • The element Observation.component is sliced based on the value of pattern:code

Differential View

This structure is derived from USCoreVitalSignsProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreVitalSignsProfileUS Core Pulse Oximetry Profile
... code S1..1CodeableConceptOxygen Saturation by Pulse Oximetry
.... Slices for coding S0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:PulseOx S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 59408-5
..... coding:O2Sat S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
... Slices for component S0..*BackboneElementUsed when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
.... component:FlowRate S0..1BackboneElementInhaled oxygen flow rate
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3151-8
..... valueQuantity S0..1Quantity SVital Sign Component Value
...... value S1..1decimalNumerical value (with implicit precision)
...... unit S1..1stringUnit representation
...... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
Fixed Value: L/min
.... component:Concentration S0..1BackboneElementInhaled oxygen concentration
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3150-0
..... valueQuantity S0..1Quantity SVital Sign Component Value
...... value S1..1decimalNumerical value (with implicit precision)
...... unit S1..1stringUnit representation
...... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
Fixed Value: %

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*USCoreVitalSignsProfileUS Core Pulse Oximetry Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category S1..*CodeableConceptClassification 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 S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptOxygen 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:PulseOx SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 59408-5
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... coding:O2Sat SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Core Patient Profile)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1Often just a dateTime for Vital Signs
.... effectiveDateTimedateTime S
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

.... valueQuantityQuantity S
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText 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ΣI0..*BackboneElementUsed when reporting flow rates or oxygen concentration.
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType 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ΣI0..1Vital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... valueQuantityQuantity S
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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ΣI0..1BackboneElementInhaled oxygen flow rate
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3151-8
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣI0..1Quantity SVital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit SΣ1..1stringUnit representation
...... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ1..1codeCoded form of the unit
Fixed Value: L/min
..... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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ΣI0..1BackboneElementInhaled oxygen concentration
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 3150-0
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣI0..1Quantity SVital Sign Component Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.

...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit SΣ1..1stringUnit representation
...... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code SΣ1..1codeCoded form of the unit
Fixed Value: %
..... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:VSCatpreferredObservationCategoryCodes
Observation.codeextensibleUsCoreVitalSigns
Observation.value[x]extensibleVitalSignsUnits
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeextensibleUsCoreVitalSigns
Observation.component.value[x]extensibleVitalSignsUnits
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:FlowRate.codeextensiblePattern: LOINC code 3151-8
Observation.component:FlowRate.value[x]extensibleVitalSignsUnits
Observation.component:FlowRate.value[x].comparatorrequiredQuantityComparator
Observation.component:FlowRate.dataAbsentReasonextensibleDataAbsentReason
Observation.component:FlowRate.interpretationextensibleObservationInterpretationCodes
Observation.component:Concentration.codeextensiblePattern: LOINC code 3150-0
Observation.component:Concentration.value[x]extensibleVitalSignsUnits
Observation.component:Concentration.value[x].comparatorrequiredQuantityComparator
Observation.component:Concentration.dataAbsentReasonextensibleDataAbsentReason
Observation.component:Concentration.interpretationextensibleObservationInterpretationCodes

Constraints

IdPathDetailsRequirements
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • The syntax used to describe the interactions is described here.
  • See the General Guidance section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the combination of the patient and category search parameters:

    GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs

    Example:

    1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and a category code = vital-signs (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and code search parameters:
    • including optional support for composite OR search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=1186747&code=http://loinc.org|8867-4,http://loinc.org|9279-1,http://loinc.org|85354-9

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). SHOULD support search by multiple codes. The Observation code parameter searches `Observation.code only. (how to search by reference and how to search by token)

  3. SHALL support searching using the combination of the patient and category and date search parameters:
    • including support for these date comparators: gt,lt,ge,le
    • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = vital-signs (how to search by reference and how to search by token and how to search by date)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and category and status search parameters:
    • including support for composite OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&status=final

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and status (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and code and date search parameters:
    • including optional support for composite OR search on code (e.g.code={system|}[code],{system|}[code],...)
    • including support for these date comparators: gt,lt,ge,le
    • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=1186747&code=http://loinc.org|8867-4,http://loinc.org|9279-1,http://loinc.org|85354-9&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and report code(s). SHOULD support search by multiple codes. (how to search by reference and how to search by token and how to search by date)