API ReferenceReadings Medication Compliance Events

Record Medication Compliance Event

This endpoint records a medication compliance event based on the provided request. Either a device ID, device identifier, or patient ID is required.

Headers

Impilo-API-KeystringRequired

Request

This endpoint expects an object.
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.
eventInfomap from strings to objectsOptional
eventTypeenumOptional
Allowed values:
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
eventTypeenum
The event type generated.
Allowed values:
readingTimestampstringformat: "date-time"
The UTC timestamp at which the reading was taken.
deviceobject or null
The device used to generate the event.
deviceTimeZoneOffsetinteger or null
The offset of the device's timezone from UTC in seconds. Null if unavailable.
eventInfomap from strings to objects or null
Additional event information provided with the event.
idlong or null
Unique identifier for the reading.
itemobject or null
The item used to generate the event.
manualboolean or null
True if the reading value was entered manually, false or null otherwise.
patientobject or null
The patient who generated the event.
patientTimeZoneOffsetinteger or null
The offset of the patient's timezone from UTC in seconds. Null if unavailable.