Personal Health Device Implementation Guide
2.0.1 - STU 2
Personal Health Device Implementation Guide
2.0.1 - STU 2
Personal Health Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 2.0.1 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
| Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdDeviceMetric | Version: 2.0.1 | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: PhdDeviceMetric | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.73.42.11 | |||||
Profile for the DeviceMetric for a PHD
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 as follows:
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:Accuracy |
0..1 | Quantity | Numeric Accuracy URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy | |
| extension:Confidence95 |
0..1 | Range | Confidence95 URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Confidence95 | |
 extension:SimpleAlerting |
0..1 | (Complex) | SimpleAlerting URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 type |
1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: DeviceMetricAndComponentTypes (preferred): Describes the metric type. | |
 Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  coding:All Slices |
Content/Rules for all slices | |||
 system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the 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 |
1..1 | Reference(PhdDevice) | The device that is producing the metric | |
| 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceMetric.type | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.unit | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.operationalStatus | Base | required | DeviceMetricOperationalStatus | 📍4.0.1 | FHIR Std. |
| DeviceMetric.category | Base | required | DeviceMetricCategory | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceMetric | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceMetric | 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 | DeviceMetric | 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 | DeviceMetric | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceMetric | 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()
|
This structure is derived from DeviceMetric
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DeviceMetric |
0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:Accuracy |
0..1 | Quantity | Numeric Accuracy URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy | |
| extension:Confidence95 |
0..1 | Range | Confidence95 URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Confidence95 | |
| extension:SimpleAlerting |
0..1 | (Complex) | SimpleAlerting URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | |
| type |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:All Slices |
Content/Rules for all slices | |||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the 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 | |
| source |
1..1 | Reference(PhdDevice) | The device that is producing the metric | |
| parent |
0..0 | No reference to a parent device in PHD. PHDs are not part of a device hierarchy. | ||
| 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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:Accuracy |
0..1 | Quantity | Numeric Accuracy URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy | |||||
| extension:Confidence95 |
0..1 | Range | Confidence95 URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Confidence95 | |||||
| extension:SimpleAlerting |
0..1 | (Complex) | SimpleAlerting URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:All Slices |
Content/Rules for all slices | |||||||
| 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 |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..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 | |||||
| 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 |
1..1 | Reference(PhdDevice) | The device that is producing the metric | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceMetric.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceMetric.type | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.unit | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.operationalStatus | Base | required | DeviceMetricOperationalStatus | 📍4.0.1 | FHIR Std. |
| DeviceMetric.color | Base | required | DeviceMetricColor | 📍4.0.1 | FHIR Std. |
| DeviceMetric.category | Base | required | DeviceMetricCategory | 📍4.0.1 | FHIR Std. |
| DeviceMetric.calibration.type | Base | required | DeviceMetricCalibrationType | 📍4.0.1 | FHIR Std. |
| DeviceMetric.calibration.state | Base | required | DeviceMetricCalibrationState | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceMetric | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceMetric | 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 | DeviceMetric | 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 | DeviceMetric | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceMetric | 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()
|
This structure is derived from DeviceMetric
Summary
Mandatory: 5 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:Accuracy |
0..1 | Quantity | Numeric Accuracy URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy | |
| extension:Confidence95 |
0..1 | Range | Confidence95 URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Confidence95 | |
| extension:SimpleAlerting |
0..1 | (Complex) | SimpleAlerting URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| type |
1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: DeviceMetricAndComponentTypes (preferred): Describes the metric type. | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:All Slices |
Content/Rules for all slices | |||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the 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 |
1..1 | Reference(PhdDevice) | The device that is producing the metric | |
| 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceMetric.type | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.unit | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.operationalStatus | Base | required | DeviceMetricOperationalStatus | 📍4.0.1 | FHIR Std. |
| DeviceMetric.category | Base | required | DeviceMetricCategory | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceMetric | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceMetric | 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 | DeviceMetric | 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 | DeviceMetric | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceMetric | 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()
|
Differential View
This structure is derived from DeviceMetric
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DeviceMetric |
0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:Accuracy |
0..1 | Quantity | Numeric Accuracy URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy | |
| extension:Confidence95 |
0..1 | Range | Confidence95 URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Confidence95 | |
| extension:SimpleAlerting |
0..1 | (Complex) | SimpleAlerting URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | |
| type |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:All Slices |
Content/Rules for all slices | |||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the 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 | |
| source |
1..1 | Reference(PhdDevice) | The device that is producing the metric | |
| parent |
0..0 | No reference to a parent device in PHD. PHDs are not part of a device hierarchy. | ||
| 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 | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:Accuracy |
0..1 | Quantity | Numeric Accuracy URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Accuracy | |||||
| extension:Confidence95 |
0..1 | Range | Confidence95 URL: http://hl7.org/fhir/uv/phd/StructureDefinition/Confidence95 | |||||
| extension:SimpleAlerting |
0..1 | (Complex) | SimpleAlerting URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:All Slices |
Content/Rules for all slices | |||||||
| 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 |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..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 | |||||
| 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 |
1..1 | Reference(PhdDevice) | The device that is producing the metric | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceMetric.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceMetric.type | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.unit | Base | preferred | Device Metric and Component Types | 📍4.0.1 | FHIR Std. |
| DeviceMetric.operationalStatus | Base | required | DeviceMetricOperationalStatus | 📍4.0.1 | FHIR Std. |
| DeviceMetric.color | Base | required | DeviceMetricColor | 📍4.0.1 | FHIR Std. |
| DeviceMetric.category | Base | required | DeviceMetricCategory | 📍4.0.1 | FHIR Std. |
| DeviceMetric.calibration.type | Base | required | DeviceMetricCalibrationType | 📍4.0.1 | FHIR Std. |
| DeviceMetric.calibration.state | Base | required | DeviceMetricCalibrationState | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceMetric | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceMetric | 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 | DeviceMetric | 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 | DeviceMetric | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceMetric | 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()
|
This structure is derived from DeviceMetric
Summary
Mandatory: 5 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2016+ HL7 International / Devices.
Package hl7.fhir.uv.phd#2.0.1 based on FHIR 4.0.1.
Generated
2026-10-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change