Point-of-Care Device Implementation Guide
current - CI Build

Point-of-Care Device Implementation Guide, published by HL7 International - Devices Work Group. This is not an authorized publication; it is the continuous build for version current). 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: SampleArrayDeviceMetric - Detailed Descriptions

Draft as of 2022-01-16

Definitions for the SampleArrayDeviceMetric resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. DeviceMetric
2. DeviceMetric.extension
Slicing | This element introduces a set of slices on DeviceMetric.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
3. DeviceMetric.extension:instance
SliceName | instance
Definition | Instance number or label for multiple components of the same type.
Control | 0..1
Type | Extension(DeviceInstance) (Complex Extension)
Must Support | true
4. DeviceMetric.extension:instance.extension:number
SliceName | number
Control | 0..?
5. DeviceMetric.extension:instance.extension:number.valueUnsignedInt
Control | 0..?
6. DeviceMetric.extension:instance.extension:label
SliceName | label
Control | 0..?
7. DeviceMetric.extension:instance.extension:label.valueString
Control | 0..?
8. DeviceMetric.extension:relation
SliceName | relation
Definition | Relation allows the modelling of relationships between a metric and other containment tree entries.
Control | 0..?
Type | Extension(Relation) (Complex Extension)
9. DeviceMetric.extension:metricAvailability
SliceName | metricAvailability
Definition | Availability of the means that derives the metric state.
Control | 0..1
Type | Extension(MetricAvailability) (Extension Type: code)
Must Support | true
10. DeviceMetric.extension:technicalRange
SliceName | technicalRange
Definition | The technical possible range of determined values.
Control | 0..1
Type | Extension(TechnicalRange) (Complex Extension)
Must Support | true
11. DeviceMetric.extension:resolution
SliceName | resolution
Definition | Resolution is the minimum determinable difference between two determined values.
Control | 0..1
Type | Extension(Resolution) (Extension Type: decimal)
Must Support | true
12. DeviceMetric.extension:sweep-speed
SliceName | sweep-speed
Definition | Default sweep speed for real-time waveform presentation.
Control | 0..1
Type | Extension(SweepSpeed) (Extension Type: Quantity)
13. DeviceMetric.extension:visual-grid
SliceName | visual-grid
Definition | Grid line definitions for waveform presentation.
Control | 0..?
Type | Extension(VisualGrid) (Complex Extension)
14. DeviceMetric.type
Binding | The codes SHALL be taken from MDC Metric nomenclature; other codes may be used where these codes are not suitableThe codes SHOULD be taken from DeviceMetricAndComponentTypes
Must Support | true
15. DeviceMetric.type.coding
Control | 0..?
16. DeviceMetric.type.coding.system
Control | 0..?
17. DeviceMetric.type.coding.version
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..?
18. DeviceMetric.type.coding.code
Control | 0..?
19. DeviceMetric.type.text
Control | 0..?
20. DeviceMetric.unit
Binding | The codes SHALL be taken from MDC Unit of Measurement; other codes may be used where these codes are not suitableThe codes SHOULD be taken from DeviceMetricAndComponentTypes
Must Support | true
21. DeviceMetric.unit.coding
Control | 0..?
22. DeviceMetric.unit.coding.system
Control | 0..?
23. DeviceMetric.unit.coding.version
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..?
24. DeviceMetric.unit.coding.code
Control | 0..?
25. DeviceMetric.unit.text
Control | 0..?
26. DeviceMetric.source
Control | 10..1
Type | Reference(MdsDevice|Device)
Must Support | true
27. DeviceMetric.parent
Control | 10..1
Type | Reference(ChannelDevice|Device)
Must Support | true
28. DeviceMetric.operationalStatus
Must Support | true
29. DeviceMetric.color
30. DeviceMetric.category
Must Support | true
31. DeviceMetric.measurementPeriod
Must Support | true
32. DeviceMetric.measurementPeriod.repeat
Control | 0..?
33. DeviceMetric.measurementPeriod.repeat.duration
Control | 0..?
34. DeviceMetric.measurementPeriod.repeat.period
Control | 0..?
35. DeviceMetric.calibration
Must Support | true
36. DeviceMetric.calibration.type
37. DeviceMetric.calibration.state
38. DeviceMetric.calibration.time

Guidance on how to interpret the contents of this table can be found here.

1. DeviceMetric
Definition | Describes a measurement, calculation or setting capability of a medical device.
Control | 0..*
Summary | false
Comments | For the initial scope, this DeviceMetric resource is only applicable to describe a single metric node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard.
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. DeviceMetric.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. DeviceMetric.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. DeviceMetric.extension:instance
SliceName | instance
Definition | Instance number or label for multiple components of the same type. May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Extension(DeviceInstance) (Complex Extension)
Must Support | true
Invariants | Defined on this element ele-1: (: ) ext-1: (: )
5. DeviceMetric.extension:instance.extension:number
SliceName | number
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..1*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. DeviceMetric.extension:instance.extension:number.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Control | 1..1
Type | uri
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value | number
7. DeviceMetric.extension:instance.extension:number.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 10..1
Type | Choice of: unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
8. DeviceMetric.extension:instance.extension:number.value[x]:valueUnsignedInt
SliceName | valueUnsignedInt
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 10..1
Type | Choice of: unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. DeviceMetric.extension:instance.extension:label
SliceName | label
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..1*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DeviceMetric.extension:instance.extension:label.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Control | 1..1
Type | uri
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value | label
11. DeviceMetric.extension:instance.extension:label.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 10..1
Type | Choice of: string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
12. DeviceMetric.extension:instance.extension:label.value[x]:valueString
SliceName | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 10..1
Type | Choice of: string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. DeviceMetric.extension:instance.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Control | 1..1
Type | uri
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value | http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
14. DeviceMetric.extension:instance.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 0..01
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. DeviceMetric.extension:relation
SliceName | relation
Definition | Relation allows the modelling of relationships between a metric and other containment tree entries. May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | This element is affected by the following invariants: ele-1
Type | Extension(Relation) (Complex Extension)
Invariants | Defined on this element ele-1: (: ) ext-1: (: )
16. DeviceMetric.extension:metricAvailability
SliceName | metricAvailability
Definition | Availability of the means that derives the metric state.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MetricAvailability) (Extension Type: code)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. DeviceMetric.extension:technicalRange
SliceName | technicalRange
Definition | The technical possible range of determined values. May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Extension(TechnicalRange) (Complex Extension)
Must Support | true
Invariants | Defined on this element ele-1: (: ) ext-1: (: )
18. DeviceMetric.extension:resolution
SliceName | resolution
Definition | Resolution is the minimum determinable difference between two determined values.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Resolution) (Extension Type: decimal)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. DeviceMetric.extension:sweep-speed
SliceName | sweep-speed
Definition | Default sweep speed for real-time waveform presentation.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(SweepSpeed) (Extension Type: Quantity)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. DeviceMetric.extension:visual-grid
SliceName | visual-grid
Definition | Grid line definitions for waveform presentation. May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | This element is affected by the following invariants: ele-1
Type | Extension(VisualGrid) (Complex Extension)
Invariants | Defined on this element ele-1: (: ) ext-1: (: )
21. DeviceMetric.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
22. DeviceMetric.type
Definition | Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
Control | 1..1
Binding | The codes SHALL be taken from MDC Metric nomenclature; other codes may be used where these codes are not suitableThe codes SHOULD be taken from DeviceMetricAndComponentTypes
Type | CodeableConcept
Must Support | true
Summary | true
Comments | DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. DeviceMetric.type.coding
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. DeviceMetric.type.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. DeviceMetric.type.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. DeviceMetric.type.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. DeviceMetric.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments | Very often the text is the same as a displayName of one of the codings.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. DeviceMetric.unit
Definition | Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
Control | 0..1
Binding | The codes SHALL be taken from MDC Unit of Measurement; other codes may be used where these codes are not suitableThe codes SHOULD be taken from DeviceMetricAndComponentTypes
Type | CodeableConcept
Must Support | true
Summary | true
Comments | DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. DeviceMetric.unit.coding
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. DeviceMetric.unit.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. DeviceMetric.unit.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. DeviceMetric.unit.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. DeviceMetric.unit.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments | Very often the text is the same as a displayName of one of the codings.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. DeviceMetric.source
Definition | Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
Control | 10..1
Type | Reference(MdsDevice|Device)
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. DeviceMetric.parent
Definition | Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
Control | 10..1
Type | Reference(ChannelDevice|Device)
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. DeviceMetric.operationalStatus
Definition | Indicates current operational state of the device. For example: On, Off, Standby, etc.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricOperationalStatus Describes the operational status of the DeviceMetric.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. DeviceMetric.color
Definition | Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricColor Describes the typical color of representation.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. DeviceMetric.category
Definition | Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
Control | 1..1
Binding | The codes SHALL be taken from DeviceMetricCategory Describes the category of the metric.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. DeviceMetric.measurementPeriod
Definition | Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
Control | 0..1
Type | Timing
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. DeviceMetric.measurementPeriod.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
41. DeviceMetric.measurementPeriod.repeat
Definition | A set of rules that describe when the event is scheduled.
Control | 0..1
Type | Element
Summary | true
Requirements | Many timing schedules are determined by regular repetitions.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) tim-1: if there's a duration, there needs to be duration units (: duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (: period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (: duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (: period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (: periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (: durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (: countMax.empty() or count.exists()) tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (: timeOfDay.empty() or when.empty())
42. DeviceMetric.measurementPeriod.repeat.duration
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. DeviceMetric.measurementPeriod.repeat.period
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. DeviceMetric.calibration
Definition | Describes the calibrations that have been performed or that are required to be performed.
Control | 0..*
Type | BackboneElement
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. DeviceMetric.calibration.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
46. DeviceMetric.calibration.type
Definition | Describes the type of the calibration method.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricCalibrationType Describes the type of a metric calibration.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. DeviceMetric.calibration.state
Definition | Describes the state of the calibration.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricCalibrationState Describes the state of a metric calibration.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. DeviceMetric.calibration.time
Definition | Describes the time last calibration has been performed.
Control | 0..1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. DeviceMetric
Definition | Describes a measurement, calculation or setting capability of a medical device.
Control | 0..*
Summary | false
Comments | For the initial scope, this DeviceMetric resource is only applicable to describe a single metric node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard.
2. DeviceMetric.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. DeviceMetric.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. DeviceMetric.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. DeviceMetric.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. DeviceMetric.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Summary | false
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. DeviceMetric.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. DeviceMetric.extension
Definition | An Extension
Control | 0..*
Type | Extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. DeviceMetric.extension:instance
SliceName | instance
Definition | Instance number or label for multiple components of the same type.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(DeviceInstance) (Complex Extension)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DeviceMetric.extension:instance.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
11. DeviceMetric.extension:instance.extension
Definition | An Extension
Control | 0..*
Type | Extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
12. DeviceMetric.extension:instance.extension:number
SliceName | number
Definition | An Extension
Control | 0..1
Type | Extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. DeviceMetric.extension:instance.extension:number.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
14. DeviceMetric.extension:instance.extension:number.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
15. DeviceMetric.extension:instance.extension:number.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Control | 1..1
Type | uri
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value | number
16. DeviceMetric.extension:instance.extension:number.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 1..1
Type | unsignedInt
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
17. DeviceMetric.extension:instance.extension:number.value[x]:valueUnsignedInt
SliceName | valueUnsignedInt
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 1..1
Type | unsignedInt
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. DeviceMetric.extension:instance.extension:label
SliceName | label
Definition | An Extension
Control | 0..1
Type | Extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. DeviceMetric.extension:instance.extension:label.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
20. DeviceMetric.extension:instance.extension:label.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
21. DeviceMetric.extension:instance.extension:label.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Control | 1..1
Type | uri
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value | label
22. DeviceMetric.extension:instance.extension:label.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 1..1
Type | string
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on DeviceMetric.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
23. DeviceMetric.extension:instance.extension:label.value[x]:valueString
SliceName | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 1..1
Type | string
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. DeviceMetric.extension:instance.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Control | 1..1
Type | uri
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value | http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance
25. DeviceMetric.extension:instance.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control | 0..0
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note | See Choice of Data Types for further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. DeviceMetric.extension:relation
SliceName | relation
Definition | Relation allows the modelling of relationships between a metric and other containment tree entries.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Relation) (Complex Extension)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
27. DeviceMetric.extension:metricAvailability
SliceName | metricAvailability
Definition | Availability of the means that derives the metric state.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(MetricAvailability) (Extension Type: code)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
28. DeviceMetric.extension:technicalRange
SliceName | technicalRange
Definition | The technical possible range of determined values.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(TechnicalRange) (Complex Extension)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
29. DeviceMetric.extension:resolution
SliceName | resolution
Definition | Resolution is the minimum determinable difference between two determined values.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Resolution) (Extension Type: decimal)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
30. DeviceMetric.extension:sweep-speed
SliceName | sweep-speed
Definition | Default sweep speed for real-time waveform presentation.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(SweepSpeed) (Extension Type: Quantity)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
31. DeviceMetric.extension:visual-grid
SliceName | visual-grid
Definition | Grid line definitions for waveform presentation.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(VisualGrid) (Complex Extension)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
32. DeviceMetric.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. DeviceMetric.identifier
Definition | Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Summary | true
Comments | For identifiers assigned to a device by the device or gateway software, the `system` element of the identifier should be set to the unique identifier of the device.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. DeviceMetric.type
Definition | Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
Control | 1..1
Binding | The codes SHALL be taken from MDC Metric nomenclature; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Summary | true
Comments | DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. DeviceMetric.type.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
36. DeviceMetric.type.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
37. DeviceMetric.type.coding
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. DeviceMetric.type.coding.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
39. DeviceMetric.type.coding.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
40. DeviceMetric.type.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. DeviceMetric.type.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. DeviceMetric.type.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. DeviceMetric.type.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. DeviceMetric.type.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. DeviceMetric.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments | Very often the text is the same as a displayName of one of the codings.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. DeviceMetric.unit
Definition | Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
Control | 0..1
Binding | The codes SHALL be taken from MDC Unit of Measurement; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Summary | true
Comments | DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. DeviceMetric.unit.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
48. DeviceMetric.unit.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.unit.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
49. DeviceMetric.unit.coding
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. DeviceMetric.unit.coding.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
51. DeviceMetric.unit.coding.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.unit.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
52. DeviceMetric.unit.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. DeviceMetric.unit.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. DeviceMetric.unit.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. DeviceMetric.unit.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. DeviceMetric.unit.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. DeviceMetric.unit.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments | Very often the text is the same as a displayName of one of the codings.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. DeviceMetric.source
Definition | Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
Control | 1..1
Type | Reference(MdsDevice)
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. DeviceMetric.parent
Definition | Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
Control | 1..1
Type | Reference(ChannelDevice)
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. DeviceMetric.operationalStatus
Definition | Indicates current operational state of the device. For example: On, Off, Standby, etc.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricOperationalStatus Describes the operational status of the DeviceMetric
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. DeviceMetric.color
Definition | Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricColor Describes the typical color of representation
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. DeviceMetric.category
Definition | Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
Control | 1..1
Binding | The codes SHALL be taken from DeviceMetricCategory Describes the category of the metric
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. DeviceMetric.measurementPeriod
Definition | Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
Control | 0..1
Type | Timing
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. DeviceMetric.measurementPeriod.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
65. DeviceMetric.measurementPeriod.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.measurementPeriod.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
66. DeviceMetric.measurementPeriod.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
67. DeviceMetric.measurementPeriod.event
Definition | Identifies specific times when the event occurs.
Control | 0..*
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. DeviceMetric.measurementPeriod.repeat
Definition | A set of rules that describe when the event is scheduled.
Control | 0..1
Type | Element
Summary | true
Requirements | Many timing schedules are determined by regular repetitions.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) tim-1: if there's a duration, there needs to be duration units (: duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (: period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (: duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (: period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (: periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (: durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (: countMax.empty() or count.exists()) tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (: timeOfDay.empty() or when.empty())
69. DeviceMetric.measurementPeriod.repeat.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
70. DeviceMetric.measurementPeriod.repeat.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on DeviceMetric.measurementPeriod.repeat.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
71. DeviceMetric.measurementPeriod.repeat.bounds[x]
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Control | 0..1
Type | Choice of: Duration, Range, Period
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. DeviceMetric.measurementPeriod.repeat.count
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Repetitions may be limited by end time or total occurrences.
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. DeviceMetric.measurementPeriod.repeat.countMax
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. DeviceMetric.measurementPeriod.repeat.duration
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. DeviceMetric.measurementPeriod.repeat.durationMax
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. DeviceMetric.measurementPeriod.repeat.durationUnit
Definition | The units of time for the duration, in UCUM units.
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime A unit of time (units from UCUM)
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. DeviceMetric.measurementPeriod.repeat.frequency
Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. DeviceMetric.measurementPeriod.repeat.frequencyMax
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. DeviceMetric.measurementPeriod.repeat.period
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. DeviceMetric.measurementPeriod.repeat.periodMax
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
Control | 0..1
Type | decimal
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
81. DeviceMetric.measurementPeriod.repeat.periodUnit
Definition | The units of time for the period in UCUM units.
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime A unit of time (units from UCUM)
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
82. DeviceMetric.measurementPeriod.repeat.dayOfWeek
Definition | If one or more days of week is provided, then the action happens only on the specified day(s).
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
83. DeviceMetric.measurementPeriod.repeat.timeOfDay
Definition | Specified time of day for action to take place.
Control | 0..*
Type | time
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. DeviceMetric.measurementPeriod.repeat.when
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Control | 0..*
Binding | The codes SHALL be taken from EventTiming Real world event relating to the schedule
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep.
Comments | When more than one event is listed, the event is tied to the union of the specified events.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. DeviceMetric.measurementPeriod.repeat.offset
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
Control | 0..1
Type | unsignedInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. DeviceMetric.measurementPeriod.code
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
Control | 0..1
Binding | The codes SHOULD be taken from TimingAbbreviation Code for a known / defined timing pattern
Type | CodeableConcept
Summary | true
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. DeviceMetric.calibration
Definition | Describes the calibrations that have been performed or that are required to be performed.
Control | 0..*
Type | BackboneElement
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. DeviceMetric.calibration.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
89. DeviceMetric.calibration.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
90. DeviceMetric.calibration.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
91. DeviceMetric.calibration.type
Definition | Describes the type of the calibration method.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricCalibrationType Describes the type of a metric calibration
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. DeviceMetric.calibration.state
Definition | Describes the state of the calibration.
Control | 0..1
Binding | The codes SHALL be taken from DeviceMetricCalibrationState Describes the state of a metric calibration
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. DeviceMetric.calibration.time
Definition | Describes the time last calibration has been performed.
Control | 0..1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))