Record Peak Flow Reading

POST

Records a peak flow reading based on the provided request. Either a device ID, device identifier, or patient ID is required.


For more information see the PeakFlowReadingRequest Model.

Request

This endpoint expects an object.
readingTimestampdatetimeRequired

The UTC timestamp at which the reading was taken.

peakExpiratoryFlowdoubleRequired

The Peak Expiratory Flow, measured in L/min.

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.

forcedExpiratoryVolumeInOneSeconddoubleOptional

The Forced Expiratory Volume in One Second value, in L.

manualbooleanOptional

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

Response

This endpoint returns an object.
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.

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.

peakExpiratoryFlowdoubleOptional
forcedExpiratoryVolumedoubleOptional