Alerts Generation

BioT supports alerts about a device operation or about a patient observation. The alerts are logged in the cloud and can be observed from the "Device Operation Center" or "Nursing Station" in the Organization portal.

An alert is generated by make a request to appropriate alerts API. The decision to generate an alert can be made directly from the device or by creating a plugin the will monitor a patient measurements or a device statuses.

Patient Measurement Monitoring

To monitor patient measurements create a plugin that will be notified when a new measurement is logged in BioT. To do that register a plugin using the register plugin API:
POST https://your-domain.com/settings/v1/plugins
With the notification block:

"notifications":[
         {
            "entityTypeName":"patient",
            "actionName":"_saveManagement"
         }
      ]

For complete information about plugin registration, click here.

Device Monitoring

To monitor devices create a plugin that will be notified when device changes are logged in BioT. To do that register a plugin using the register plugin API:
POST https://your-domain.com/settings/v1/plugins
With the notification block:

"notifications":[
         {
            "entityTypeName":"device",
            "actionName":"_update"
         }
      ]

For complete information about plugin registration, click here.

Alerts Generation

To generate a patient or device alert make the following API call:

For Patient:
POST https://example.com/organization/v1/users/patients/{patientId}/alerts/{templateName}

For Device:
POST https://example.com/device/v1/devices/{deviceId}/alerts/{templateName}

With the request body:

{
  "_state":"ACTIVE",
  "_severity":"CRITICAL",
  "<customAttributes1>":"<customAttributes1Value>"
}

The alert will be logged in BioT.

Managing Alerts

You can also update and delete alerts to change tier severity or close them when they are not longer relevant.

Update Alert
To update an alert use the following APIs:

For Patient:
PATCH https://example.com/organization/v1/users/patients/{patientId}/alerts/{id}

For Device:
PATCH https://example.com/device/v1/devices/{deviceId}/alerts/{id}

With the request body:

{
   "_state":"CLEARED",
   "_clearNotes":"Alert handled",
   "<customAttributes1>":"<customAttributes1Value>"
}

Delete Alert
To update an alert use the following APIs:

For Patient:
DELETE https://example.com/organization/v1/users/patients/{patientId}/alerts/{id}

For Device:
DELETE https://example.com/device/v1/devices/{deviceId}/alerts/{id}

The alert will be deleted from BioT.

📘

Note

Not all users are able to delete alerts. See the following page for more information about Attribute Based Access Control in BioT.