Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-HeartRate

WARNING This page contains a draft CBB, as raw output from the zib export and automatic conversion to CBB. It requires thorough review and adaption to the Belgian realm. This CBB is merely added for informative use.

CBB	Description	Status
HdBe-HeartRate	The heart rate is the number of heartbeats per minute. Purpose Obtaining information on circulation and heart function by measuring the heartrate. Evidence Base Heart rate (electric or auscultatory rhythm of the ventricles) and pulse rate (tangible output in the peripheral arteries) are physiologically different things, but produce the same values in normal circulation (beats per minute) and are therefore used interchangeably by many healthcare professionals (and laymen). This is however incorrect, as a patient’s pulse rate can be lower than their heart rate. Nevertheless, in daily practice, the pulse is usually palpated to measure heart rate and also written down as the heart rate. For this reason, the HeartRate information model, in addition to the PulseRate information model, offers the option to enter palpation as the HeartRateMeasurementMethod. Instructions A Holter registration is a 24-hour ECG: an ECG with a very long measuring period.	draft

CBB

Description

Status

HdBe-HeartRate

The heart rate is the number of heartbeats per minute.

Purpose

Obtaining information on circulation and heart function by measuring the heartrate.

Evidence Base

Heart rate (electric or auscultatory rhythm of the ventricles) and pulse rate (tangible output in the peripheral arteries) are physiologically different things, but produce the same values in normal circulation (beats per minute) and are therefore used interchangeably by many healthcare professionals (and laymen). This is however incorrect, as a patient’s pulse rate can be lower than their heart rate. Nevertheless, in daily practice, the pulse is usually palpated to measure heart rate and also written down as the heart rate. For this reason, the HeartRate information model, in addition to the PulseRate information model, offers the option to enter palpation as the HeartRateMeasurementMethod.

Instructions

A Holter registration is a 24-hour ECG: an ECG with a very long measuring period.

draft

HeartRate			Observation Heart Rate Profile	Element id HeartRate Short description HeartRate Definition Root concept of the HeartRate information model. This root concept contains all data elements of the HeartRate information model. Data type Observation Heart Rate Profile Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id HeartRate.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id HeartRate.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
HeartRateValue	I	1..1	Quantity	Element id HeartRate.HeartRateValue Short description HeartRateValue Definition The heart rate measured as the number of heartbeats per minute. Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. Data type Quantity Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3: If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()` Mappings rim: n/a v2: SN (see also Range) or CQ rim: PQ, IVL<PQ>, MO, CO, depending on the values
HeartRateDateTime		1..1	dateTime	Element id HeartRate.HeartRateDateTime Short description HeartRateDateTime Definition Date and time of the heart rate measurement. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
HeartRateMeasurementMethod		0..1	CodeableConceptBinding	Element id HeartRate.HeartRateMeasurementMethod Short description HeartRateMeasurementMethod Definition The method used to count and observe the heart rate. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding HeartRateMeasurementMethod codes HeartRateMeasurementMethod (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Comment		0..1	string	Element id HeartRate.Comment Short description Comment Definition Comment on any problems or factors that may influence the measurement. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
HeartbeatRegularity		0..1	CodeableConceptBinding	Element id HeartRate.HeartbeatRegularity Short description HeartbeatRegularity Definition Regularity of the heartbeat. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding HeartbeatRegularity codes HeartbeatRegularity (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
InterpretationHeartRate		0..1	CodeableConceptBinding	Element id HeartRate.InterpretationHeartRate Short description InterpretationHeartRate Definition Interpretation heart rate Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding InterpretationHeartRate codes InterpretationHeartRate (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

HeartRate		0..*
HeartRate.HeartRateValue	Quantity	1..1
HeartRate.HeartRateDateTime	dateTime	1..1
HeartRate.HeartRateMeasurementMethod	CodeableConcept	0..1
HeartRate.Comment	string	0..1
HeartRate.HeartbeatRegularity	CodeableConcept	0..1
HeartRate.InterpretationHeartRate	CodeableConcept	0..1

HeartRate
Definition	Root concept of the HeartRate information model. This root concept contains all data elements of the HeartRate information model.
Cardinality	0...*
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
HeartRate.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
HeartRate.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
HeartRate.HeartRateValue
Definition	The heart rate measured as the number of heartbeats per minute.
Cardinality	1...1
Type	Quantity
Comments	The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3: If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()`
Mappings	rim: n/a v2: SN (see also Range) or CQ rim: PQ, IVL<PQ>, MO, CO, depending on the values
HeartRate.HeartRateDateTime
Definition	Date and time of the heart rate measurement.
Cardinality	1...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
HeartRate.HeartRateMeasurementMethod
Definition	The method used to count and observe the heart rate.
Cardinality	0...1
Type	CodeableConcept
Binding	HeartRateMeasurementMethod codes HeartRateMeasurementMethod (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
HeartRate.Comment
Definition	Comment on any problems or factors that may influence the measurement.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
HeartRate.HeartbeatRegularity
Definition	Regularity of the heartbeat.
Cardinality	0...1
Type	CodeableConcept
Binding	HeartbeatRegularity codes HeartbeatRegularity (required)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
HeartRate.InterpretationHeartRate
Definition	Interpretation heart rate
Cardinality	0...1
Type	CodeableConcept
Binding	InterpretationHeartRate codes InterpretationHeartRate (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

Example instances

[CBB name]
[Concept name ]	[example value]

// example of NameInformation

## Example instances

| NameInformation      |                   |
|----------------------|-------------------|
| FirstNames | Johanna Petronella Maria   
| Initials | J.P.M. 
| GivenName | Jo 
| NameUsage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| LastName.Prefix | van
| LastName.LastName | Putten
| LastNamePartner.PartnerPrefix | van der
| LastNamePartner.PartnerLastName | Giessen
| Titles |

zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference

Concept	Category	Description
`[element.path]`	[category of change]	[Description of change]([Reference to ticket/issue/zulip chat using MarkDown link])

Terminology Bindings

Path	Name	Strength	URL
HeartRateMeasurementMethod	HeartRateMeasurementMethod	extensible	https://fhir.healthdata.be/ValueSet/HeartRateMeasurementMethod
HeartbeatRegularity	HeartbeatRegularity	required	https://fhir.healthdata.be/ValueSet/HeartbeatRegularity
InterpretationHeartRate	InterpretationHeartRate	extensible	https://fhir.healthdata.be/ValueSet/InterpretationHeartRate