HL7.FHIR.US.CARDX-HTN\Heart Rate

CardX Hypertension Management Use Case
0.1.0 - ci-build

CardX Hypertension Management Use Case, published by Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/cardx-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Heart Rate

Official URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/heart-rate				Version: 0.1.0
Draft as of 2023-08-03				Computable Name: HeartRate

The number of heart beats in a minute.

Usage:

Examples for this Resource Profile: Observation/HeartRate-MS and Observation/HeartRate-Mandatory

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation		0..*	Observation	Measurements and simple assertions
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
measurementDevice		0..1	CodeableConcept	Measurement Device Type URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode Binding: FHIRDeviceTypes (example)
value[x]		1..1	CodeableConcept	Value of extension Binding: Heart Rate Measurement Device value set (extensible)
exerciseAssociation		0..1	CodeableConcept	Exercise Association URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/ExerciseAssociationExt Binding: Exertion Phase value set (extensible)
bodyPosition		0..1	CodeableConcept	Body Position URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
value[x]		1..1	CodeableConcept	Value of extension Binding: Body Position value set (extensible)
measurementSetting		0..1	CodeableConcept	Measurement setting URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/MeasurementSettingExt Binding: Measurement Setting value set (extensible)
sleepStatus		0..1	CodeableConcept	Sleep Status URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/SleepStatusExt Binding: Sleep Status value set (extensible)
associatedSituation		0..1	CodeableConcept	Associated Situation URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/AssociatedSituationExt
status	S	1..1	code	registered \| preliminary \| final \| amended +
category
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/observation-category
code		0..1	code	Symbol in syntax defined by the system Required Pattern: vital-signs
code		1..1	CodeableConcept	Heart rate
subject	S	1..1	Reference(Patient)	Who and/or what the observation is about
effective[x]	S	1..1	dateTime, Period, Timing, instant	Clinically relevant time/time-period for observation
value[x]	S	0..1	Quantity	Actual result
value	S	1..1	decimal	Numerical value (with implicit precision)
unit	S	1..1	string	Unit representation
system	S	1..1	uri	System that defines coded unit form Fixed Value: http://unitsofmeasure.org
code	S	1..1	code	Coded form of the unit Fixed Value: /min
dataAbsentReason	S	0..1	CodeableConcept	Why the result is missing
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible)
bodySite	S	0..1	CodeableConcept	Observed body part Binding: Heart Rate Measurement Body Location Precoordinated value set (extensible)
method	S	0..1	CodeableConcept	How it was done Binding: Heart Rate Measurement Method value set (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Observation.extension:measurementDevice.value[x]	extensible	HeartRateMeasurementDevicevalueset
Observation.extension:bodyPosition.value[x]	extensible	BodyPositionvalueset
Observation.interpretation	extensible	NumericResultInterpretationNom
Observation.bodySite	extensible	HeartRateMeasurementBodyLocationPrecoordinatedvalueset
Observation.method	extensible	HeartRateMeasurementMethodvalueset

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	Observation	Measurements and simple assertions
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
measurementDevice		0..1	CodeableConcept	Measurement Device Type URL: http://hl7.org/fhir/StructureDefinition/observation-deviceCode Binding: FHIRDeviceTypes (example)
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/observation-deviceCode"
value[x]		1..1	CodeableConcept	Value of extension Binding: Heart Rate Measurement Device value set (extensible)
exerciseAssociation		0..1	CodeableConcept	Exercise Association URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/ExerciseAssociationExt Binding: Exertion Phase value set (extensible)
bodyPosition		0..1	CodeableConcept	Body Position URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/observation-bodyPosition"
value[x]		1..1	CodeableConcept	Value of extension Binding: Body Position value set (extensible)
measurementSetting		0..1	CodeableConcept	Measurement setting URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/MeasurementSettingExt Binding: Measurement Setting value set (extensible)
sleepStatus		0..1	CodeableConcept	Sleep Status URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/SleepStatusExt Binding: Sleep Status value set (extensible)
associatedSituation		0..1	CodeableConcept	Associated Situation URL: http://hl7.org/fhir/us/cardx-htn/StructureDefinition/AssociatedSituationExt
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
code	Σ	1..1	CodeableConcept	Heart rate Binding: LOINCCodes (example): Codes identifying names of simple observations.
subject	SΣ	1..1	Reference(Patient)	Who and/or what the observation is about
effective[x]	SΣ	1..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
value[x]	SΣC	0..1	Quantity	Actual result
value	SΣ	1..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< \| <= \| >= \| > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	SΣ	1..1	string	Unit representation
system	SΣC	1..1	uri	System that defines coded unit form Fixed Value: http://unitsofmeasure.org
code	SΣ	1..1	code	Coded form of the unit Fixed Value: /min
dataAbsentReason	SC	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: Numeric Result Interpretation value set (extensible)
bodySite	S	0..1	CodeableConcept	Observed body part Binding: Heart Rate Measurement Body Location Precoordinated value set (extensible)
method	S	0..1	CodeableConcept	How it was done Binding: Heart Rate Measurement Method value set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Observation.extension:measurementDevice.value[x]	extensible	HeartRateMeasurementDevicevalueset
Observation.extension:bodyPosition.value[x]	extensible	BodyPositionvalueset
Observation.status	required	ObservationStatus
Observation.code	example	LOINCCodes (a valid code from LOINC)
Observation.value[x].comparator	required	QuantityComparator
Observation.dataAbsentReason	extensible	DataAbsentReason
Observation.interpretation	extensible	NumericResultInterpretationNom
Observation.bodySite	extensible	HeartRateMeasurementBodyLocationPrecoordinatedvalueset
Observation.method	extensible	HeartRateMeasurementMethodvalueset

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If 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-4	error	Observation	If 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-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If 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()