Point-of-Care Device Implementation Guide
1.0.0 - STU 1

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

## Resource Profile: Enumeration DeviceMetric profile

Official URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/EnumerationDeviceMetric | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: EnumerationDeviceMetric

StructureDefinition for DeviceMetric resources that represent coded or text status, annotations, or settings characteristics and capabilities.

## Scope and Usage

This profile sets minimum expectations for the DeviceMetric resource that represents coded or text status, annotation, or setting.

Usages:

- Refer to this Profile: Enumeration Observation profile
- Examples for this Profile: DeviceMetric/RhythmStatusEnumerationDeviceMetric
- CapabilityStatements using this Profile: Server capability requirements

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
Slices for extension |  |  |  | Content/Rules for all slices
extension:number |  | 0..1 | Extension | Instance number
url |  | 1..1 | uri | "number"
Slices for value[x] |  | 1..1 | unsignedInt | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueUnsignedInt |  | 1..1 | unsignedInt | Value of extension
extension:label |  | 0..1 | Extension | Instance label
url |  | 1..1 | uri | "label"
Slices for value[x] |  | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 1..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance"
extension:relation |  | 0..* | (Complex) | Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation
extension:metricAvailability | S | 0..1 | code | Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
type | S Σ | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible)
coding | Σ | 0..* | Coding | Code defined by a terminology system
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
text | Σ | 0..1 | string | Plain text representation of the concept
source | S Σ | 1..1 | Reference(MDS Device profile) | Describes the link to the source Device
parent | S Σ | 1..1 | Reference(Channel Device profile) | Describes the link to the parent Device
operationalStatus | S Σ | 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 | S Σ | 1..1 | code | measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric.
measurementPeriod | S Σ | 0..1 | Timing | Describes the measurement repetition time
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
repeat | Σ C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
duration | Σ | 0..1 | decimal | How long when it happens
period | Σ | 0..1 | decimal | Event occurs frequency times per period
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
calibration | S Σ | 0..* | BackboneElement | Describes the calibrations that have been performed or that are required to be performed
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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DeviceMetric.type | Base | extensible | MDC Metric nomenclature | 📦1.0.0 | This IG
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.measurementPeriod.​repeat.periodUnit | Base | required | UnitsOfTime | 📍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.

#### Constraints

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()`
tim-1 | error | DeviceMetric.measurementPeriod.repeat | if there's a duration, there needs to be duration units | `duration.empty() or durationUnit.exists()`
tim-2 | error | DeviceMetric.measurementPeriod.repeat | if there's a period, there needs to be period units | `period.empty() or periodUnit.exists()`
tim-4 | error | DeviceMetric.measurementPeriod.repeat | duration SHALL be a non-negative value | `duration.exists() implies duration >= 0`
tim-5 | error | DeviceMetric.measurementPeriod.repeat | period SHALL be a non-negative value | `period.exists() implies period >= 0`
tim-6 | error | DeviceMetric.measurementPeriod.repeat | If there's a periodMax, there must be a period | `periodMax.empty() or period.exists()`
tim-7 | error | DeviceMetric.measurementPeriod.repeat | If there's a durationMax, there must be a duration | `durationMax.empty() or duration.exists()`
tim-8 | error | DeviceMetric.measurementPeriod.repeat | If there's a countMax, there must be a count | `countMax.empty() or count.exists()`
tim-9 | error | DeviceMetric.measurementPeriod.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) | `offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))`
tim-10 | error | DeviceMetric.measurementPeriod.repeat | If there's a timeOfDay, there cannot be a when, or vice versa | `timeOfDay.empty() or when.empty()`

This structure is derived from DeviceMetric

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DeviceMetric |  | 0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
Slices for extension |  |  |  | Content/Rules for all slices
extension:number |  | 0..1 | Extension | Instance number
valueUnsignedInt |  | 1..1 | unsignedInt | Value of extension
extension:label |  | 0..1 | Extension | Instance label
valueString |  | 1..1 | string | Value of extension
extension:relation |  | 0..* | (Complex) | Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation
extension:metricAvailability | S | 0..1 | code | Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability
type | S | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible)
coding |  | 0..* | Coding | Code defined by a terminology system
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
text |  | 0..1 | string | Plain text representation of the concept
unit |  | 0..0 |  | Unit of Measure for the Metric
source | S | 1..1 | Reference(MDS Device profile) | Describes the link to the source Device
parent | S | 1..1 | Reference(Channel Device profile) | Describes the link to the parent Device
operationalStatus | S | 0..1 | code | on | off | standby | entered-in-error
color |  | 0..1 | code | black | red | green | yellow | blue | magenta | cyan | white
category | S | 1..1 | code | measurement | setting | calculation | unspecified
measurementPeriod | S | 0..1 | Timing | Describes the measurement repetition time
repeat |  | 0..1 | Element | When the event is to occur
duration |  | 0..1 | decimal | How long when it happens
period |  | 0..1 | decimal | Event occurs frequency times per period
periodUnit |  | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM)
calibration | S | 0..* | BackboneElement | Describes the calibrations that have been performed or that are required to be performed
type |  | 0..1 | code | unspecified | offset | gain | two-point
state |  | 0..1 | code | not-calibrated | calibration-required | calibrated | unspecified
time |  | 0..1 | instant | Describes the time last calibration has been performed
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
DeviceMetric.type | Base | extensible | MDC Metric nomenclature | 📦1.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
extension:instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:number |  | 0..1 | Extension | Instance number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "number"
Slices for value[x] |  | 1..1 | unsignedInt | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueUnsignedInt |  | 1..1 | unsignedInt | Value of extension
extension:label |  | 0..1 | Extension | Instance label
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "label"
Slices for value[x] |  | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 1..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance"
extension:relation |  | 0..* | (Complex) | Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation
extension:metricAvailability | S | 0..1 | code | Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Instance identifier
type | S Σ | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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
text | Σ | 0..1 | string | Plain text representation of the concept
source | S Σ | 1..1 | Reference(MDS Device profile) | Describes the link to the source Device
parent | S Σ | 1..1 | Reference(Channel Device profile) | Describes the link to the parent Device
operationalStatus | S Σ | 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 | S Σ | 1..1 | code | measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric.
measurementPeriod | S Σ | 0..1 | Timing | Describes the measurement repetition time
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
event | Σ | 0..* | dateTime | When the event occurs
repeat | Σ C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
bounds[x] | Σ | 0..1 |  | Length/Range of lengths, or (Start and/or end) limits
boundsDuration |  |  | Duration |
boundsRange |  |  | Range |
boundsPeriod |  |  | Period |
count | Σ | 0..1 | positiveInt | Number of times to repeat
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat
duration | Σ | 0..1 | decimal | How long when it happens
durationMax | Σ | 0..1 | decimal | How long when it happens (Max)
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period
period | Σ | 0..1 | decimal | Event occurs frequency times per period
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours)
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
timeOfDay | Σ | 0..* | time | Time of day for action
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule.
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after)
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
calibration | S Σ | 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DeviceMetric.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
DeviceMetric.type | Base | extensible | MDC Metric nomenclature | 📦1.0.0 | This IG
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.measurementPeriod.​repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​code | Base | preferred | TimingAbbreviation | 📍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.

#### Constraints

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()`
tim-1 | error | DeviceMetric.measurementPeriod.repeat | if there's a duration, there needs to be duration units | `duration.empty() or durationUnit.exists()`
tim-2 | error | DeviceMetric.measurementPeriod.repeat | if there's a period, there needs to be period units | `period.empty() or periodUnit.exists()`
tim-4 | error | DeviceMetric.measurementPeriod.repeat | duration SHALL be a non-negative value | `duration.exists() implies duration >= 0`
tim-5 | error | DeviceMetric.measurementPeriod.repeat | period SHALL be a non-negative value | `period.exists() implies period >= 0`
tim-6 | error | DeviceMetric.measurementPeriod.repeat | If there's a periodMax, there must be a period | `periodMax.empty() or period.exists()`
tim-7 | error | DeviceMetric.measurementPeriod.repeat | If there's a durationMax, there must be a duration | `durationMax.empty() or duration.exists()`
tim-8 | error | DeviceMetric.measurementPeriod.repeat | If there's a countMax, there must be a count | `countMax.empty() or count.exists()`
tim-9 | error | DeviceMetric.measurementPeriod.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) | `offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))`
tim-10 | error | DeviceMetric.measurementPeriod.repeat | If there's a timeOfDay, there cannot be a when, or vice versa | `timeOfDay.empty() or when.empty()`

This structure is derived from DeviceMetric

The profile defines the following rules:

- `DeviceMetric.type` shall have a coding from the ISO/IEEE 11073 MDC Metric nomenclature if there is an appropriate code available.
- `DeviceMetric.source` shall be present and refer to the MDS Device resource.
- `DeviceMetric.parent` shall be present and refer to the Channel Device resource which this metric belongs to.
- If multiple instances of the same metric type exist, the Instance extension allows a squence to be defined.
- Extensions allow relationships and metric availability to be added.

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
Slices for extension |  |  |  | Content/Rules for all slices
extension:number |  | 0..1 | Extension | Instance number
url |  | 1..1 | uri | "number"
Slices for value[x] |  | 1..1 | unsignedInt | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueUnsignedInt |  | 1..1 | unsignedInt | Value of extension
extension:label |  | 0..1 | Extension | Instance label
url |  | 1..1 | uri | "label"
Slices for value[x] |  | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 1..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance"
extension:relation |  | 0..* | (Complex) | Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation
extension:metricAvailability | S | 0..1 | code | Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
type | S Σ | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible)
coding | Σ | 0..* | Coding | Code defined by a terminology system
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
text | Σ | 0..1 | string | Plain text representation of the concept
source | S Σ | 1..1 | Reference(MDS Device profile) | Describes the link to the source Device
parent | S Σ | 1..1 | Reference(Channel Device profile) | Describes the link to the parent Device
operationalStatus | S Σ | 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 | S Σ | 1..1 | code | measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric.
measurementPeriod | S Σ | 0..1 | Timing | Describes the measurement repetition time
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
repeat | Σ C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
duration | Σ | 0..1 | decimal | How long when it happens
period | Σ | 0..1 | decimal | Event occurs frequency times per period
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
calibration | S Σ | 0..* | BackboneElement | Describes the calibrations that have been performed or that are required to be performed
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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DeviceMetric.type | Base | extensible | MDC Metric nomenclature | 📦1.0.0 | This IG
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.measurementPeriod.​repeat.periodUnit | Base | required | UnitsOfTime | 📍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.

#### Constraints

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()`
tim-1 | error | DeviceMetric.measurementPeriod.repeat | if there's a duration, there needs to be duration units | `duration.empty() or durationUnit.exists()`
tim-2 | error | DeviceMetric.measurementPeriod.repeat | if there's a period, there needs to be period units | `period.empty() or periodUnit.exists()`
tim-4 | error | DeviceMetric.measurementPeriod.repeat | duration SHALL be a non-negative value | `duration.exists() implies duration >= 0`
tim-5 | error | DeviceMetric.measurementPeriod.repeat | period SHALL be a non-negative value | `period.exists() implies period >= 0`
tim-6 | error | DeviceMetric.measurementPeriod.repeat | If there's a periodMax, there must be a period | `periodMax.empty() or period.exists()`
tim-7 | error | DeviceMetric.measurementPeriod.repeat | If there's a durationMax, there must be a duration | `durationMax.empty() or duration.exists()`
tim-8 | error | DeviceMetric.measurementPeriod.repeat | If there's a countMax, there must be a count | `countMax.empty() or count.exists()`
tim-9 | error | DeviceMetric.measurementPeriod.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) | `offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))`
tim-10 | error | DeviceMetric.measurementPeriod.repeat | If there's a timeOfDay, there cannot be a when, or vice versa | `timeOfDay.empty() or when.empty()`

Differential View

This structure is derived from DeviceMetric

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DeviceMetric |  | 0..* | DeviceMetric | Measurement, calculation or setting capability of a medical device
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
Slices for extension |  |  |  | Content/Rules for all slices
extension:number |  | 0..1 | Extension | Instance number
valueUnsignedInt |  | 1..1 | unsignedInt | Value of extension
extension:label |  | 0..1 | Extension | Instance label
valueString |  | 1..1 | string | Value of extension
extension:relation |  | 0..* | (Complex) | Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation
extension:metricAvailability | S | 0..1 | code | Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability
type | S | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible)
coding |  | 0..* | Coding | Code defined by a terminology system
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
text |  | 0..1 | string | Plain text representation of the concept
unit |  | 0..0 |  | Unit of Measure for the Metric
source | S | 1..1 | Reference(MDS Device profile) | Describes the link to the source Device
parent | S | 1..1 | Reference(Channel Device profile) | Describes the link to the parent Device
operationalStatus | S | 0..1 | code | on | off | standby | entered-in-error
color |  | 0..1 | code | black | red | green | yellow | blue | magenta | cyan | white
category | S | 1..1 | code | measurement | setting | calculation | unspecified
measurementPeriod | S | 0..1 | Timing | Describes the measurement repetition time
repeat |  | 0..1 | Element | When the event is to occur
duration |  | 0..1 | decimal | How long when it happens
period |  | 0..1 | decimal | Event occurs frequency times per period
periodUnit |  | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM)
calibration | S | 0..* | BackboneElement | Describes the calibrations that have been performed or that are required to be performed
type |  | 0..1 | code | unspecified | offset | gain | two-point
state |  | 0..1 | code | not-calibrated | calibration-required | calibrated | unspecified
time |  | 0..1 | instant | Describes the time last calibration has been performed
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
DeviceMetric.type | Base | extensible | MDC Metric nomenclature | 📦1.0.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
extension:instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:number |  | 0..1 | Extension | Instance number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "number"
Slices for value[x] |  | 1..1 | unsignedInt | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueUnsignedInt |  | 1..1 | unsignedInt | Value of extension
extension:label |  | 0..1 | Extension | Instance label
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "label"
Slices for value[x] |  | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 1..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance"
extension:relation |  | 0..* | (Complex) | Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation
extension:metricAvailability | S | 0..1 | code | Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Instance identifier
type | S Σ | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
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
text | Σ | 0..1 | string | Plain text representation of the concept
source | S Σ | 1..1 | Reference(MDS Device profile) | Describes the link to the source Device
parent | S Σ | 1..1 | Reference(Channel Device profile) | Describes the link to the parent Device
operationalStatus | S Σ | 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 | S Σ | 1..1 | code | measurement | setting | calculation | unspecified Binding: DeviceMetricCategory (required): Describes the category of the metric.
measurementPeriod | S Σ | 0..1 | Timing | Describes the measurement repetition time
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
event | Σ | 0..* | dateTime | When the event occurs
repeat | Σ C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
bounds[x] | Σ | 0..1 |  | Length/Range of lengths, or (Start and/or end) limits
boundsDuration |  |  | Duration |
boundsRange |  |  | Range |
boundsPeriod |  |  | Period |
count | Σ | 0..1 | positiveInt | Number of times to repeat
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat
duration | Σ | 0..1 | decimal | How long when it happens
durationMax | Σ | 0..1 | decimal | How long when it happens (Max)
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period
period | Σ | 0..1 | decimal | Event occurs frequency times per period
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours)
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM).
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
timeOfDay | Σ | 0..* | time | Time of day for action
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule.
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after)
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
calibration | S Σ | 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DeviceMetric.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
DeviceMetric.type | Base | extensible | MDC Metric nomenclature | 📦1.0.0 | This IG
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.measurementPeriod.​repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std.
DeviceMetric.measurementPeriod.​code | Base | preferred | TimingAbbreviation | 📍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.

#### Constraints

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()`
tim-1 | error | DeviceMetric.measurementPeriod.repeat | if there's a duration, there needs to be duration units | `duration.empty() or durationUnit.exists()`
tim-2 | error | DeviceMetric.measurementPeriod.repeat | if there's a period, there needs to be period units | `period.empty() or periodUnit.exists()`
tim-4 | error | DeviceMetric.measurementPeriod.repeat | duration SHALL be a non-negative value | `duration.exists() implies duration >= 0`
tim-5 | error | DeviceMetric.measurementPeriod.repeat | period SHALL be a non-negative value | `period.exists() implies period >= 0`
tim-6 | error | DeviceMetric.measurementPeriod.repeat | If there's a periodMax, there must be a period | `periodMax.empty() or period.exists()`
tim-7 | error | DeviceMetric.measurementPeriod.repeat | If there's a durationMax, there must be a duration | `durationMax.empty() or duration.exists()`
tim-8 | error | DeviceMetric.measurementPeriod.repeat | If there's a countMax, there must be a count | `countMax.empty() or count.exists()`
tim-9 | error | DeviceMetric.measurementPeriod.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) | `offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))`
tim-10 | error | DeviceMetric.measurementPeriod.repeat | If there's a timeOfDay, there cannot be a when, or vice versa | `timeOfDay.empty() or when.empty()`

This structure is derived from DeviceMetric

The profile defines the following rules:

- `DeviceMetric.type` shall have a coding from the ISO/IEEE 11073 MDC Metric nomenclature if there is an appropriate code available.
- `DeviceMetric.source` shall be present and refer to the MDS Device resource.
- `DeviceMetric.parent` shall be present and refer to the Channel Device resource which this metric belongs to.
- If multiple instances of the same metric type exist, the Instance extension allows a squence to be defined.
- Extensions allow relationships and metric availability to be added.

Other representations of profile: CSV, Excel, Schematron