Alerts
Minimum CorEMR Version: 6.2.0
This webservice allows clients to manage patient information inside the CorEMR system. It can be used to retrieve and edit patient alerts, as well as all of their applicable fields and data.
Alert Endpoints
Action | REST Verb | Description |
---|---|---|
Read | GET |
/ws/alerts/
Gets list of all patient alerts currently in the system.
|
Read | GET |
/ws/patients/{external_id}/alerts/
Get all alerts on the specific patient with the given external_id
|
Read | GET |
/ws/patients/{external_id}/alerts/{alert_id}
Get a specific alert with the given id on the patient with the given external_id
|
Create | POST |
/ws/patients/{external_id}/alerts/
Create a new alert on the patient with the given external_id.
|
Update | POST |
/ws/patients/{external_id}/alerts/{alert_id}
Update an existing patient alert.
|
Patient Get /ws/alerts/ Return Fields
Return Field | Datatype | Note |
---|---|---|
id | Integer | Unique alert identifier. |
external_id | String | Unique patient identifier correlating to the patient this alert is assigned to. |
category_name | String | Category of alert. |
category_id | Integer | Category number of alert. |
created_date | String | Alert's creation date as a string, formatted as YYYY-MM-DD 00:00:00.000 |
created_user | String | User's name who created the alert |
category_user_id | Integer | User's ID number who created the alert |
expires_date | String | Alert's expiration date as a string, formatted as YYYY-MM-DD 00:00:00.000 |
removed_date | String | Alert's removal date as a string, formatted as YYYY-MM-DD 00:00:00.000 |
removed_user | String | User's name who removed the alert |
removed_user_id | Integer | User's ID number who removed the alert |
Patient Post Alert Fields
Field | Datatype | Required for Post | Notes |
---|---|---|---|
category_id | Integer | Y | The category number correlating to the alert type. |
facility_created | Integer | Y | Facility number where the patient alert is being created. |
date_removed | DateTime | Date the alert was removed from the patient. Formatted in ISO8601 format. | |
date_expires | DateTime | Date the alert expires. Formatted in ISO8601 format. | |
facility_completed | Integer | Facility number where the patient alert was ended. |