Alerts

Patient alerts may be added and removed from patients. Available since CorEMR version 5.4.2.

Actions

ActionREST VerbDescription
ReadGET
/ws/alerts/
Gets list of active alerts currently in system. Filters can be applied, as explained below.
ReadGET
/ws/patients/{external_id}/alerts/
Gets list of active alerts on existing patient. Filters can be applied, as explained below.
AddPOST
/ws/patients/{external_id}/alerts/
Creates a new alert on existing patient.
ReadGET
/ws/patients/{external_id}/alerts/{alert_id}
Gets an existing alert on existing patient.
UpdatePUT
/ws/patients/{external_id}/alerts/{alert_id}
Updates an existing alert on existing patient.
RemoveDELETE
/ws/patients/{external_id}/alerts/{alert_id}
Removes an existing active alert.

Filters

FilterDescription
categoriesComma seperated list of category IDs.
include_removedIncludes alerts removed in the last 4 hours.

Fields

FieldDatatypeAddReadNotes
idIntegerYUnique alert record identifier.
external_idString(17)YUnique patient identifier.
category_idIntegerYY
category_nameStringY
created_dateDatetimeY
created_user_idIntegerY
expires_dateDatetime
removed_dateDatetimeNULL unless removed.
removed_user_idIntegerYNULL unless removed.

Removing

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