Typical Dataflow

The following describes how data typically flows (with measurement metrics and fulfillment updates) when working with the HWI API. It is highly recommended to make use of webhooks, however, the API also has a series of GET requests that can also be used to get this data.

Measurement Data

Using webhooks, you can receive measurement data in near real-time. When working with Bluetooth enabled devices that connect to the Tenovi Gateway, data typically flows:

Gateway Enabled Bluetooth Devices

1. Measurement is taken on a device and data is transmitted to the Tenovi Gateway
2. The Tenovi Gateway transmits data to Tenovi servers
3. Tenovi servers relay the data out to webhooks you define

flowchart
    MD["<strong><a href="/devices">Device</a></strong>\nBPM · Scale · Glucometer\nPulse Ox · Thermometer"]
    GW["<strong><a href="/hwi-api/gateways/">Tenovi Gateway</a></strong>\nCellular-connected hub"]
    TC["<strong>Tenovi Cloud</strong>\nData ingestion &amp; storage"]
    WH["<strong><a href="/hwi-api/webhooks/webhooks-overview/">Webhook / API</a></strong>\nHTTPS POST · REST"]
    YA["<strong>Your Application</strong>\nEHR · RPM Platform · Custom App"]

    MD -->|" Bluetooth "| GW
    GW -->|" Cellular / LTE "| TC
    TC -->|" Near Real-time push "| WH
    WH -->|" JSON payload "| YA

    style MD fill:#cdeaf5,stroke:#29ade3,color:#000
    style GW fill:#cdeaf5,stroke:#29ade3,color:#000
    style TC fill:#cdeaf5,stroke:#29ade3,color:#000
    style WH fill:#cdeaf5,stroke:#29ade3,color:#000
    style YA fill:#cdeaf5,stroke:#29ade3,color:#000

There are some exceptions to this data flow depending on the device. The Tenovi Watch for example offloads data at set times throughout the day. You can get more information on these exceptions on our Device Overview page.

Cellular Enabled Devices

If you are using a cellular enabled device without the use of a Tenovi Gateway, your data will flow directly from the device and up to Tenovi servers, before being relayed out to your webhooks.

1. Measurement is taken on a device and data is transmitted to the Tenovi Cloud
2. Tenovi servers relay the data out to webhooks you define

flowchart
    MD["<strong><a href="/devices">Device</a></strong>\nCellular BPM"]
    TC["<strong>Tenovi Cloud</strong>\nData ingestion &amp; storage"]
    WH["<strong><a href="/hwi-api/webhooks/webhooks-overview/">Webhook / API</a></strong>\nHTTPS POST · REST"]
    YA["<strong>Your Application</strong>\nEHR · RPM Platform · Custom App"]

    MD -->|" Cellular / LTE "| TC
    TC -->|" Near Real-time push "| WH
    WH -->|" JSON payload "| YA

    style MD fill:#cdeaf5,stroke:#29ade3,color:#000
    style TC fill:#cdeaf5,stroke:#29ade3,color:#000
    style WH fill:#cdeaf5,stroke:#29ade3,color:#000
    style YA fill:#cdeaf5,stroke:#29ade3,color:#000

Fulfillment Data

When working with devices that are dropshipped from Tenovi, you can expect fulfillment webhook updates throughout the device’s journey to the patient. Common shipment events include:

1. Shipped: The order has left the fulfillment facility.
2. In Transit: The carrier is moving the shipment through its delivery network.
3. Out for Delivery: The carrier expects to attempt delivery that day.
4. Delivery Issue: The carrier has reported an exception or other issue with the shipment.
5. Available for Pickup: The shipment is being held at a carrier facility for the patient.
6. Delivered: The order has arrived with the patient but no measurements have been taken yet.
7. Connected: The patient has taken their first measurement.
8. Replaced: The device has been replaced and the new hardware_uuid is included, if applicable.
9. Unlinked: The device has been unlinked, data will stop flowing, and monthly charges will be halted.

Note

A fulfillment webhook is sent for every status change. The additional shipping statuses may increase the number of callbacks generated for each shipment. Do not assume that a shipment will produce a fixed number of webhook events.

More statuses are used for fulfillment workflows based on how devices are activated and shipped. See Fulfillment Webhooks for the complete status definitions and payload details.

Special/Bulk Order Data

When working with bulk orders, supplies, replacements, or returns you can expect to get updates on your special order webhooks that you define on the HWI Settings screen. More details on these special orders can be found on our Special/Bulk Order Webhooks document.