| Left: | US Core Pulse Oximetry Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry) |
| Right: | US Core Pulse Oximetry Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry) |
| Error | StructureDefinition.version | Values for version differ: '3.1.1' vs '7.0.0-ballot' |
| Information | StructureDefinition.date | Values for date differ: '2020-06-29' vs '2023-10-17' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 US Realm Steering Committee' vs 'HL7 International / Cross-Group Projects' |
| Error | StructureDefinition.baseDefinition | Values for baseDefinition differ: 'http://hl7.org/fhir/StructureDefinition/oxygensat' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs' |
| Information | StructureDefinition.short | Values for short differ: 'FHIR Oxygen Saturation Profile' vs 'US Core Pulse Oximetry Profile' |
| Information | StructureDefinition.definition | Values for definition differ: 'This profile defines how to represent pulse oximetry and inspired oxygen concentration based on the FHIR Core Vitals Profile. INSPIRED OXYGEN CONCENTRATION observations in FHIR using a standard LOINC code and UCUM units of measure.' vs '\-' |
| Information | StructureDefinition.comment | Values for comment differ: 'Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.' vs '\-' |
| Information | StructureDefinition.definition | Values for definition differ: 'Oxygen Saturation.' vs 'Coded Responses from C-CDA Vital Sign Results.' |
| Information | StructureDefinition.comment | Values for comment differ: 'The code (59408-5 Oxygen saturation in Arterial blood by Pulse oximetry) is included as an additional observation code to FHIR Core vital Oxygen Saturation code (2708-6 Oxygen saturation in Arterial blood -).' vs 'The code (59408-5 Oxygen saturation in Arterial blood by Pulse oximetry) is included as an additional observation code to FHIR Core vital Oxygen Saturation code (2708-6 Oxygen saturation in Arterial blood).' |
| Information | Observation.code.coding | Element minimum cardinalities differ: '0' vs '2' |
| Information | StructureDefinition.short | Values for short differ: 'Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.' vs 'Vital Signs Value' |
| Information | StructureDefinition.definition | Values for definition differ: 'Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.' vs 'Vital Signs value are typically recorded using the Quantity data type.' |
| Information | StructureDefinition.short | Values for short differ: 'Used when reporting systolic and diastolic blood pressure.' vs 'Used when reporting flow rates or oxygen concentration.' |
| Information | StructureDefinition.definition | Values for definition differ: 'Used when reporting systolic and diastolic blood pressure.' vs 'Used when reporting flow rates or oxygen concentration.' |
| Information | StructureDefinition.short | Values for short differ: 'Vital Sign Value recorded with UCUM' vs 'Vital Sign Component Value' |
| Information | StructureDefinition.definition | Values for definition differ: 'Vital Sign Value recorded with UCUM.' vs 'Vital Signs value are typically recorded using the Quantity data type. For supporting observations such as cuff size could use other datatypes such as CodeableConcept.' |
| Name | Value | Comments | |
|---|---|---|---|
 abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/oxygensat | http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs |
|
| copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
| date | 2020-06-29 | 2023-10-17 |
|
| description | Defines constraints and extensions on the Observation resource for use in querying and retrieving inspired O2 by pulse oximetry observations. | To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch pulse oximetry and inspired oxygen observations with a standard LOINC codes and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which *additional* core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. |
|
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
 jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCorePulseOximetryProfile | ||
| publisher | HL7 US Realm Steering Committee | HL7 International / Cross-Group Projects |
|
| purpose | |||
| status | active | ||
| title | US Core Pulse Oximetry Profile | ||
| type | Observation | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry | ||
| version | 3.1.1 | 7.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Observation | C | 0..* | observation-oxygensat | FHIR Oxygen Saturation Profile | C | 0..* | USCoreVitalSignsProfile | US Core Pulse Oximetry Profile | |||||||||
 id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | Σ | 0..* | Identifier | Business Identifier for observation | |||||||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | Σ | 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 | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ?? (required) | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ?? (required) | |||||||||
| Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ?? (preferred): Codes for high level observation categories. | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ?? (preferred): Codes for high level observation categories. | |||||||||
| code | SΣ | 1..1 | CodeableConcept | Oxygen Saturation by Pulse Oximetry Binding: ?? (extensible): This identifies the vital sign result type. | SΣ | 1..1 | CodeableConcept | Oxygen Saturation by Pulse Oximetry Binding: ?? (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code, value:system | SΣ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
| ||||||||
| text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||
| subject | SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | |||||||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | Σ | 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 | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||||||
| effective[x] | SΣC | 1..1 | dateTime, Period | Often just a dateTime for Vital Signs vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day | SΣC | 1..1 | dateTime S, Period | Often just a dateTime for Vital Signs | |||||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | Σ | 0..1 | instant | Date/Time this version was made available | |||||||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||||||
| Slices for value[x] | SΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. Slice: Unordered, Closed by type:$this | SΣC | 0..1 | Quantity S, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Vital Signs Value Slice: Unordered, Open by type:$this Binding: ?? (extensible): Common UCUM units for recording Vital Signs. | |||||||||
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: ?? (extensible): Codes specifying why the result (Observation.value[x]) is missing. | SC | 0..1 | CodeableConcept | Why the result is missing Binding: ?? (extensible): Codes specifying why the result (Observation.value[x]) is missing. | |||||||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ?? (extensible): Codes identifying interpretations of observations. | 0..* | CodeableConcept | High, low, normal, etc. Binding: ?? (extensible): Codes identifying interpretations of observations. | |||||||||||
| note | 0..* | Annotation | Comments about the observation | 0..* | Annotation | Comments about the observation | |||||||||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: ?? (example): Codes describing anatomical locations. May include laterality. | 0..1 | CodeableConcept | Observed body part Binding: ?? (example): Codes describing anatomical locations. May include laterality. | |||||||||||
| method | 0..1 | CodeableConcept | How it was done Binding: ?? (example): Methods for simple observations. | 0..1 | CodeableConcept | How it was done Binding: ?? (example): Methods for simple observations. | |||||||||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||||||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | C | 0..* | BackboneElement | Provides guide for interpretation | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| low | C | 0..1 | ?? | Low Range, if relevant | C | 0..1 | ?? | Low Range, if relevant | |||||||||
| high | C | 0..1 | ?? | High Range, if relevant | C | 0..1 | ?? | High Range, if relevant | |||||||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ?? (preferred): Code for the meaning of a reference range. | 0..1 | CodeableConcept | Reference range qualifier Binding: ?? (preferred): Code for the meaning of a reference range. | |||||||||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ?? (example): Codes identifying the population the reference range applies to. | 0..* | CodeableConcept | Reference range population Binding: ?? (example): Codes identifying the population the reference range applies to. | |||||||||||
| age | 0..1 | Range | Applicable age range, if relevant | 0..1 | Range | Applicable age range, if relevant | |||||||||||
| text | 0..1 | string | Text based reference range in an observation | 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 | Σ | 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 | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | |||||||||
| Slices for component | SΣC | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Slice: Unordered, Open by pattern:code | SΣC | 0..* | BackboneElement | Used when reporting flow rates or oxygen concentration. Slice: Unordered, Open by pattern:code | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: ?? (extensible): This identifies the vital sign result type. | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: ?? (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | |||||||||
| value[x] | SΣC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Vital Sign Value recorded with UCUM Binding: ?? (required): Common UCUM units for recording Vital Signs. | SΣC | 0..1 | Quantity S, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Vital Sign Component Value Binding: ?? (extensible): Common UCUM units for recording Vital Signs. | |||||||||
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: ?? (extensible): Codes specifying why the result (Observation.value[x]) is missing. | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: ?? (extensible): Codes specifying why the result (Observation.value[x]) is missing. | |||||||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ?? (extensible): Codes identifying interpretations of observations. | 0..* | CodeableConcept | High, low, normal, etc. Binding: ?? (extensible): Codes identifying interpretations of observations. | |||||||||||
 referenceRange | 0..* | See referenceRange | Provides guide for interpretation of component result | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||
| Documentation for this format | |||||||||||||||||