Vital Signs Implementation Guide version 0.1.0 (Release 0.1.0 Ballot )

This page is part of the Vital Signs FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition-HeartRate

The heart rate profile contains one observation, heart rate. In addition, the heart rate profile contains the following qualifying observations with associated SNOMED CT value sets: Body Position; Heart Rate Measurement Device (); Heart Rate Measurement Method (e.g. auscultation, doppler); Exercise Association; and Sleep status.

Examples

The following examples are provided to illustrate conformant resource content to this profile.


Scope and Usage

Use Cases

1. Heart rate measured using radial artery palpation.

FHIR resource path Text Description Code Terminology
Observation.code Heart Rate 9179-1 LOINC
Observation.method
Heart Rate Measurement Method value set		 Heart rate measurement method refernce set (foundation metadata concept) 23901000205104 SNOMED CT Solor extension
Heart rate measurement method reference set 2.16.840.1.113762.1.4.1181.29 VSAC
Observation.method.value Palpation 113011001 SNOMED CT
Observation.bodySite
Heart Rate Measurement Body Location Precoordinated value set		 Heart Rate Measurement Body Location reference set (foundation metedata concept) 23871000205104 SNOMED CT Solor extension
Heart Rate Measurement Body Location reference set 2.16.840.1.113762.1.4.1181.29 VSAC
Observation.bodySite.value Structure of radial artery (body structure) 45631007 SNOMED CT

2. Heart rate measurement during anesthesia

FHIR resource path Text Description Code Terminology
Observation.code Heart Rate 9279-1 LOINC
Associated Precondition extension bindings
Observation.extension(associatedPreconditionExt) mapping LOINC
Observation.extension(associatedPrecondition) value set need description need Solor code SNOMED CT Solor extension
need description need VSAC OID VSAC
Observation.extension(associatedPrecondition).value During procedure 307154001 SNOMED CT

Value sets

Value Set Purpose VSAC OID
Body Position Refset This reference set contains concepts used to result the patient's body position, referencing the SNOMED Code 397155001 Body position (observable entity) and the LOINC term "Body position with respect to gravity" 8361-8. 2.16.840.1.113762.1.4.1181.38
Heart Rate Device Type Refset This reference set contains concepts used to result the type of device used to measure a heart rate, referencing the LOINC term "Type of Heart rate device" 8887-2. 2.16.840.1.113762.1.4.1181.47
Heart Rate Measurement Body Location Refset This reference set contains a constrained list body location values used to result the body location where a heart rate was measured, referencing the LOINC term "Heart rate measurement site", 41904-4. 2.16.840.1.113762.1.4.1181.29
Heart Rate Measurement Method Refset This reference set contains concepts used to result the method used for a blood pressure measurement, referencing the LOINC term "Heart rate method” 8886-4. 2.16.840.1.113762.1.4.1181.48
Exercise Association Reference Set The purpose of the reference set is to document exercise associated with a measurement. Resulting LOINC code 74008-4 "Exercise intensity". 2.16.840.1.113762.1.4.1181.36
Sleep Status Refset This reference set contains values used to indicate the state of wakefulness during measurement 2.16.840.1.113762.1.4.1181.2
Vital Signs Associated Precondition Refset This reference set contains concepts to record particular states or conditions that may exist or need to exist while measuring vital signs. Not yet in VSAC


Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/vitals/StructureDefinition/HeartRate

Published on Wed May 29 00:00:00 UTC 2019 as a draft by HSPC.

This profile builds on observation-heartrate

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*observation-heartrateHeart Rate
... MeasurementDeviceExt S0..*CodeableConceptMeasurement Device
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementDeviceExt
Binding: Heart Rate Measurement Device value set (preferred)
... ExerciseAssociationExt S0..1CodeableConceptExercise Association
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/ExerciseAssociationExt
Binding: Exertion Phase value set (preferred)
... BodyPositionExt S0..1CodeableConceptBody Position
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/BodyPositionExt
Binding: Body Position value set (preferred)
... MeasurementSettingExt 0..1CodeableConceptMeasurement setting
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementSettingExt
Binding: Measurement Setting value set (preferred)
... status S1..1coderegistered | preliminary | final | amended +
... code S1..1CodeableConceptHeart Rate
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: 8867-4
..... display1..1stringRepresentation defined by the system
Fixed Value: Heart rate
... subject S1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] S1..1dateTime, PeriodOften just a dateTime for Vital Signs
... valueQuantity S0..1QuantityVital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S1..1stringUnit representation
.... system S1..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
.... code S1..1codePrimitive Type code
Fixed Value: {Beats}/min
... dataAbsentReason S0..1CodeableConceptWhy the result is missing
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nominal value set (preferred)
... bodySite 0..1CodeableConceptObserved body part
Binding: Heart Rate Measurement Body Location Precoordinated value set (preferred)
... method 0..1CodeableConceptHow it was done
Binding: Heart Rate Measurement Method value set (preferred)
... device S0..1Reference(Device | BloodPressureDevice)(Measurement) Device

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*observation-heartrateHeart Rate
... 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
... MeasurementDeviceExt SI0..*CodeableConceptMeasurement Device
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementDeviceExt
... ExerciseAssociationExt SI0..1CodeableConceptExercise Association
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/ExerciseAssociationExt
... BodyPositionExt SI0..1CodeableConceptBody Position
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/BodyPositionExt
... MeasurementSettingExt I0..1CodeableConceptMeasurement setting
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementSettingExt
... 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 SI1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred)
.... category:VSCat SI1..1CodeableConceptClassification 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ΣI1..*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 SΣI1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version ΣI0..1stringVersion of the system - if relevant
...... code SΣI1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... code SΣI1..1CodeableConceptHeart Rate
Binding: VitalSigns (extensible)
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: 8867-4
..... display1..1stringRepresentation defined by the system
Fixed Value: Heart rate
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code, value:system
..... coding:HeartRateCode ΣI1..1CodingCode 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 ΣI1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: 8867-4
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... subject SΣI1..1Reference(US Core Patient Profile)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] SΣI1..1Often just a dateTime for Vital Signs
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... 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..1(Slice Definition)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
.... value[x]:valueQuantity SΣI0..1QuantityVital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣI1..1decimalNumerical value (with implicit precision)
..... comparator ?!ΣI0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit SΣI1..1stringUnit representation
..... system SI1..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
..... code SI1..1codePrimitive Type code
Fixed Value: {Beats}/min
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nominal value set (preferred)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: Heart Rate Measurement Body Location Precoordinated value set (preferred)
... method I0..1CodeableConceptHow it was done
Binding: Heart Rate Measurement Method value set (preferred)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device SI0..1Reference(Device | BloodPressureDevice)(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(QuestionnaireResponse | MolecularSequence | Vital Signs Profile)Used when reporting vital signs panel components
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile)Related measurements the observation is made from
... component SΣI0..*BackboneElementUsed when reporting systolic and diastolic blood pressure.
vs-3: If there is no a value a data absent reason must be present
.... 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 SΣI1..1CodeableConceptType of component observation (code / type)
Binding: VitalSigns (extensible)
.... value[x] SΣI0..1Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required)
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*See referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*observation-heartrateHeart Rate
... MeasurementDeviceExt S0..*CodeableConceptMeasurement Device
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementDeviceExt
Binding: Heart Rate Measurement Device value set (preferred)
... ExerciseAssociationExt S0..1CodeableConceptExercise Association
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/ExerciseAssociationExt
Binding: Exertion Phase value set (preferred)
... BodyPositionExt S0..1CodeableConceptBody Position
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/BodyPositionExt
Binding: Body Position value set (preferred)
... MeasurementSettingExt 0..1CodeableConceptMeasurement setting
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementSettingExt
Binding: Measurement Setting value set (preferred)
... status S1..1coderegistered | preliminary | final | amended +
... code S1..1CodeableConceptHeart Rate
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: 8867-4
..... display1..1stringRepresentation defined by the system
Fixed Value: Heart rate
... subject S1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] S1..1dateTime, PeriodOften just a dateTime for Vital Signs
... valueQuantity S0..1QuantityVital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S1..1stringUnit representation
.... system S1..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
.... code S1..1codePrimitive Type code
Fixed Value: {Beats}/min
... dataAbsentReason S0..1CodeableConceptWhy the result is missing
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nominal value set (preferred)
... bodySite 0..1CodeableConceptObserved body part
Binding: Heart Rate Measurement Body Location Precoordinated value set (preferred)
... method 0..1CodeableConceptHow it was done
Binding: Heart Rate Measurement Method value set (preferred)
... device S0..1Reference(Device | BloodPressureDevice)(Measurement) Device

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*observation-heartrateHeart Rate
... 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
... MeasurementDeviceExt SI0..*CodeableConceptMeasurement Device
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementDeviceExt
... ExerciseAssociationExt SI0..1CodeableConceptExercise Association
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/ExerciseAssociationExt
... BodyPositionExt SI0..1CodeableConceptBody Position
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/BodyPositionExt
... MeasurementSettingExt I0..1CodeableConceptMeasurement setting
URL: http://hl7.org/fhir/us/vitals/StructureDefinition/MeasurementSettingExt
... 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 SI1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred)
.... category:VSCat SI1..1CodeableConceptClassification 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ΣI1..*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 SΣI1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version ΣI0..1stringVersion of the system - if relevant
...... code SΣI1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... code SΣI1..1CodeableConceptHeart Rate
Binding: VitalSigns (extensible)
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: 8867-4
..... display1..1stringRepresentation defined by the system
Fixed Value: Heart rate
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code, value:system
..... coding:HeartRateCode ΣI1..1CodingCode 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 ΣI1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: 8867-4
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... subject SΣI1..1Reference(US Core Patient Profile)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] SΣI1..1Often just a dateTime for Vital Signs
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... 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..1(Slice Definition)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
.... value[x]:valueQuantity SΣI0..1QuantityVital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣI1..1decimalNumerical value (with implicit precision)
..... comparator ?!ΣI0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit SΣI1..1stringUnit representation
..... system SI1..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
..... code SI1..1codePrimitive Type code
Fixed Value: {Beats}/min
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nominal value set (preferred)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: Heart Rate Measurement Body Location Precoordinated value set (preferred)
... method I0..1CodeableConceptHow it was done
Binding: Heart Rate Measurement Method value set (preferred)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device SI0..1Reference(Device | BloodPressureDevice)(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(QuestionnaireResponse | MolecularSequence | Vital Signs Profile)Used when reporting vital signs panel components
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile)Related measurements the observation is made from
... component SΣI0..*BackboneElementUsed when reporting systolic and diastolic blood pressure.
vs-3: If there is no a value a data absent reason must be present
.... 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 SΣI1..1CodeableConceptType of component observation (code / type)
Binding: VitalSigns (extensible)
.... value[x] SΣI0..1Vital Sign Value recorded with UCUM
Binding: VitalSignsUnits (required)
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*See referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

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

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:VSCatpreferredObservationCategoryCodes
Observation.codeextensiblePattern: LOINC code 8867-4("Heart rate")
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationpreferredAbnormalInterpretationNumericNom
Observation.bodySitepreferredHeartRateMeasurementBodyLocationPrecoordinatedvalueset
Observation.methodpreferredHeartRateMeasurementMethodvalueset
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeextensibleVitalSigns
Observation.component.value[x]requiredVitalSignsUnits
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ObservationIf 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-4ObservationIf 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-5ObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ObservationA resource should have narrative for robust management
: text.`div`.exists()
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7ObservationIf 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-2ObservationIf 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())
ele-1Observation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:measurementDeviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extension:measurementDeviceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:exerciseAssociationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extension:exerciseAssociationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:BodyPositionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extension:BodyPositionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:MeasurementSettingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extension:MeasurementSettingMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.category:VSCat.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.category:VSCat.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.category:VSCat.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.category:VSCat.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:VSCat.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:HeartRateCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:HeartRateCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.code.coding:HeartRateCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.code.coding:HeartRateCode.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:HeartRateCode.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:HeartRateCode.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:HeartRateCode.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:HeartRateCode.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vs-1Observation.effective[x]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
ele-1Observation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.value[x]:valueQuantity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.value[x]:valueQuantity.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1Observation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vs-3Observation.componentIf there is no a value a data absent reason must be present
: value.exists() or dataAbsentReason.exists()
ele-1Observation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())