v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Treatment Plans

View treatment plans

Returns a cursor-paginated list of treatment plans for the institution, with each plan's procedures embedded. Soft-deleted treatment plans are excluded. Results can be filtered by patient_id, status, and updated_since, and are ordered by id ascending — when using updated_since for incremental sync, do not assume results are ordered by update time.

get/treatment_plans

Query parameters

subdomainstring required

Used to scope the request to the specified institution

patient_idinteger

Filter by patient

status'not_applicable' | 'proposed' | 'accepted' | 'rejected' | 'completed'

Filter by status

updated_sincestring date-time

Treatment plans updated at or after the specified time (UTC). The boundary is inclusive: a plan whose updated_at exactly equals this value is returned

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 423,
      "name": "Active treatment plan",
      "patient_id": 115,
      "updated_at": "2020-06-05T20:16:57.007Z",
      "status": "proposed",
      "procedures": [
        {
          "id": 11,
          "location_id": 21,
          "patient_id": 162,
          "provider_id": 84,
          "appointment_id": 283,
          "code": "D6100",
          "name": "Implant Removal",
          "status": "referred",
          "updated_at": "2020-06-05T20:16:57.007Z",
          "body_site": {
            "tooth": [
              "3",
              "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"
  }
}