API Reference

Procedures

🚧

Supported Integrations

For now, Procedures are only supported for Dentrix, Dentrix Enterprise, Eaglesoft and Open Dental.

Procedures are services that are provided for a patient. Each procedure will have a fee value showing how much was charged to the patient and their insurance for the service.

Procedures have four mutually exclusive status values representing their state:

  • treatment_planned meaning that the procedure is planned for a patient sometime in the future
  • scheduled meaning that the procedure has been scheduled for an appointment that has not yet occurred
  • completed meaning that the procedure has been completed and the patient has been charged
  • referred meaning that the procedure has been refferred out to a different practice for treatment
  • inactive meaning that the procedure was removed from the treatment plan or schedule

📘

Body Site

Depending on the health record system procedures additional fields specifying what part of the body the procedure was performed on. These will be surfaced in the body_site field. Notably for dentistry this field contains the tooth and surface.

Procedures Response

{
  "code": false,
  "description": "Description",
  "error": [
    "Error"
  ],
  "data": [
    {
      "id": 11,
      "patient_id": 162,
      "provider_id": 84,
      "appointment_id": 283,
      "code": "D6100",
      "name": "Implant Removal",
      "status": "inactive",
      "body_site": {
      	"tooth": "14",
        "surface": "MOD"
      },
      "fee": {
        "amount": "62.00",
        "currency": "USD"
      },
      "start_date": "2022-06-24",
      "end_date": "2022-06-24"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB",
  },
}