| HeartRate UML Documentation |
Summary:AttributesConstraintsProperties | Detail:Attributes |
Heart rate is the speed of the heartbeat measured by the number of poundings of the heart per unit of time — typically beats per minute (bpm). The heart rate is commonly measured by observing the patient’s pulse, which is the physical expansion of the artery. The pulse commonly taken is from the radial artery at the wrist. Sometimes the pulse cannot be taken at the wrist and is taken at the elbow (brachial artery), at the neck against the carotid artery (carotid pulse), behind the knee (popliteal artery), or in the foot dorsalis pedis or posterior tibial arteries. In addition, the heart rate may be measured directly electrocardiography (adapted from Wikipedia).This class represents the measurement (or “clinical observation�) of the patient’s heart rate. This class re-defines the generic clinical Observation class to fix the observed characteristic to LOINC 8867-4 and to set the data type of the observation value to a Physical Quantity Ratio. It also redefines the bodySite and method properties such that they are bound to the Heart Rate Measurement Site and Heart Rate Measurement Method valuesets, respectively.
Attributes | ||
«CS» Code | bodySite |
This property contains the code that specifies the anatomical site or system that is the focus of the observation. In the generic clinical Observation class, this code is not “bound� to a particular value set. In this class, the property is re-defined to a set of values that are appropriate to heart rate measurements. These values come from the SNOMED-CT coding system. |
«CS» Code | method |
This property contains the code that specifies additional detail about the means or technique used to ascertain the Observation. In the generic clinical Observation class, this code is not “bound� to a particular value set. In this class, the property is re-defined to a set of values that are appropriate to heart rate measurements. These values come from the SNOMED-CT coding system. |
«CS» Code | patientPositionQualifier |
Certain disease states can be detected by observing differences in heart rate, blood pressure, or respiration when the patient’s body is in different positions (e.g., sitting, standing, etc.). It therefore may be necessary to record the patient’s body position when recording the primary observation. This property records an observation of the patient’s body position during the time the heart rate, blood pressure, or respiration rate was observed. |
«CS» Code | patientStateExertionQualifier |
Heart Rate, Blood Pressure, Respiration, and Blood Oxygen levels naturally vary depending on whether the patient is at rest, or during or shortly after exercise. This property records an sub-observation of whether the patient was at rest, exercising, or recently had been exercising at the time of the measurement. |
«PQ» Quantity | value |
This property contains the result, or value of the clinical Observation. In the generic clinical Observation class, the data type for this property can be anything. Heart rate is expressed in terms of beats per minute. Therefore, this property has been re-defined to constrain the data type to be a Quantity, expressed in terms of beats per minute. Note that while beats per minute is technically a Ratio, it is always expressed in terms of one minute, so it can be thought of as a unit of measure rather than a full-fledged ratio. |
Attributes inherited from FHIM::ClinicalObservation::ObservationStatement | ||
basedOn, bodySite, category, componentObservation, dataAbsentReason, dateTime, dateTimeIssued, deltaFlag, description, deviceInstance, evaluationProcedure, exceptionValue, interpretationEvent, method, multimedia, observed, observedCharacteristic, referenceRange, reliability, resultStatus, specimen, value, derivedFrom, hasMember, partOf |
Attributes inherited from FHIM::Common::ClinicalStatement | ||
clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | HeartRateObservation |
Name Expression | |
Namespace | HeartRate |
Owned Template Signature | |
Owner | HeartRate |
Owning Template Parameter | |
Package | HeartRate |
Qualified Name | FHIM::VitalSigns::HeartRate::HeartRateObservation |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «CS» Code bodySite
This property contains the code that specifies the anatomical site or system that is the focus of the observation. In the generic clinical Observation class, this code is not “bound� to a particular value set. In this class, the property is re-defined to a set of values that are appropriate to heart rate measurements. These values come from the SNOMED-CT coding system.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HeartRateObservation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | redefine |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | bodySite |
Name Expression | |
Namespace | HeartRateObservation |
Opposite | |
Owner | HeartRateObservation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::VitalSigns::HeartRate::HeartRateObservation::bodySite |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code method
This property contains the code that specifies additional detail about the means or technique used to ascertain the Observation. In the generic clinical Observation class, this code is not “bound� to a particular value set. In this class, the property is re-defined to a set of values that are appropriate to heart rate measurements. These values come from the SNOMED-CT coding system.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HeartRateObservation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | redefine |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | method |
Name Expression | |
Namespace | HeartRateObservation |
Opposite | |
Owner | HeartRateObservation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::VitalSigns::HeartRate::HeartRateObservation::method |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code patientPositionQualifier
Certain disease states can be detected by observing differences in heart rate, blood pressure, or respiration when the patient’s body is in different positions (e.g., sitting, standing, etc.). It therefore may be necessary to record the patient’s body position when recording the primary observation. This property records an observation of the patient’s body position during the time the heart rate, blood pressure, or respiration rate was observed.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HeartRateObservation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | patientPositionQualifier |
Name Expression | |
Namespace | HeartRateObservation |
Opposite | |
Owner | HeartRateObservation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::VitalSigns::HeartRate::HeartRateObservation::patientPositionQualifier |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code patientStateExertionQualifier
Heart Rate, Blood Pressure, Respiration, and Blood Oxygen levels naturally vary depending on whether the patient is at rest, or during or shortly after exercise. This property records an sub-observation of whether the patient was at rest, exercising, or recently had been exercising at the time of the measurement.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HeartRateObservation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | patientStateExertionQualifier |
Name Expression | |
Namespace | HeartRateObservation |
Opposite | |
Owner | HeartRateObservation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::VitalSigns::HeartRate::HeartRateObservation::patientStateExertionQualifier |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» Quantity value
This property contains the result, or value of the clinical Observation. In the generic clinical Observation class, the data type for this property can be anything. Heart rate is expressed in terms of beats per minute. Therefore, this property has been re-defined to constrain the data type to be a Quantity, expressed in terms of beats per minute. Note that while beats per minute is technically a Ratio, it is always expressed in terms of one minute, so it can be thought of as a unit of measure rather than a full-fledged ratio.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HeartRateObservation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | redefine |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | value |
Name Expression | |
Namespace | HeartRateObservation |
Opposite | |
Owner | HeartRateObservation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::VitalSigns::HeartRate::HeartRateObservation::value |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Constraints | |
ValueIsBPM | self.value.unit.code = '{beats}/min' and self.value.value.literal >= 0.0 and self.value.value.literal <= 300 -- need to verify upper limit |
TopicIsHeartRate | self.topicCode.codeSystem.codeSystemName = 'LOINC' and self.topicCode.code = '8867-4' |
| HeartRate UML Documentation |
Summary:AttributesConstraintsProperties | Detail:Attributes |