StructureDefinition-UKCore-Observation-VitalSigns-HeartRate

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-VitalSigns-HeartRate0.0.12023-09-12

Defines the additional constraints and extensions on the UK Core Observation Vital Signs profile


Profile_Purpose

To provide implementers with additional support when implementing heart rate monitoring and to provide a consistent structure to how the data is presented.

url1..1System.StringFixed Value
valueReferenceReference(UK Core Observation)
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
recordingSettingI0..*Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusΣ ?!1..1codeBindingFixed Value
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
effectiveDateTimedateTime
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
issuedΣ0..1instant
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
valueΣ0..1decimal
comparatorΣ ?!0..1codeBinding
unitΣ1..1stringFixed Value
systemΣ I1..1uriFixed Value
codeΣ1..1codeFixed Value
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
bodySite0..1CodeableConceptBinding
method0..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Table View

Observation..
Observation.code..
Observation.code.coding..
Observation.code.coding.code..
Observation.code.coding1..1
Observation.code.coding.system1..
Observation.code.coding.code1..
Observation.value[x]Quantity1..
Observation.value[x].unit1..
Observation.value[x].system1..
Observation.value[x].code1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Observation-VitalSigns-HeartRate" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-VitalSigns-HeartRate" />
    <version value="0.0.1" />
    <name value="UKCoreObservationVitalSignsHeartRate" />
    <title value="UKCore Observation Vital Signs Heart Rate" />
    <status value="draft" />
    <date value="2023-09-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="Defines the additional constraints and extensions on the UK Core Observation Vital Signs profile" />
    <purpose value="To provide implementers with additional support when implementing heart rate monitoring and to provide a consistent structure to how the data is presented." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Observation" />
    <baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-VitalSigns" />
    <derivation value="constraint" />
    <differential>
        <element id="Observation.code.coding:loinc">
            <path value="Observation.code.coding" />
            <sliceName value="loinc" />
        </element>
        <element id="Observation.code.coding:loinc.code">
            <path value="Observation.code.coding.code" />
            <fixedCode value="8867-4" />
        </element>
        <element id="Observation.code.coding:snomedCT">
            <path value="Observation.code.coding" />
            <sliceName value="snomedCT" />
            <min value="1" />
            <max value="1" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-HeartRate" />
            </binding>
        </element>
        <element id="Observation.code.coding:snomedCT.system">
            <path value="Observation.code.coding.system" />
            <min value="1" />
        </element>
        <element id="Observation.code.coding:snomedCT.code">
            <path value="Observation.code.coding.code" />
            <min value="1" />
        </element>
        <element id="Observation.value[x]">
            <path value="Observation.value[x]" />
            <min value="1" />
            <type>
                <code value="Quantity" />
            </type>
        </element>
        <element id="Observation.value[x].unit">
            <path value="Observation.value[x].unit" />
            <min value="1" />
            <fixedString value="per minute" />
        </element>
        <element id="Observation.value[x].system">
            <path value="Observation.value[x].system" />
            <min value="1" />
            <fixedUri value="http://unitsofmeasure.org" />
        </element>
        <element id="Observation.value[x].code">
            <path value="Observation.value[x].code" />
            <min value="1" />
            <fixedCode value="/min" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Observation-VitalSigns-HeartRate",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-VitalSigns-HeartRate",
    "version": "0.0.1",
    "name": "UKCoreObservationVitalSignsHeartRate",
    "title": "UKCore Observation Vital Signs Heart Rate",
    "status": "draft",
    "date": "2023-09-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Defines the additional constraints and extensions on the UK Core Observation Vital Signs profile",
    "purpose": "To provide implementers with additional support when implementing heart rate monitoring and to provide a consistent structure to how the data is presented.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Observation",
    "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-VitalSigns",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Observation.code.coding:loinc",
                "path": "Observation.code.coding",
                "sliceName": "loinc"
            },
            {
                "id": "Observation.code.coding:loinc.code",
                "path": "Observation.code.coding.code",
                "fixedCode": "8867-4"
            },
            {
                "id": "Observation.code.coding:snomedCT",
                "path": "Observation.code.coding",
                "sliceName": "snomedCT",
                "min": 1,
                "max": "1",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-HeartRate"
                }
            },
            {
                "id": "Observation.code.coding:snomedCT.system",
                "path": "Observation.code.coding.system",
                "min": 1
            },
            {
                "id": "Observation.code.coding:snomedCT.code",
                "path": "Observation.code.coding.code",
                "min": 1
            },
            {
                "id": "Observation.value[x]",
                "path": "Observation.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Quantity"
                    }
                ]
            },
            {
                "id": "Observation.value[x].unit",
                "path": "Observation.value[x].unit",
                "min": 1,
                "fixedString": "per minute"
            },
            {
                "id": "Observation.value[x].system",
                "path": "Observation.value[x].system",
                "min": 1,
                "fixedUri": "http://unitsofmeasure.org"
            },
            {
                "id": "Observation.value[x].code",
                "path": "Observation.value[x].code",
                "min": 1,
                "fixedCode": "/min"
            }
        ]
    }
}

Examples

Heart Rate - An example to illustrate recording an elevated heart rate.
Example UKCore-Observation-VitalSigns-HeartRate

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:

Example Usage Scenarios

The following are example usage scenarios for the UK Core Observation Vital Signs Heart Rate profile:

  • Query and retrieve a patient's heart rate
  • Record or update a patient's heart rate

Profile Specific Implementation Guidance:

The UKCore-Observation-VitalSigns-HeartRate profile further derives from UKCore-Observation-VitalSigns and this page only shows the differences between the two. Refer to UKCore-Observation and UKCore-Observation-VitalSigns for more implementation guidance.

Minimum Viable Content

The minimum viable content that all provider and consumer systems SHALL support are the elements within the corresponding UKCore-Observation and UKCore-Observation-VitalSigns tables, along with the following.

Element Reason
Observation.value[x] A quantity SHALL be present.

Bindings (differential)

More information about the bindings to UK Core ValueSets, and other ValueSets different to UK Core Observation can be found below.

Context Strength Link
Observation.code Preferred ValueSet UKCore-HeartRate

code

The following values SHALL be used:

Observation.code.coding:loinc

The following SHALL be used for this profile:

  • Observation.code.coding.system = http://loinc.org
  • Observation.code.coding.code = 8867-4
  • Observation.code.coding.display = Heart rate

Observation.code.coding:snomedCT

The following SHALL be used for this profile:

  • Observation.code.coding.system = http://snomed.info/sct
  • Observation.code.coding.code = A SNOMED CT concept Id from ValueSet UKCore-HeartRate
  • Observation.code.coding.display = The “preferred term” associated with the SNOMED CT concept

value[x]

The cardinality of this element is 1..1, and a valueQuantity SHALL be present, and the following used for this profile:

  • Observation.valueQuantity.system = http://unitsofmeasure.org
  • Observation.valueQuantity.code = {beats}/min
  • Observation.valueQuantity.unit = heart beats per minute