Patient alerts

What are patient alerts?

Patient alerts are pop-up notifications for office staff. They usually hold notes or important information about the patient. An alert pops up on the screen when a staff member opens the patient file in the health record system.

Example of patient alert in the Open Dental UI.

Example of a patient alert in the Open Dental UI.

How can I use patient alerts endpoints?

The patient alerts endpoints let you write an alert to a patient record and disable the alerts you added. Reading patient alerts returns only the alerts added through the API. It does not return alerts that office staff created in the health record system.

Patient alerts response

{
  "code": true,
  "description": "Description",
  "error": "Error",
  "data": [
    {
      "id": 10,
      "patient_id": 101,
      "note": "Patient is late on payment",
      "disabled_at": "2024-02-05T20:16:57.007Z",
      "created_at": "2023-11-11T10:11:01.007Z",
      "updated_at": "2024-01-14T14:11:01.007Z"
    }
  ],
  "count": 1
}