StructureDefinition-ck-oxygensat

This profile sets minimum expectations for the Observation resource to record, search and fetch oxygen saturation of a patient. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Observation resource when using this profile.

Background & Scope

Observation has consists of measurements and simple assertions made about a patient, device or other subject.

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Observations are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. Most observations are simple name/value pair assertions with some metadata, but some observations group other observations together logically, or even are multi-component observations.

  1. a status
  2. a fixed code for observation
  3. a patient
  4. a date representing when the observation status was recorded
  5. a result value code for observation status

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://www.collabkare.io/r4/StructureDefinition/ck-oxygensat

Published on Mon Jul 13 14:01:09 IST 2020 as a active by CollabKare.

This profile builds on Observation

Complete Summary of the Mandatory Requirements

There are no mandatory requirements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationOxygenSaturation
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... MeasurementSettingExt S0..1CodeableConceptExtension
URL: http://www.collabkare.io/r4/StructureDefinition/MeasurementSettingExt
Binding: http://hl7.org/fhir/us/vitals/ValueSet/MeasSettingVS (extensible)
... ExerciseAssociationExt S0..1CodeableConceptExtension
URL: http://www.collabkare.io/r4/StructureDefinition/ExerciseAssociationExt
... SensorDescriptionExt S0..1CodeableConceptExtension
URL: http://www.collabkare.io/r4/StructureDefinition/SensorDescriptionExt
... status S1..1coderegistered | preliminary | final | amended +
... category S0..*CodeableConceptClassification of type of observation
.... coding S0..*CodingCode defined by a terminology system.
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
..... code 0..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display 0..1stringRepresentation defined by the system
Fixed Value: Vital Signs
... code S1..1CodeableConceptType of observation.
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code 0..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
..... display 0..1stringRepresentation defined by the system
Fixed Value: Oxygen saturation in Arterial blood
... value[x] S0..1QuantityActual result
.... value S0..1decimalNumerical value (with implicit precision)
.... unit S0..1stringUnit representation
.... system S0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S0..1codeCoded form of the unit
Fixed Value: %
... dataAbsentReason S0..1CodeableConceptWhy the result is missing
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: http://hl7.org/fhir/us/vitals/ValueSet/NumericResultIntVS (extensible)
... bodySite S0..1CodeableConceptObserved body part
Binding: http://hl7.org/fhir/us/vitals/ValueSet/sPO2BodyLocationVS (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationOxygenSaturation
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... MeasurementSettingExt SI0..1CodeableConceptOptional Extensions Element
URL: http://www.collabkare.io/r4/StructureDefinition/MeasurementSettingExt
Binding: http://hl7.org/fhir/us/vitals/ValueSet/MeasSettingVS (extensible)
... ExerciseAssociationExt SI0..1CodeableConceptOptional Extensions Element
URL: http://www.collabkare.io/r4/StructureDefinition/ExerciseAssociationExt
... SensorDescriptionExt SI0..1CodeableConceptOptional Extensions Element
URL: http://www.collabkare.io/r4/StructureDefinition/SensorDescriptionExt
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system.
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display ΣI0..1stringRepresentation defined by the system
Fixed Value: Vital Signs
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... code SΣI1..1CodeableConceptType of observation.
Binding: LOINCCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
..... display ΣI0..1stringRepresentation defined by the system
Fixed Value: Oxygen saturation in Arterial blood
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... subject ΣI0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ΣI0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1QuantityActual result
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣI0..1decimalNumerical value (with implicit precision)
.... comparator ?!ΣI0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit SΣI0..1stringUnit representation
.... system SΣI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code SΣI0..1codeCoded form of the unit
Fixed Value: %
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation SI0..*CodeableConceptHigh, low, normal, etc.
Binding: http://hl7.org/fhir/us/vitals/ValueSet/NumericResultIntVS (extensible)
... note I0..*AnnotationComments about the observation
... bodySite SI0..1CodeableConceptObserved body part
Binding: http://hl7.org/fhir/us/vitals/ValueSet/sPO2BodyLocationVS (extensible)
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device I0..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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component ΣI0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
.... value[x] ΣI0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationOxygenSaturation
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... MeasurementSettingExt S0..1CodeableConceptExtension
URL: http://www.collabkare.io/r4/StructureDefinition/MeasurementSettingExt
Binding: http://hl7.org/fhir/us/vitals/ValueSet/MeasSettingVS (extensible)
... ExerciseAssociationExt S0..1CodeableConceptExtension
URL: http://www.collabkare.io/r4/StructureDefinition/ExerciseAssociationExt
... SensorDescriptionExt S0..1CodeableConceptExtension
URL: http://www.collabkare.io/r4/StructureDefinition/SensorDescriptionExt
... status S1..1coderegistered | preliminary | final | amended +
... category S0..*CodeableConceptClassification of type of observation
.... coding S0..*CodingCode defined by a terminology system.
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
..... code 0..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display 0..1stringRepresentation defined by the system
Fixed Value: Vital Signs
... code S1..1CodeableConceptType of observation.
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code 0..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
..... display 0..1stringRepresentation defined by the system
Fixed Value: Oxygen saturation in Arterial blood
... value[x] S0..1QuantityActual result
.... value S0..1decimalNumerical value (with implicit precision)
.... unit S0..1stringUnit representation
.... system S0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S0..1codeCoded form of the unit
Fixed Value: %
... dataAbsentReason S0..1CodeableConceptWhy the result is missing
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: http://hl7.org/fhir/us/vitals/ValueSet/NumericResultIntVS (extensible)
... bodySite S0..1CodeableConceptObserved body part
Binding: http://hl7.org/fhir/us/vitals/ValueSet/sPO2BodyLocationVS (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationOxygenSaturation
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... MeasurementSettingExt SI0..1CodeableConceptOptional Extensions Element
URL: http://www.collabkare.io/r4/StructureDefinition/MeasurementSettingExt
Binding: http://hl7.org/fhir/us/vitals/ValueSet/MeasSettingVS (extensible)
... ExerciseAssociationExt SI0..1CodeableConceptOptional Extensions Element
URL: http://www.collabkare.io/r4/StructureDefinition/ExerciseAssociationExt
... SensorDescriptionExt SI0..1CodeableConceptOptional Extensions Element
URL: http://www.collabkare.io/r4/StructureDefinition/SensorDescriptionExt
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system.
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display ΣI0..1stringRepresentation defined by the system
Fixed Value: Vital Signs
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... code SΣI1..1CodeableConceptType of observation.
Binding: LOINCCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
Fixed Value: 2708-6
..... display ΣI0..1stringRepresentation defined by the system
Fixed Value: Oxygen saturation in Arterial blood
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... subject ΣI0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ΣI0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1QuantityActual result
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣI0..1decimalNumerical value (with implicit precision)
.... comparator ?!ΣI0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit SΣI0..1stringUnit representation
.... system SΣI0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code SΣI0..1codeCoded form of the unit
Fixed Value: %
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation SI0..*CodeableConceptHigh, low, normal, etc.
Binding: http://hl7.org/fhir/us/vitals/ValueSet/NumericResultIntVS (extensible)
... note I0..*AnnotationComments about the observation
... bodySite SI0..1CodeableConceptObserved body part
Binding: http://hl7.org/fhir/us/vitals/ValueSet/sPO2BodyLocationVS (extensible)
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device I0..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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component ΣI0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
.... value[x] ΣI0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

No Search criteria for this profile.