Device Management Guide

Device Assignment and Status Updates

When an order is processed, devices are typically assigned either to a patient or a site. This assignment triggers a status update for the order, which can be observed through the Impilo webhook workflows. For more information see the Webhook management guide and the order.Status event type.

Manual Device Assignment

Apart from automatic assignments through order processing, devices can also be manually assigned to patients. This is done using the Associate Device endpoint. Note that in order to associate a device with a patient, all of the following must apply:

• The Patient must be associated with the Customer making the request
• The Device must be owned by the Customer making the request
• The Device must be associated with a non-Impilo site
• The Device must have a current status of availableAtSite

Device Management Scenarios

Multiple Devices: There is no separate process required for ordering or assigning additional devices to a patient. Impilo’s system supports associating multiple devices with a single patient profile seamlessly.

Device Disassociation: It’s always possible to disassociate a device from a patient, allowing for flexible management depending on the use case requirements.

Device Replacement: In cases where a device is defective, Impilo facilitates a smooth replacement process. The defective device is returned to an Impilo warehouse, and a new device is simultaneously dispatched to ensure minimal disruption in patient care.

Device Association Workflow

Here’s a walkthrough of the typical device association steps in the Impilo system:

1. Device Lookup: Use the device lookup endpoint to find specific devices.

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

2. Patient or Site Lookup: Lookup the patient or site using their respective endpoints to ensure the device is associated correctly.

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

3. Device Association Request: Finally, issue a device association request to link the device with the chosen patient or site.

1
curl -X PATCH https://app.impiloplatform.com/api/v3/device/associate-patient \
2
     -H "Impilo-API-Key: <Impilo-API-Key>" \
3
     -H "Content-Type: application/json" \
4
     -d '{
5
  "deviceId": 1,
6
  "patientExternalIdentifier": "external-identifier"
7
}'

Updating Device Details

To update a device, the following endpoint is utilized:

A DeviceUpdate object is used to specify the changes. This object includes an override status and an optional note. Below is an example of how to format the request body to update a device’s status and include a note about the update.

For example, to block a device from submitting readings to the Impilo platform, a decommissioned status could be set on a specific device.

Here is the new content added under the “Device Readings” section:

Device Readings

Device Timezones:

In the Impilo system, certain devices transmit timezone information, which is included as part of the reading. Specifically, the deviceTimeZoneOffset and patientTimeZoneOffset fields are used to track the timezone offsets for the device and the patient, respectively.

• deviceTimeZoneOffset: This field represents the timezone offset of the device at the time the reading was taken.

• patientTimeZoneOffset: This field represents the timezone offset calculated based on the patient’s zip code, if available.

Not all devices transmit timezone information. However, when this information is available, it is forwarded along with the reading to ensure accurate time tracking and data analysis.

Let me know if you need further modifications!

Device Status Update Workflow

Fetch a Device by ID

Send a request to the Device endpoint:

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

Truncated response:

1
{
2
  "id": 1,
3
  "currentStatus": "available"
4
}

Send a Device Update Request

Send a device update request to change the status of the device:

Fetch the Updated Device by ID

Send another request to the Device endpoint and observe the change:

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

Truncated response:

1
{
2
  "id": 1,
3
  "currentStatus": "decommissioned"
4
}