API Reference

Patient Alerts

🚧

Supported Integrations

Patient alerts are currently supported for Dentrix, Dentrix Enterprise, Eaglesoft, Open Dental, and Orthotrac.

What are Patient Alerts?

Patient Alerts are pop up notifications to office staff that generally contain notes or important pieces of information about the patient. Patient Alerts pop up on the desktop screen when a staff member accesses the patient file in the practice management 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 Alert endpoints?

Our Patient Alerts endpoints allow you to write a patient alert into a patient record, as well as programmatically disable the alerts you have added. Please note that reading patient alerts will only return the alerts that have been added through the API, not pre-existing alerts in the health record system created by office staff.

Patient Alerts Response

{
  "code": false,
  "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": 2
}