Personal Health Device Implementation Guide
1.1.0 - STU 1.1 International flag

Personal Health Device Implementation Guide, published by HL7 International / Health Care Devices. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phd/ and changes regularly. See the Directory of published versions

Resource Profile: PhdDeviceMetric

Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdDeviceMetric Version: 1.1.0
Draft as of 2024-11-18 Computable Name: PhdDeviceMetric

StructureDefinition for the DeviceMetric for a PHD

This resource captures the device metric for a single type of observation that a PHD device can generate.

ACOM and GHS provide the list of observation types that a device can generate. Accuracy can be specified as well. In GHS the valid range and schedule information can be present. This information can be mapped to a PhdDeviceMetric FHIR Resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from DeviceMetric

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Accuracy 0..1 Quantity Numeric Accuracy
URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy
... type
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:MDCType 1..1 Coding The 11073-10101 MDC code for the metric
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:11073:10101
...... code 1..1 code Symbol in syntax defined by the system
.... text 0..1 string It is recommended to display at least the reference identifier for the MDC code.
... unit 0..1 CodeableConcept Unit of Measure for the Metric
... operationalStatus 0..1 code on | off | standby | entered-in-error
... category 1..1 code measurement | setting | calculation | unspecified
... measurementPeriod 0..1 Timing Describes the measurement repetition time

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device
... 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
.... Accuracy 0..1 Quantity Numeric Accuracy
URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:MDCType Σ 1..1 Coding The 11073-10101 MDC code for the metric
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:11073:10101
...... code Σ 1..1 code Symbol in syntax defined by the system
.... text Σ 0..1 string It is recommended to display at least the reference identifier for the MDC code.
... unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Binding: DeviceMetricAndComponentTypes (preferred): Describes the unit of the metric.

... source Σ 0..1 Reference(PhdDevice) Describes the link to the source Device
... operationalStatus Σ 0..1 code on | off | standby | entered-in-error
Binding: DeviceMetricOperationalStatus (required): Describes the operational status of the DeviceMetric.

... category Σ 1..1 code measurement | setting | calculation | unspecified
Binding: DeviceMetricCategory (required): Describes the category of the metric.

... measurementPeriod Σ 0..1 Timing Describes the measurement repetition time

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DeviceMetric.typepreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.unitpreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.operationalStatusrequiredDeviceMetricOperationalStatus
http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1
from the FHIR Standard
DeviceMetric.categoryrequiredDeviceMetricCategory
http://hl7.org/fhir/ValueSet/metric-category|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceMetricIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceMetricIf 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-4errorDeviceMetricIf 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-5errorDeviceMetricIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceMetricA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Accuracy 0..1 Quantity Numeric Accuracy
URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Instance identifier
... type Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Binding: DeviceMetricAndComponentTypes (preferred): Describes the metric type.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:MDCType Σ 1..1 Coding The 11073-10101 MDC code for the metric
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:11073:10101
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string It is recommended to display at least the reference identifier for the MDC code.
... unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Binding: DeviceMetricAndComponentTypes (preferred): Describes the unit of the metric.

... source Σ 0..1 Reference(PhdDevice) Describes the link to the source Device
... parent Σ 0..1 Reference(Device) Describes the link to the parent Device
... operationalStatus Σ 0..1 code on | off | standby | entered-in-error
Binding: DeviceMetricOperationalStatus (required): Describes the operational status of the DeviceMetric.

... color Σ 0..1 code black | red | green | yellow | blue | magenta | cyan | white
Binding: DeviceMetricColor (required): Describes the typical color of representation.

... category Σ 1..1 code measurement | setting | calculation | unspecified
Binding: DeviceMetricCategory (required): Describes the category of the metric.

... measurementPeriod Σ 0..1 Timing Describes the measurement repetition time
... calibration Σ 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 code unspecified | offset | gain | two-point
Binding: DeviceMetricCalibrationType (required): Describes the type of a metric calibration.

.... state Σ 0..1 code not-calibrated | calibration-required | calibrated | unspecified
Binding: DeviceMetricCalibrationState (required): Describes the state of a metric calibration.

.... time Σ 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DeviceMetric.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DeviceMetric.typepreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.unitpreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.operationalStatusrequiredDeviceMetricOperationalStatus
http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1
from the FHIR Standard
DeviceMetric.colorrequiredDeviceMetricColor
http://hl7.org/fhir/ValueSet/metric-color|4.0.1
from the FHIR Standard
DeviceMetric.categoryrequiredDeviceMetricCategory
http://hl7.org/fhir/ValueSet/metric-category|4.0.1
from the FHIR Standard
DeviceMetric.calibration.typerequiredDeviceMetricCalibrationType
http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1
from the FHIR Standard
DeviceMetric.calibration.staterequiredDeviceMetricCalibrationState
http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceMetricIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceMetricIf 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-4errorDeviceMetricIf 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-5errorDeviceMetricIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceMetricA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DeviceMetric

Summary

Mandatory: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DeviceMetric.type.coding

Differential View

This structure is derived from DeviceMetric

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Accuracy 0..1 Quantity Numeric Accuracy
URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy
... type
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:MDCType 1..1 Coding The 11073-10101 MDC code for the metric
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:11073:10101
...... code 1..1 code Symbol in syntax defined by the system
.... text 0..1 string It is recommended to display at least the reference identifier for the MDC code.
... unit 0..1 CodeableConcept Unit of Measure for the Metric
... operationalStatus 0..1 code on | off | standby | entered-in-error
... category 1..1 code measurement | setting | calculation | unspecified
... measurementPeriod 0..1 Timing Describes the measurement repetition time

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device
... 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
.... Accuracy 0..1 Quantity Numeric Accuracy
URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:MDCType Σ 1..1 Coding The 11073-10101 MDC code for the metric
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:11073:10101
...... code Σ 1..1 code Symbol in syntax defined by the system
.... text Σ 0..1 string It is recommended to display at least the reference identifier for the MDC code.
... unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Binding: DeviceMetricAndComponentTypes (preferred): Describes the unit of the metric.

... source Σ 0..1 Reference(PhdDevice) Describes the link to the source Device
... operationalStatus Σ 0..1 code on | off | standby | entered-in-error
Binding: DeviceMetricOperationalStatus (required): Describes the operational status of the DeviceMetric.

... category Σ 1..1 code measurement | setting | calculation | unspecified
Binding: DeviceMetricCategory (required): Describes the category of the metric.

... measurementPeriod Σ 0..1 Timing Describes the measurement repetition time

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DeviceMetric.typepreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.unitpreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.operationalStatusrequiredDeviceMetricOperationalStatus
http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1
from the FHIR Standard
DeviceMetric.categoryrequiredDeviceMetricCategory
http://hl7.org/fhir/ValueSet/metric-category|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceMetricIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceMetricIf 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-4errorDeviceMetricIf 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-5errorDeviceMetricIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceMetricA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Accuracy 0..1 Quantity Numeric Accuracy
URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Instance identifier
... type Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Binding: DeviceMetricAndComponentTypes (preferred): Describes the metric type.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:MDCType Σ 1..1 Coding The 11073-10101 MDC code for the metric
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:11073:10101
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string It is recommended to display at least the reference identifier for the MDC code.
... unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Binding: DeviceMetricAndComponentTypes (preferred): Describes the unit of the metric.

... source Σ 0..1 Reference(PhdDevice) Describes the link to the source Device
... parent Σ 0..1 Reference(Device) Describes the link to the parent Device
... operationalStatus Σ 0..1 code on | off | standby | entered-in-error
Binding: DeviceMetricOperationalStatus (required): Describes the operational status of the DeviceMetric.

... color Σ 0..1 code black | red | green | yellow | blue | magenta | cyan | white
Binding: DeviceMetricColor (required): Describes the typical color of representation.

... category Σ 1..1 code measurement | setting | calculation | unspecified
Binding: DeviceMetricCategory (required): Describes the category of the metric.

... measurementPeriod Σ 0..1 Timing Describes the measurement repetition time
... calibration Σ 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 code unspecified | offset | gain | two-point
Binding: DeviceMetricCalibrationType (required): Describes the type of a metric calibration.

.... state Σ 0..1 code not-calibrated | calibration-required | calibrated | unspecified
Binding: DeviceMetricCalibrationState (required): Describes the state of a metric calibration.

.... time Σ 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DeviceMetric.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DeviceMetric.typepreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.unitpreferredDeviceMetricAndComponentTypes
http://hl7.org/fhir/ValueSet/devicemetric-type
from the FHIR Standard
DeviceMetric.operationalStatusrequiredDeviceMetricOperationalStatus
http://hl7.org/fhir/ValueSet/metric-operational-status|4.0.1
from the FHIR Standard
DeviceMetric.colorrequiredDeviceMetricColor
http://hl7.org/fhir/ValueSet/metric-color|4.0.1
from the FHIR Standard
DeviceMetric.categoryrequiredDeviceMetricCategory
http://hl7.org/fhir/ValueSet/metric-category|4.0.1
from the FHIR Standard
DeviceMetric.calibration.typerequiredDeviceMetricCalibrationType
http://hl7.org/fhir/ValueSet/metric-calibration-type|4.0.1
from the FHIR Standard
DeviceMetric.calibration.staterequiredDeviceMetricCalibrationState
http://hl7.org/fhir/ValueSet/metric-calibration-state|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceMetricIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceMetricIf 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-4errorDeviceMetricIf 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-5errorDeviceMetricIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceMetricA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DeviceMetric

Summary

Mandatory: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DeviceMetric.type.coding

 

Other representations of profile: CSV, Excel, Schematron