DeviceMetric Profiles
Scope and Usage
These DeviceMetric profiles are part of the Point-of-Care Device General Implementation Guide. A set of DeviceMetric resources represent measurements, calculations, status, and settings of a medical device.
A compliant device shall have DeviceMetric resources according to the Numeric, Enumeration, and Sample Array DeviceMetric profiles. The profiles define the following rules:
DeviceMetric.type
shall have a coding from the ISO/IEEE 11073 MDC metrics nomenclature. The Rosetta Terminology Mapping Management System (RTMMS) lists available codes.DeviceMetric.type.coding
allows additional coding from other code systems.DeviceMetric.unit
is optional for Numeric and Sample Array DeviceMetric resources. If present, it shall have a coding from the ISO/IEEE 11073 MDC units of measurement.DeviceMetric.unit.coding
allows additional coding from other code systems.DeviceMetric.source
shall be present and refer to a Device resource according to the PoC Device profile.DeviceMetric.parent
shall be present and refer to the Channel DeviceComponent resource where this metric belongs to.
Content
StructureDefinition | Description | Example |
---|---|---|
Numeric DeviceMetric Profile | Characteristics and operational status of a numerical measurement, calculation, or setting | NBP Numeric DeviceMetric |
Enumeration DeviceMetric Profile | Characteristics and operational status of status or annotation information as codes or text | Rhythm Status Enumeration DeviceMetric |
Sample Array DeviceMetric Profile (to be completed) | Characteristics and operational status of a real-time waveform or wave snippet |
Numeric DeviceMetric Profile
Canonical URL
http://devices.fhir.org/StructureDefinition/NumericDeviceMetric
Profile Definition
DeviceMetric | I | DeviceMetric | There are no (further) constraints on this element Element idDeviceMetric Measurement, calculation or setting capability of a medical device DefinitionDescribes a measurement, calculation or setting capability of a medical device. 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. DeviceMetric Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idDeviceMetric.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id Constraints
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDeviceMetric.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta Constraints
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDeviceMetric.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri Constraints
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.language Language of the resource content DefinitionThe base language in which the resource is written. 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). code BindingA human language. ?? (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idDeviceMetric.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later. Narrative Constraints
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idDeviceMetric.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idDeviceMetric.identifier Unique identifier of this DeviceMetric DefinitionDescribes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device. Identifier Constraints
|
type | Σ | 1..1 | CodeableConceptBinding | Element idDeviceMetric.type Numeric type DefinitionDeviceMetric.type shall have a coding from the ISO/IEEE 11073 MDC metrics nomenclature. The Rosetta Terminology Mapping Management System (RTMMS) lists available codes. DeviceMetric.type.coding allows additional coding from other code systems. DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. CodeableConcept BindingDescribes the metric type. ?? (preferred)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idDeviceMetric.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Unordered, Open, by system(Value) Constraints
|
11073MDC | Σ | 1..1 | Coding | Element idDeviceMetric.type.coding:11073MDC 11073 MDC code DefinitionCode defined by the ISO/IEEE 11073-10101 Nomenclature Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | Element idDeviceMetric.type.coding:11073MDC.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.version Version of the system - if relevant DefinitionThe 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. 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. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). 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. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. string Constraints
|
unit | Σ | 0..1 | CodeableConceptBinding | Element idDeviceMetric.unit Unit of measure DefinitionDeviceMetric.unit is optional. If present, it shall have a coding from the ISO/IEEE 11073 MDC units of measurement. DeviceMetric.unit.coding allows additional coding from other code systems. DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system. CodeableConcept BindingDescribes the unit of the metric. ?? (preferred)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.unit.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.unit.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idDeviceMetric.unit.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Unordered, Open, by system(Value) Constraints
|
11073MDC | Σ | 1..1 | Coding | Element idDeviceMetric.unit.coding:11073MDC 11073 MDC code DefinitionCode defined by the ISO/IEEE 11073-10101 Nomenclature Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.unit.coding:11073MDC.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.unit.coding:11073MDC.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | Element idDeviceMetric.unit.coding:11073MDC.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.unit.coding:11073MDC.version Version of the system - if relevant DefinitionThe 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. 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. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idDeviceMetric.unit.coding:11073MDC.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.unit.coding:11073MDC.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDeviceMetric.unit.coding:11073MDC.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). 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. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.unit.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. string Constraints
|
source | Σ I | 1..1 | Reference(PoC Device Profile) | Element idDeviceMetric.source Describes the link to the source Device DefinitionDeviceMetric.source shall be present and refer to a Device resource according to the PoC Device profile. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(PoC Device Profile) Constraints
|
parent | Σ I | 1..1 | Reference(Channel DeviceComponent Profile) | Element idDeviceMetric.parent Describes the link to the parent DeviceComponent DefinitionDeviceMetric.parent shall be present and refer to the Channel DeviceComponent resource where this metric belongs to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Channel DeviceComponent Profile) Constraints
|
operationalStatus | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.operationalStatus on | off | standby | entered-in-error DefinitionIndicates current operational state of the device. For example: On, Off, Standby, etc. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the operational status of the DeviceMetric. ?? (required)Constraints
|
color | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.color black | red | green | yellow | blue | magenta | cyan | white DefinitionDescribes 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. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the typical color of representation. ?? (required)Constraints
|
category | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.category measurement | setting | calculation | unspecified DefinitionIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the category of the metric. ?? (required)Constraints
|
measurementPeriod | Σ | 0..1 | Timing | There are no (further) constraints on this element Element idDeviceMetric.measurementPeriod Describes the measurement repetition time DefinitionDescribes 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. A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure. Timing Constraints
|
calibration | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idDeviceMetric.calibration Describes the calibrations that have been performed or that are required to be performed DefinitionDescribes the calibrations that have been performed or that are required to be performed. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.calibration.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.calibration.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.calibration.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Constraints
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.calibration.type unspecified | offset | gain | two-point DefinitionDescribes the type of the calibration method. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the type of a metric calibration. ?? (required)Constraints
|
state | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.calibration.state not-calibrated | calibration-required | calibrated | unspecified DefinitionDescribes the state of the calibration. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the state of a metric calibration. ?? (required)Constraints
|
time | Σ | 0..1 | instant | There are no (further) constraints on this element Element idDeviceMetric.calibration.time Describes the time last calibration has been performed DefinitionDescribes the time last calibration has been performed. Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required instant Constraints
|
Example (XML view)
Example of a NBP Numeric DeviceMetric
<DeviceMetric xmlns="http://hl7.org/fhir"> <id value="216" /> <meta> <profile value="http://devices.fhir.org/StructureDefinition/NumericDeviceMetric" /> </meta> <identifier> <use value="temp" /> <system value="urn:ietf:rfc:3986" /> <value value="urn:uuid:77616af6-9071-408a-8e4f-0f69dab756d4" /> </identifier> <type> <coding> <system value="urn:iso:std:iso:11073:10101" /> <code value="150020" /> <display value="MDC_PRESS_BLD_NONINV" /> </coding> <text value="NBP" /> </type> <unit> <coding> <system value="urn:iso:std:iso:11073:10101" /> <code value="266016" /> <display value="MDC_DIM_MMHG" /> </coding> <text value="mmHg" /> </unit> <source> <reference value="Device/72" /> </source> <parent> <reference value="DeviceComponent/432" /> </parent> <operationalStatus value="on" /> <color value="red" /> <category value="measurement" /> <measurementPeriod> <repeat> <frequency value="1" /> <period value="15" /> <periodUnit value="min" /> </repeat> </measurementPeriod> </DeviceMetric>
Example (JSON view)
Example of a NBP Numeric DeviceMetric
{ "resourceType": "DeviceMetric", "id": "216", "meta": { "profile": [ "http://devices.fhir.org/StructureDefinition/NumericDeviceMetric" ] }, "identifier": { "use": "temp", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:77616af6-9071-408a-8e4f-0f69dab756d4" }, "type": { "coding": [ { "system": "urn:iso:std:iso:11073:10101", "code": "150020", "display": "MDC_PRESS_BLD_NONINV" } ], "text": "NBP" }, "unit": { "coding": [ { "system": "urn:iso:std:iso:11073:10101", "code": "266016", "display": "MDC_DIM_MMHG" } ], "text": "mmHg" }, "source": { "reference": "Device/72" }, "parent": { "reference": "DeviceComponent/432" }, "operationalStatus": "on", "color": "red", "category": "measurement", "measurementPeriod": { "repeat": { "frequency": 1, "period": 15, "periodUnit": "min" } } }
Enumeration DeviceMetric Profile
Canonical URL
http://devices.fhir.org/StructureDefinition/EnumerationDeviceMetric
Profile Definition
DeviceMetric | I | DeviceMetric | There are no (further) constraints on this element Element idDeviceMetric Measurement, calculation or setting capability of a medical device DefinitionDescribes a measurement, calculation or setting capability of a medical device. 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. DeviceMetric Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idDeviceMetric.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id Constraints
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDeviceMetric.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta Constraints
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDeviceMetric.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri Constraints
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.language Language of the resource content DefinitionThe base language in which the resource is written. 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). code BindingA human language. ?? (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idDeviceMetric.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later. Narrative Constraints
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idDeviceMetric.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idDeviceMetric.identifier Unique identifier of this DeviceMetric DefinitionDescribes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device. Identifier Constraints
|
type | Σ | 1..1 | CodeableConceptBinding | Element idDeviceMetric.type Enumeration type DefinitionDeviceMetric.type shall have a coding from the ISO/IEEE 11073 MDC metrics nomenclature. The Rosetta Terminology Mapping Management System (RTMMS) lists available codes. DeviceMetric.type.coding allows additional coding from other code systems. DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. CodeableConcept BindingDescribes the metric type. ?? (preferred)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idDeviceMetric.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Sliced:Unordered, Open, by system(Value) Constraints
|
11073MDC | Σ | 1..1 | Coding | Element idDeviceMetric.type.coding:11073MDC 11073 MDC code DefinitionCode defined by the ISO/IEEE 11073-10101 Nomenclature Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | Element idDeviceMetric.type.coding:11073MDC.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
urn:iso:std:iso:11073:10101
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.version Version of the system - if relevant DefinitionThe 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. 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. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDeviceMetric.type.coding:11073MDC.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). 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. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.type.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. string Constraints
|
unit | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idDeviceMetric.unit Unit of Measure for the Metric DefinitionDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system. CodeableConcept BindingDescribes the unit of the metric. ?? (preferred)Constraints
|
source | Σ I | 1..1 | Reference(PoC Device Profile) | Element idDeviceMetric.source Describes the link to the source Device DefinitionDeviceMetric.source shall be present and refer to a Device resource according to the PoC Device profile. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(PoC Device Profile) Constraints
|
parent | Σ I | 1..1 | Reference(Channel DeviceComponent Profile) | Element idDeviceMetric.parent Describes the link to the parent DeviceComponent DefinitionDeviceMetric.parent shall be present and refer to the Channel DeviceComponent resource where this metric belongs to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Channel DeviceComponent Profile) Constraints
|
operationalStatus | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.operationalStatus on | off | standby | entered-in-error DefinitionIndicates current operational state of the device. For example: On, Off, Standby, etc. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the operational status of the DeviceMetric. ?? (required)Constraints
|
color | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.color black | red | green | yellow | blue | magenta | cyan | white DefinitionDescribes 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. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the typical color of representation. ?? (required)Constraints
|
category | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.category measurement | setting | calculation | unspecified DefinitionIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the category of the metric. ?? (required)Constraints
|
measurementPeriod | Σ | 0..1 | Timing | There are no (further) constraints on this element Element idDeviceMetric.measurementPeriod Describes the measurement repetition time DefinitionDescribes 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. A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure. Timing Constraints
|
calibration | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idDeviceMetric.calibration Describes the calibrations that have been performed or that are required to be performed DefinitionDescribes the calibrations that have been performed or that are required to be performed. BackboneElement Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.calibration.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.calibration.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.calibration.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Constraints
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.calibration.type unspecified | offset | gain | two-point DefinitionDescribes the type of the calibration method. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the type of a metric calibration. ?? (required)Constraints
|
state | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.calibration.state not-calibrated | calibration-required | calibrated | unspecified DefinitionDescribes the state of the calibration. Note that FHIR strings may not exceed 1MB in size code BindingDescribes the state of a metric calibration. ?? (required)Constraints
|
time | Σ | 0..1 | instant | There are no (further) constraints on this element Element idDeviceMetric.calibration.time Describes the time last calibration has been performed DefinitionDescribes the time last calibration has been performed. Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required instant Constraints
|
Example (XML view)
Example of a Rhythm Status Enumeration DeviceMetric
<DeviceMetric xmlns="http://hl7.org/fhir"> <id value="221" /> <meta> <profile value="http://devices.fhir.org/StructureDefinition/EnumerationDeviceMetric" /> </meta> <identifier> <use value="temp" /> <system value="urn:ietf:rfc:3986" /> <value value="urn:uuid:a7606788-a5ad-4ed8-a8a2-ead3d49442b7" /> </identifier> <type> <coding> <system value="urn:iso:std:iso:11073:10101" /> <code value="184327" /> <display value="MDC_ECG_STAT_RHY" /> </coding> <text value="Rhythm Status" /> </type> <source> <reference value="Device/72" /> </source> <parent> <reference value="DeviceComponent/429" /> </parent> <operationalStatus value="on" /> <category value="measurement" /> </DeviceMetric>
Example (JSON view)
Example of a Rhythm Status Enumeration DeviceMetric
{ "resourceType": "DeviceMetric", "id": "221", "meta": { "profile": [ "http://devices.fhir.org/StructureDefinition/EnumerationDeviceMetric" ] }, "identifier": { "use": "temp", "system": "urn:ietf:rfc:3986", "value": "urn:uuid:a7606788-a5ad-4ed8-a8a2-ead3d49442b7" }, "type": { "coding": [ { "system": "urn:iso:std:iso:11073:10101", "code": "184327", "display": "MDC_ECG_STAT_RHY" } ], "text": "Rhythm Status" }, "source": { "reference": "Device/72" }, "parent": { "reference": "DeviceComponent/429" }, "operationalStatus": "on", "category": "measurement" }
Sample Array DeviceMetric Profile
(to be completed)