CommonProduct
Class DeviceMetric

"Describes a measurement, calculation or setting capability of a medical device." - HL7 FHIR, DeviceMetric

Attributes
«CS» Code category category

"Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation." - HL7 FHIR, DeviceMetric.category

«CS» Code color color

"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." - HL7 FHIR, DeviceMetric.color

DeviceCalibration deviceCalibration deviceCalibration

"Describes the calibrations that have been performed or that are required to be performed." - HL7 FHIR, DeviceMetric.calibration

«II» Id identifier identifier

"Describes 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." - HL7 FHIR, DeviceMetric.id

«CS» Code kind kind

"Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc." - HL7 FHIR, DeviceMetric.type

Timing measurementPeriod measurementPeriod

"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." - HL7 FHIR, DeviceMetric.measurementPeriod

«CS» Code operationalStatus operationalStatus

"Indicates current operational state of the device. For example: On, Off, Standby, etc." - HL7 FHIR, DeviceMetric.operationalStatus

DeviceComponent parent parent

"Describes the link to the DeviceComponent 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 DeviceComponent 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." - HL7 FHIR, DeviceMetric.parent

DeviceInstance source source

"Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc." - HL7 FHIR, DeviceMetric.source

«CS» Code unit unit

"Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc." - HL7 FHIR, DeviceMetric.unit


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameDeviceMetric
Name Expression
NamespaceCommonProduct
Owned Template Signature
OwnerCommonProduct
Owning Template Parameter
PackageCommonProduct
Qualified NameFHIM::CommonProduct::DeviceMetric
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 category
Public «CS» Code category

"Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation." - HL7 FHIR, DeviceMetric.category

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namecategory
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::category
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 color
Public «CS» Code color

"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." - HL7 FHIR, DeviceMetric.color

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecolor
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::color
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 deviceCalibration
Public DeviceCalibration deviceCalibration

"Describes the calibrations that have been performed or that are required to be performed." - HL7 FHIR, DeviceMetric.calibration

Constraints:
Properties:

AggregationComposite
Alias
AssociationdeviceMetric_deviceCalibration
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositetrue
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedeviceCalibration
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::deviceCalibration
Stereotype
Template Parameter
TypeDeviceCalibration
Upper*
Upper Value(*)
VisibilityPublic


 identifier
Public «II» Id identifier

"Describes 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." - HL7 FHIR, DeviceMetric.id

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameidentifier
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 kind
Public «CS» Code kind

"Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc." - HL7 FHIR, DeviceMetric.type

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namekind
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::kind
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 measurementPeriod
Public Timing measurementPeriod

"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." - HL7 FHIR, DeviceMetric.measurementPeriod

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamemeasurementPeriod
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::measurementPeriod
Stereotype
Template Parameter
TypeTiming
Upper1
Upper Value(1)
VisibilityPublic


 operationalStatus
Public «CS» Code operationalStatus

"Indicates current operational state of the device. For example: On, Off, Standby, etc." - HL7 FHIR, DeviceMetric.operationalStatus

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameoperationalStatus
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::operationalStatus
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 parent
Public DeviceComponent parent

"Describes the link to the DeviceComponent 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 DeviceComponent 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." - HL7 FHIR, DeviceMetric.parent

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceMetric_parent
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameparent
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::parent
Stereotype
Template Parameter
TypeDeviceComponent
Upper1
Upper Value(1)
VisibilityPublic


 source
Public DeviceInstance source

"Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc." - HL7 FHIR, DeviceMetric.source

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceMetric_source
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namesource
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::source
Stereotype
Template Parameter
TypeDeviceInstance
Upper1
Upper Value(1)
VisibilityPublic


 unit
Public «CS» Code unit

"Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc." - HL7 FHIR, DeviceMetric.unit

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceMetric
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameunit
Name Expression
NamespaceDeviceMetric
Opposite
OwnerDeviceMetric
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceMetric::unit
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic