Alerts

The alert object

Field	Type	Description
`id`	UUID	Alert's identifier
`userId`	UUID	Identifier of the patient who triggered the alert
`groupId`	UUID	Identifier of the group the alert belongs to
`protocolId`	UUID \| null	Protocol associated with the alert, if any
`programId`	UUID \| null	Program associated with the alert, if any
`measurementId`	UUID \| null	Measurement that triggered the alert, if any
`instrumentId`	UUID \| null	Instrument associated with the alert, if any
`type`	string	What triggered the alert. One of `mea` (measurement threshold exceeded), `rem` (patient remark), `ovd` (overdue measurement), `combination` (combination of thresholds)
`flag`	string	Severity of the alert. One of `red`, `orange`, `gray`
`status`	string	Current status of the alert. One of `open`, `processed`, `escalated`
`processedAt`	ISO 8601 \| null	Date and time the alert was processed
`processedBy`	UUID \| null	Identifier of the user who processed the alert
`escalatedAt`	ISO 8601 \| null	Date and time the alert was escalated
`escalatedBy`	UUID \| null	Identifier of the user who escalated the alert
`createdAt`	ISO 8601	Date and time the alert was created
`updatedAt`	ISO 8601	Date and time the alert was last updated

List alerts

Retrieves a paginated list of alerts in your organization.

GET /v1/alerts
Accessible by HC_ADMIN and HC_VIEW_ALL.

Query parameters

Parameter	Type	Description
`startDate`	date (Y-m-d)	Return alerts created on or after this date
`endDate`	date (Y-m-d)	Return alerts created on or before this date
`cursor`	string	Cursor token for pagination
`perPage`	integer	Number of results per page (1–200, default 50)

Response

{
  "meta": {
    "nextCursor": "<cursor_token>",
    "prevCursor": "<cursor_token>"
  },
  "data": [
    {
      "id": "5bb27383-6f87-429c-8559-48e3f111cecb",
      "userId": "a8ddfa24-df95-4625-8ef8-a7518a8dc6ea",
      "groupId": "62be753c-dcbf-4c6b-9895-0e7087459a33",
      "protocolId": "9317beca-67b4-46e9-adcd-e24d04e679c1",
      "programId": "12790a98-4432-4541-bea9-954e666e7425",
      "measurementId": null,
      "instrumentId": null,
      "type": "mea",
      "flag": "red",
      "status": "open",
      "processedAt": null,
      "processedBy": null,
      "escalatedAt": null,
      "escalatedBy": null,
      "createdAt": "2025-03-24T11:45:00Z",
      "updatedAt": "2025-03-24T11:45:00Z"
    }
  ]
}

Update an alert

Updates the status of an alert. Use this endpoint to mark an alert as processed or escalated as your care team acts on it.

PUT /v1/alerts/{alertId}
Accessible by HC_ADMIN (organization-wide) and HC_PRIMARY, HC_SECONDARY (group only).

Path parameters

Parameter	Type	Description
`alertId`	UUID	Identifier of the alert to update

Request body

Field	Type	Description
`status`	string	New status for the alert. One of `open`, `processed`, `escalated`
`category`	string \| null	How the alert was classified (e.g. `request_visit`)
`additionalInfo`	string \| null	Additional notes added by the healthcare professional

Response

{
  "data": {
    "id": "5bb27383-6f87-429c-8559-48e3f111cecb",
    "userId": "a8ddfa24-df95-4625-8ef8-a7518a8dc6ea",
    "groupId": "62be753c-dcbf-4c6b-9895-0e7087459a33",
    "protocolId": "9317beca-67b4-46e9-adcd-e24d04e679c1",
    "programId": "12790a98-4432-4541-bea9-954e666e7425",
    "measurementId": null,
    "instrumentId": null,
    "type": "mea",
    "flag": "red",
    "status": "processed",
    "processedAt": "2025-03-24T12:00:00Z",
    "processedBy": "dd34afba-60cf-47ce-8bd5-3054acab2baf",
    "escalatedAt": null,
    "escalatedBy": null,
    "createdAt": "2025-03-24T11:45:00Z",
    "updatedAt": "2025-03-24T12:00:00Z"
  }
}

Get alert information records

Retrieves a paginated list of information records for a given alert. Each record represents an action taken on the alert by a healthcare professional.

GET /v1/alerts/{alertId}/information
Accessible by HC_ADMIN and HC_VIEW_ALL.

Path parameters

Parameter	Type	Description
`alertId`	UUID	Identifier of the alert

Query parameters

Parameter	Type	Description
`cursor`	string	Cursor token for pagination
`perPage`	integer	Number of results per page (1–200, default 50)

Response

The actionSource field indicates how the action was triggered. One of alerts_page, alerts_page_process_all, autoprocessed, or null if the source is unknown.

{
  "meta": {
    "nextCursor": "<cursor_token>",
    "prevCursor": "<cursor_token>"
  },
  "data": [
    {
      "alertId": "5bb27383-6f87-429c-8559-48e3f111cecb",
      "action": "process",
      "category": "request_visit",
      "additionalInfo": "Patient called, visit scheduled for tomorrow.",
      "actionSource": "alerts_page",
      "createdAt": "2025-03-24T12:00:00Z",
      "updatedAt": "2025-03-24T12:00:00Z"
    }
  ]
}