Skip to content

Alerts (v1)

Minimum CorEMR Version: 5.4.2

Patient alerts may be added and removed from patients.

Actions

Action REST Verb Description
Read GET /ws/alerts/ Gets list of active alerts currently in system. Filters can be applied, as explained below.
Read GET /ws/patients/{external_id}/alerts/ Gets list of active alerts on existing patient. Filters can be applied, as explained below.
Add POST /ws/patients/{external_id}/alerts/ Creates a new alert on existing patient.
Read GET /ws/patients/{external_id}/alerts/{alert_id} Gets an existing alert on existing patient.
Update PUT /ws/patients/{external_id}/alerts/{alert_id} Updates an existing alert on existing patient.

Filters

Filter Description
categories Comma seperated list of category IDs.
include_removed Includes alerts removed in the last 4 hours.

Fields

Field Datatype Add Read Notes
id Integer * Unique alert record identifier.
external_id String(17) * Unique patient identifier.
category_id Integer R *
category_name String *
created_date Datetime *
created_user String *
created_user_id Integer *
expires_date Datetime
removed_date Datetime NULL unless removed.
removed_user String * Available only in 5.5.11 or higher. NULL unless removed.
removed_user_id Integer * Available only in 5.5.11 or higher. NULL unless removed.

Removing

Updating an existing alert with a removed_date will trigger the system to remove the alert.