API ReferenceReadings Peak Flow

Record Peak Flow Reading

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

Authentication

Impilo-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
peakExpiratoryFlowdoubleRequired

The Peak Expiratory Flow, measured in L/min.

readingTimestampstringRequiredformat: "date-time"
The UTC timestamp at which the reading was taken.
deviceIdlongOptional
The id of the device that took the reading.
deviceIdentifierstringOptional
The device identifier of the device 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.
patientIdlongOptional
The id of the patient that took the reading.

Response

OK
readingTimestampstringformat: "date-time"
The UTC timestamp at which the reading was taken.
deviceobject or null
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.
deviceTimeZoneOffsetinteger or null
The offset of the device's timezone from UTC in seconds. Null if unavailable.
forcedExpiratoryVolumedouble or null
forcedExpiratoryVolumeUnitenum or null
Allowed values:
idlong or null
Unique identifier for the reading.
itemobject or null
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.
manualboolean or null
True if the reading value was entered manually, false or null otherwise.
patientobject or null
The Patient resource represents a patient in the Impilo system. It includes personal information, contact details, and enrollment status.
patientTimeZoneOffsetinteger or null
The offset of the patient's timezone from UTC in seconds. Null if unavailable.
peakExpiratoryFlowdouble or null
peakExpiratoryFlowUnitenum or null
Allowed values: