Skip to main content

Biometric Data Integrations

The Carium platform integrates with a variety of devices and systems that gather and aggregate patient biometric data. These integrations can be classified as direct or external. Direct integrations are those where Carium links directly with the patient's device. For external integrations, a third party typically handles the transport, aggregation, or summarization of the data collected by the patient's device before delivering it to Carium. These integrations are primarily done using APIs.

Developed by Carium's engineering team in cooperation with the system creators, these integrations include:

SystemConnectionDescription
Bluetooth DevicesDirectBluetooth devices are directly integrated with the Carium mobile applications. The Carium development team creates custom integrations for these devices in our native iOS and Android applications. These include Blood Pressure Cuffs, Glucometers, Weight Scales, Thermometers, and more.
Apple HealthKitDirectApple HealthKit is unique as its data is only available on the user’s mobile device. This integration is enabled when first installing the Carium mobile application on iOS devices.
Cellular DevicesExternalCellular devices are managed using the Carium mobile or web applications. Once a connection is established data is delivered to or collected by Carium’s cloud service.
Data HubsExternalHubs are capable of connecting with multiple Bluetooth devices. They're typically deployed in a central location within the patients home where they collect data from connected devices and relay them to the cloud using cellular or WiFi connections. These hubs are connected to Carium through OAuth or Custom integrations.
OAuth ServicesExternalOAuth is often utilized to give Carium access to data which has been previously processed or aggregated by a third-party. In this case, Carium can support both push and pull methods of data delivery.
CustomExternalCustom integrations to support any secure method of sharing data can be developed by Carium’s development team.

For a full list of biometrics supported please see: Metrics

Direct Bluetooth Integrations​

Direct Bluetooth integrations involve the development of custom code for Carium’s iOS and Android mobile applications. These connections are always initiated by the patient and require the patient to have the device in close proximity to their mobile device. Each device integration includes a connection wizard which can be used to establish the initial connection with the device.

After the initial connections Carium will sync any new readings from the devices when in range. This data will then be pushed to the Carium platform and stored in the patient’s record.

External Service Integrations​

External System Integrations encompass Cellular Devices, OAuth Services, Data Hubs, and Custom integrations. This section provides a brief overview of the capabilities provided by these integrations. It's assumed that an acceptable method of authentication and authorization has been established between Carium and the External System.

Patients sometimes are required to use a connection wizard to enter their credentials to establish the connection with the external service. However, some integrations can also be initiated by the provider or care team. The image below shows an example where the care team can initiate the connection with the external service by entering a device ID within the Devices tab of the patients record.

Mapping Organizations to Services​

These endpoints allow for the mapping of a service provided by an external system to a given Organization within the Carium platform.

Mapping Patients to Devices​

Patients can be assigned devices or accounts using mapping endpoints. These endpoints can also be used to define attributes specific to a device or system. For example, many mapping endpoints allow for the specification of a start-time that will define how much history should be transferred to the Carium record when setting up a patient that may have historical data present in the external system.

The following is an example of a typical response to a GET request to this endpoint for a single mapping.

{
  "data": {
    "attributes": {
      "connected": true,
      "created-at": "2024-01-01T00:00:00Z",
      "device-id": "3c7baac5-b736-46fa-a8ad-af168e4f8b54",
      "device-model": "12345",
      "device-type": "gateway",
      "first-data-time": "2023-12-01T00:00:00Z",
      "hwi-device-id": "c52cc247-c163-4c34-b07a-1413ba2c51ab",
      "individual-id": "79075e84-c3e6-49cc-adca-9e10d556b523",
      "last-data-time": "2024-04-15T00:00:00Z",
      "last-event-time": "2024-04-15T00:00:00Z",
      "last-modified-at": "2024-01-01T00:00:00Z",
      "manufacturer-model": "123456",
      "organization-id": "2ae075ee-08b6-4799-803f-d7f8d0d750b0"
    },
    "id": "b9758f95-28d4-4d3e-affd-fa39a0a47d78",
    "type": "insert-company-name-device-maps"
  },
  "meta": {}
}

Collection Methods​

Carium supports a number of techniques for collecting data from external systems. The most common approaches are described in the following table.

MethodDescription
Push from External SystemCarium will enable an API endpoint for pushing a JSON payload that contains the data along with a patient identifier.
Poll External SystemCarium will poll an API endpoint from the external system to collect new data on a predefined interval.
Notification from External SystemThe external system can POST to a Carium API endpoint when new data is available. This will trigger Carium to collect data from the external system using a separate endpoint.