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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	DeviceMetric	This is a DeviceMetric resource
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.
type*	CodeableConcept		Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unit	CodeableConcept		Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
source	Reference		Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parent	Reference		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	string	on\|off\|standby\|entered-in-error	Indicates current operational state of the device. For example: On, Off, Standby, etc.
color	string	black\|red\|green\|yellow\|blue\|magenta\|cyan\|white	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	string	measurement\|setting\|calculation\|unspecified	Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriod	Timing		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	array(DeviceMetric_Calibration)		Describes the calibrations that have been performed or that are required to be performed.

Response

201 400 401 404

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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	DeviceMetric	This is a DeviceMetric resource
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.
type*	CodeableConcept		Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unit	CodeableConcept		Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
source	Reference		Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parent	Reference		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	string	on\|off\|standby\|entered-in-error	Indicates current operational state of the device. For example: On, Off, Standby, etc.
color	string	black\|red\|green\|yellow\|blue\|magenta\|cyan\|white	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	string	measurement\|setting\|calculation\|unspecified	Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriod	Timing		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	array(DeviceMetric_Calibration)		Describes the calibrations that have been performed or that are required to be performed.

Response

200 201 400 401 404 409

Read Device Metric

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Device Metric

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Device Metric

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Device Metric

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Device Metric

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
category	string
identifier	string
parent	string
source	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Device Metric

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
category	string
identifier	string
parent	string
source	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	DeviceMetric	This is a DeviceMetric resource
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.
type*	CodeableConcept		Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unit	CodeableConcept		Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
source	Reference		Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parent	Reference		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	string	on\|off\|standby\|entered-in-error	Indicates current operational state of the device. For example: On, Off, Standby, etc.
color	string	black\|red\|green\|yellow\|blue\|magenta\|cyan\|white	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	string	measurement\|setting\|calculation\|unspecified	Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriod	Timing		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	array(DeviceMetric_Calibration)		Describes the calibrations that have been performed or that are required to be performed.

Response

200 401 404

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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	DeviceMetric	This is a DeviceMetric resource
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.
type*	CodeableConcept		Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
unit	CodeableConcept		Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
source	Reference		Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
parent	Reference		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	string	on\|off\|standby\|entered-in-error	Indicates current operational state of the device. For example: On, Off, Standby, etc.
color	string	black\|red\|green\|yellow\|blue\|magenta\|cyan\|white	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	string	measurement\|setting\|calculation\|unspecified	Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
measurementPeriod	Timing		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	array(DeviceMetric_Calibration)		Describes the calibrations that have been performed or that are required to be performed.

Response

200 201 400 401 404 409