STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

10.1.18.14 StructureDefinition: HeartRate

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/heartrate

FHIR Heart Rate Profile

This profile was published on Fri, Mar 25, 2016 00:00+1100 as a draft by Health Level Seven International (Orders and Observations Workgroup).

10.1.18.14.1 Formal Views of Profile Content

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

This structure is derived from Vital Signs Profile.

Summary

10.1.18.14.2 Complete Summary of the Mandatory Requirements

  1. One code in Observation.code which must have
    • a fixed Observation.code.coding.system='http<i</i://loinc.org'
    • a fixed Observation.code.coding.code= '8867-4'
    • Other additional codes are allowed - e.g. more specific LOINC Codes, SNOMED CT concepts, system specific codes. All codes SHALL have an system value
  2. a fixedObservation.valueQuantity.code = '/min'

Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of code

This structure is derived from Vital Signs Profile.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*FHIR Heart Rate Profile
... code 1..1CodeableConceptHeart Rate
.... coding CodingSlice: Unordered, Open, by code
.... coding 1..*Coding
..... system 1..1uriFixed Value: http://loinc.org
..... code 1..1codeFixed Value: 8867-4
... valueQuantity 0..1Quantity
.... code 1..1codeFixed Value: /min

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*FHIR Heart Rate Profile
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?!S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S∑1..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S∑1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
..... version ∑0..1stringVersion of the system - if relevant
..... code S∑1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text ∑0..1stringPlain text representation of the concept
... code S∑1..1CodeableConceptHeart Rate
Binding: Vital Signs (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S∑CodingCode defined by a terminology system
Slice: Unordered, Open, by code
.... coding S∑1..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S∑1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version ∑0..1stringVersion of the system - if relevant
..... code S∑1..1codeSymbol in syntax defined by the system
Fixed Value: 8867-4
..... display S∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text ∑0..1stringPlain text representation of the concept
... subject S∑1..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] S∑1..1dateTime, PeriodOften just a dateTime for Vital Signs
... issued ∑0..1instantDate/Time this was made available
... performer ∑0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity S∑I0..1QuantityVital Sign Value recorded with UCUM
Binding: Vital Signs Units (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S∑1..1decimalNumerical value (with implicit precision)
.... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit S∑0..1stringUnit representation
.... system S∑I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S∑1..1codeCoded responses from the common UCUM units for vital signs value set.
Fixed Value: /min
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SI0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... low SI0..1SimpleQuantityA fixed quantity (no comparator)
ele-1: All FHIR elements must have a @value or children
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S∑0..1decimalNumerical value (with implicit precision)
..... unit S∑0..1stringUnit representation
..... system S∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S∑0..1codeCoded form of the unit
.... high SI0..1SimpleQuantityA fixed quantity (no comparator)
ele-1: All FHIR elements must have a @value or children
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S∑0..1decimalNumerical value (with implicit precision)
..... unit S∑0..1stringUnit representation
..... system S∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S∑0..1codeCoded form of the unit
.... meaning S0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... related ∑0..*BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation:heartrate.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from Vital Signs Profile.

Summary

10.1.18.14.3 Complete Summary of the Mandatory Requirements

  1. One code in Observation.code which must have
    • a fixed Observation.code.coding.system='http<i</i://loinc.org'
    • a fixed Observation.code.coding.code= '8867-4'
    • Other additional codes are allowed - e.g. more specific LOINC Codes, SNOMED CT concepts, system specific codes. All codes SHALL have an system value
  2. a fixedObservation.valueQuantity.code = '/min'

Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of code

Differential View

This structure is derived from Vital Signs Profile.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*FHIR Heart Rate Profile
... code 1..1CodeableConceptHeart Rate
.... coding CodingSlice: Unordered, Open, by code
.... coding 1..*Coding
..... system 1..1uriFixed Value: http://loinc.org
..... code 1..1codeFixed Value: 8867-4
... valueQuantity 0..1Quantity
.... code 1..1codeFixed Value: /min

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*FHIR Heart Rate Profile
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?!S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S∑1..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S∑1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
..... version ∑0..1stringVersion of the system - if relevant
..... code S∑1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text ∑0..1stringPlain text representation of the concept
... code S∑1..1CodeableConceptHeart Rate
Binding: Vital Signs (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S∑CodingCode defined by a terminology system
Slice: Unordered, Open, by code
.... coding S∑1..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S∑1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version ∑0..1stringVersion of the system - if relevant
..... code S∑1..1codeSymbol in syntax defined by the system
Fixed Value: 8867-4
..... display S∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text ∑0..1stringPlain text representation of the concept
... subject S∑1..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] S∑1..1dateTime, PeriodOften just a dateTime for Vital Signs
... issued ∑0..1instantDate/Time this was made available
... performer ∑0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity S∑I0..1QuantityVital Sign Value recorded with UCUM
Binding: Vital Signs Units (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S∑1..1decimalNumerical value (with implicit precision)
.... comparator ?!∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit S∑0..1stringUnit representation
.... system S∑I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S∑1..1codeCoded responses from the common UCUM units for vital signs value set.
Fixed Value: /min
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SI0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... low SI0..1SimpleQuantityA fixed quantity (no comparator)
ele-1: All FHIR elements must have a @value or children
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S∑0..1decimalNumerical value (with implicit precision)
..... unit S∑0..1stringUnit representation
..... system S∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S∑0..1codeCoded form of the unit
.... high SI0..1SimpleQuantityA fixed quantity (no comparator)
ele-1: All FHIR elements must have a @value or children
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S∑0..1decimalNumerical value (with implicit precision)
..... unit S∑0..1stringUnit representation
..... system S∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S∑0..1codeCoded form of the unit
.... meaning S0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... related ∑0..*BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation:heartrate.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

10.1.18.14.4 Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeVital SignsrequiredVital Signs
Observation.valueQuantityVital Signs UnitsrequiredVital Signs Units
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes

10.1.18.14.5 Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
XPath: not(exists(f:value)) or not(count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0)
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
ele-1Observation.referenceRange.lowAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
qty-3Observation.referenceRange.lowIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Observation.referenceRange.lowThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
qty-3Observation.referenceRange.highIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Observation.referenceRange.highThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
.