cardea.fhir.DeviceMetric

class cardea.fhir.DeviceMetric(dict_values=None)

Describes a measurement, calculation or setting capability of a medical device.

Parameters
  • resourceType – This is a DeviceMetric resource

  • 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.

  • type – Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

  • unit – Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

  • source – Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.

  • 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.

  • operationalStatus – Indicates current operational state of the device. For example: On, Off, Standby, etc.

  • 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.

  • category – Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

  • 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.

  • calibration – Describes the calibrations that have been performed or that are required to be performed.

__init__(dict_values=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([dict_values])

Initialize self.

assert_type()

Checks class values follow set possible enumerations.

get_dataframe()

Returns dataframe from class attribute values.

get_eligible_relationships()

Returns class relationships for attributes that are used.

get_id()

Returns fhir class identifier.

get_relationships()

Returns class relationships.

set_attributes(dict_values)

Sets values to class attributes.