device metrics

Create Device Metric

post
/organizations/{organizationId}/fhir/3/DeviceMetric

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceMetricThis is a DeviceMetric resource
identifier*IdentifierDescribes 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*CodeableConceptDescribes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unitCodeableConceptDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
sourceReferenceDescribes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parentReferenceDescribes 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.
operationalStatusstringon|off|standby|entered-in-errorIndicates current operational state of the device. For example: On, Off, Standby, etc.
colorstringblack|red|green|yellow|blue|magenta|cyan|whiteDescribes 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.
categorystringmeasurement|setting|calculation|unspecifiedIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriodTimingDescribes 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.
calibrationarray(DeviceMetric_Calibration)Describes the calibrations that have been performed or that are required to be performed.

Response

Patch Device Metric

patch
/organizations/{organizationId}/fhir/3/DeviceMetric/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceMetricThis is a DeviceMetric resource
identifier*IdentifierDescribes 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*CodeableConceptDescribes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unitCodeableConceptDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
sourceReferenceDescribes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parentReferenceDescribes 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.
operationalStatusstringon|off|standby|entered-in-errorIndicates current operational state of the device. For example: On, Off, Standby, etc.
colorstringblack|red|green|yellow|blue|magenta|cyan|whiteDescribes 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.
categorystringmeasurement|setting|calculation|unspecifiedIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriodTimingDescribes 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.
calibrationarray(DeviceMetric_Calibration)Describes the calibrations that have been performed or that are required to be performed.

Response

Read Device Metric

get
/organizations/{organizationId}/fhir/3/DeviceMetric/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Device Metric

get
/organizations/{organizationId}/fhir/3/DeviceMetric/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Device Metric

get
/organizations/{organizationId}/fhir/3/DeviceMetric/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Device Metric

delete
/organizations/{organizationId}/fhir/3/DeviceMetric/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Device Metric

get
/organizations/{organizationId}/fhir/3/DeviceMetric

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
identifierstring
parentstring
sourcestring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Device Metric

get
/organizations/{organizationId}/fhir/3/DeviceMetric/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Device Metric

post
/organizations/{organizationId}/fhir/3/DeviceMetric/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
identifierstring
parentstring
sourcestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceMetricThis is a DeviceMetric resource
identifier*IdentifierDescribes 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*CodeableConceptDescribes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unitCodeableConceptDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
sourceReferenceDescribes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parentReferenceDescribes 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.
operationalStatusstringon|off|standby|entered-in-errorIndicates current operational state of the device. For example: On, Off, Standby, etc.
colorstringblack|red|green|yellow|blue|magenta|cyan|whiteDescribes 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.
categorystringmeasurement|setting|calculation|unspecifiedIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriodTimingDescribes 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.
calibrationarray(DeviceMetric_Calibration)Describes the calibrations that have been performed or that are required to be performed.

Response

Update Device Metric

put
/organizations/{organizationId}/fhir/3/DeviceMetric/{resourceId}

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceMetricThis is a DeviceMetric resource
identifier*IdentifierDescribes 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*CodeableConceptDescribes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unitCodeableConceptDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
sourceReferenceDescribes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parentReferenceDescribes 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.
operationalStatusstringon|off|standby|entered-in-errorIndicates current operational state of the device. For example: On, Off, Standby, etc.
colorstringblack|red|green|yellow|blue|magenta|cyan|whiteDescribes 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.
categorystringmeasurement|setting|calculation|unspecifiedIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriodTimingDescribes 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.
calibrationarray(DeviceMetric_Calibration)Describes the calibrations that have been performed or that are required to be performed.

Response