API ReferenceReadings Medication Compliance Events

Export Medication Compliance Events

Exports medication compliance events for a specified patient over a selected date range, available in either Excel or CSV format. This endpoint allows the specification of a patient ID, enabling the retrieval of medication compliance data for an individual patient. Alternatively, if no patient ID is provided, it may export readings for all patients, dependent on the implementation details of the service. Users can also specify start and end dates to filter the export to a specific timeframe. The ‘excel’ parameter dictates the format of the output; if set to true, the readings are exported in Excel format, otherwise in CSV format

Headers

Impilo-API-KeystringRequired

Query parameters

excelbooleanOptional

Determines the format of the export: if true, the data is returned in Excel format; otherwise, it is returned as CSV.

patientIdlongOptional
The ID of the patient whose medication compliance events are to be exported. If not provided, readings for all patients may be exported.
startstringOptionalformat: "date-time"
The start date for filtering medication compliance events. Only readings after or equal to this date will be included.
endstringOptionalformat: "date-time"
The end date for filtering medication compliance events. Only readings before this date will be included.