Record Heart Rate Variability Reading

POST

Records a heart rate variability reading based on the provided request. Either a device ID, device identifier, or patient ID is required.


For more information see the HeartRateVariabilityReadingRequest Model.

Request

This endpoint expects an object.
readingTimestampstringRequired

The UTC timestamp at which the reading was taken.

heartRateVariabilitydoubleRequired

The heart rate variability value.

deviceIdlongOptional

The id of the device that took the reading.

deviceIdentifierstringOptional

The device identifier of the device that took the reading.

patientIdlongOptional

The id of the patient that took the reading.

deviceTimeZoneOffsetintegerOptional

The offset of the device’s timezone from UTC in seconds. Null if unavailable.

manualbooleanOptional

True if the reading value was entered manually, false or null otherwise.

heartRateintegerOptional

The heart rate measurement value.

heartRateVariabilityDurationlongOptional

The duration over which the heart rate variability was measured, in milliseconds.

heartRateVariabilityAlgorithmTypeenumOptional
Allowed values: sdannsdnnsdrr

Response

This endpoint returns an object.
heartRateVariabilitydouble

The heart rate variability value.

idlongOptional

Unique identifier for the reading.

readingTimestampdatetimeOptional
manualbooleanOptional

True if the reading value was entered manually, false or null otherwise.

deviceTimeZoneOffsetintegerOptional

The offset of the device’s timezone from UTC in seconds. Null if unavailable.

patientTimeZoneOffsetintegerOptional

The offset of the patient’s timezone from UTC in seconds. Null if unavailable.

heartRateintegerOptional

The heart rate measurement value.

heartRateVariabilityDurationlongOptional

The duration over which the heart rate variability was measured, in milliseconds.

patientobjectOptional
itemobjectOptional

An item is any of the supplies handled by Impilo. Examples include medical devices like a blood pressure monitor or weight scale, but the term ‘item’ also refers to non-medical supplies like AAA batteries and package inserts. A customer catalog is a subset of all items supported by Impilo. This is set during onboarding and may be modified by your account manager at any time. A customer may view the items in their catalog.

deviceobjectOptional

A device is an instance of an item. Impilo creates device records for items that are serialized, i.e., items where each individual unit is identified by a serial number, IMEI, or other identifier.

heartRateVariabilityAlgorithmTypeenumOptional
Allowed values: sdannsdnnsdrr
Built with