Lists clinical notes with various filtering options including pagination, sorting, and specific attributes such as IDs, types, assignee details, creator details, patient details, and more.
This endpoint supports comprehensive filtering to retrieve relevant clinical notes based on the provided criteria.

clinicalNotePagedResponseExample

The size of the page of content returned.

True if the sort direction should be descending.

Lists only clinical notes with the IDs provided.

Lists only clinical notes with the provided description.

Lists only clinical notes with the provided types.

Lists only clinical notes with the provided CPT code values.

Lists only clinical notes assigned to the provided assignee IDs.

Lists only clinical notes assigned to the provided assignee name.

Lists only clinical notes assigned to the provided assignee email.

Lists only clinical notes created by the provided creator IDs.

Lists only clinical notes created by the provided creator name.

Lists only clinical notes created by the provided creator email.

Lists only clinical notes associated with the provided patient IDs.

Lists only clinical notes associated with the provided patient site IDs.

Lists only clinical notes associated with the provided patient external identifiers.

Lists only clinical notes associated with the provided patient email.

Lists only clinical notes associated with the provided patient name.

List Clinical Notes

Fetches details of a specific clinical note by its unique ID.

clinicalNoteExample

Fetch Clinical Note

Clinical Notes

Returns a paginated list of all devices associated with the customer.

listDevicesResponseExample

True if the sort direction should be descending

Lists only devices with the IDs provided.

Lists only devices with the external IDs provided.

The device identifier type of the devices.

Lists only devices with the device identifiers provided.

Lists only devices with the provided Item ID type.

Lists only devices created by the Manufacturer ID provided.

Lists only devices of the sizes provided.

Lists only devices of the Classes provided.

Lists only devices that support the Reading Types provided.

List Devices

associateDeviceRequest

Associate Device

Disable Readings

disassociateDeviceRequestExample

Disassociate Device

Enable Readings

This endpoint validates that a Device Identifier exists and returns the Device upon matching. On failure, it indicates that the Identifier is not valid.

validateDeviceResponseExample

Validate Device

This endpoint returns the Device specified by ID in the URL path.

device

Fetch Device

Devices

Returns a paginated list that aggregates all Used and New inventory across
all Impilo and Customer locations by Item type. One entry per Item ID.

The size of the page returned. Max size is 100.

List Inventory Summary

Returns a paginated list of a Customer's inventory by Item type
across each of the Impilo Sites. One record per Item-Site combination.

List Impilo Inventory

Returns a paginated list of a Customer's inventory by Item type
across each of the Customer Sites that there is inventory held. One record per Item-Site combination.

List Site Inventory

Inventory

This endpoint returns a paginated list of all items in a customer's catalog with various filtering options including pagination, sorting, and specific attributes such as IDs, names, models, SKUs, sizes, classes, reading types, and manufacturer IDs.

listItemsResponseExample

The size of the page of content returned. Max value is 100.

Lists only items with the provided Item IDs.

Lists only items with the provided model.

Lists only items with the provided sizes.

Lists only items with the provided classes.

Lists only items with the provided reading types.

Lists only items created by the provided Manufacturer IDs.

List Items

without-identifier

with-identifier

Create Item

This endpoint returns the Item specified by ID in the URL path.

fullItem

Fetch Item

Items

listKitsResponse

List Kits

This endpoint returns the Kit specified by ID in the URL path.

fetchKitResponse

Fetch Kit

Kits

listManufacturersResponse

List Manufacturers

This endpoint returns the Manufacturer specified by ID in the URL path.

fetchManufacturerResponse

Fetch Manufacturer

Manufacturers

List Orders

existing-patient-order

new-patient-order

site-order

Create Order

Fetch Order

Void Order

Orders

Retrieves a paginated list of patients. Optional parameters allow specifying the page number and page size.

patientPagedResponseExample

Lists only patients with the IDs provided.

Lists only patients with the site IDs provided.

Lists only patients with the external identifiers provided.

Lists only patients with the provided email.

Lists only patients with the provided name.

Lists only patients born on or after the provided date.

Lists only patients born on or before the provided date.

Lists only patients with the provided postal code.

Lists only patients with the provided country.

List Patients

create-patient

Create Patient

fetchByEmailExample

Fetch Patient By Email

Fetches details of a specific patient by their unique ID.

patient

Fetch Patient

Update Patient

update-patient-email

update-patient-external-identifier

Patch Patient

Patients

Fetches a procurement by ID provided in the path.

procurementResponseExample

List Procurements

Create Procurement Request

Create Shipping Notice

Fetches the uploaded file from the provided Procurement ID, if exists.

The Procurement ID to fetch the CSV from.

Fetch Procurement Document

UploadProcurementDocumentRequest

Upload Procurement Document

Deletes the uploaded file from the provided Procurement ID, if exists.

The Procurement ID to delete the CSV from.

Delete Procurement Document

Procurements

site

List Sites

Create Site

Returns the site specified by the ID in the URL path.

Fetch Site

update-site

Update Site

Patch Site

Sites

createDeviceTransferRequestExample

Create Device Transfer Request

createItemTransferRequestExample

Create Item Transfer Request

Retrieves a paginated list of Transfer Requests from the Impilo platform.

List Transfer Requests

Fetches a Transfer Request by ID from the Impilo platform.

item-transfer-request

device-transfer-request

Fetch Transfer Request

Transfers

This endpoint retrieves a paginated list of V3 webhooks that the associated Customer is subscribed to.

ListWebhooksResponse

List Webhooks

WebhookResponseExample

Create Webhook

Gets your Webhook Secret if it exists. Otherwise returns an error.

Fetch Webhook Secret

Create Webhook Secret

Delete Webhook Secret

Update Webhook Secret

Retrieves a paginated list of webhook logs that record historical attempts to send webhook payloads to a customer's servers. This endpoint allows filtering logs based on webhook type, creation timestamp range, retry attempts range, last response status, last retry timestamp range, and pagination settings. It is useful for auditing and debugging purposes.

The number of the page to retrieve (1 based)

List Webhook Logs

This endpoint retrieves a particular Webhook of a customer by the ID provided in the path.

fetchWebhooksResponse

Fetch Webhook

This endpoint deletes the specified Webhook from the customer's subscriptions.

Delete Webhook

updateWebhookResponseExample

Patch Webhook

Webhooks

bloodGlucoseReadingPagedResponseExample

List Blood Glucose Readings

device-identifier

Record Blood Glucose Reading

Exports blood glucose readings for a specified patient within a given date range as either an Excel spreadsheet or a CSV file. This endpoint allows clients to specify a patient ID, and optional start and end dates to filter the readings by date. If no patient ID is provided, readings for all patients may be exported depending on the implementation. The 'excel' parameter determines the format of the export: if true, the data is returned in Excel format; otherwise, it is returned as CSV. The response is directly streamed to the client as either 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' for Excel or 'text/csv' for CSV format.

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

The ID of the patient whose blood glucose readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering blood glucose readings. Only readings after or equal to this date will be included.

The end date for filtering blood glucose readings. Only readings before this date will be included.

Export Blood Glucose Readings

This endpoint returns a specific blood glucose reading based on the reading identifier provided in the path.

bloodGlucoseReadingResponseExample

Fetch Blood Glucose Reading

Readings - Blood Glucose

Retrieves a paginated list of blood oxygen readings from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, patient ID, external ID, start timestamp, and end timestamp.

bloodOxygenReadingPagedResponseExample

List Blood Oxygen Readings

Record Blood Oxygen Reading

Exports blood oxygen readings for a specified patient within a given date range as either an Excel spreadsheet or a CSV file. This endpoint facilitates the retrieval of blood oxygen data by allowing the specification of a patient ID and optional start and end dates to narrow down the readings. If no patient ID is specified, the service may return readings for all patients, contingent on the service's implementation details. The 'excel' parameter controls the output format: if set to true, the data is delivered in Excel format; if false, it is delivered in CSV format. The data is streamed directly to the client and can be consumed in the specified format.

The ID of the patient whose blood oxygen readings are to be exported. If not provided, readings for all patients may be exported.

The start date for filtering blood oxygen readings. Only readings after or equal to this date will be included.

The end date for filtering blood oxygen readings. Only readings before this date will be included.

1	{
2	"content": [
3	{
4	"id": 1,
5	"externalOrderIds": [
6	"externalOrderIds"
7	],
8	"patient": {
9	"id": 1,
10	"externalIdentifier": "1234abcd",
11	"firstName": "John",
12	"lastName": "Doe",
13	"dateOfBirth": "1980-01-01",
14	"email": "john.doe@example.com",
15	"phoneNumber": "+1234567890",
16	"archived": true
17	},
18	"site": {
19	"id": 1
20	},
21	"currentStatus": "availableForPickup",
22	"orderItems": [
23	{}
24	],
25	"orderKits": [
26	{}
27	],
28	"orderEvents": [
29	{}
30	],
31	"trackingNumbers": [
32	{}
33	],
34	"devices": [
35	{
36	"id": 1
37	}
38	],
39	"packedKits": [
40	{}
41	],
42	"shippingOption": "standard"
43	}
44	],
45	"page": 1,
46	"size": 1,
47	"total": 1,
48	"first": true,
49	"last": true
50	}

1	curl https://app.impiloplatform.com/api/v3/order \
2	-H "Impilo-API-Key: <apiKey>"

Query parameters

Response