NEnexhealth
Treatment Plans

View treatment plans (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query params include_deleted, location_id; adds response fields data[].created_at, data[].deleted_at, data[].foreign_id, data[].guarantor_id (+19 more).

get/treatment_plans

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/treatment_plans
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

patient_idinteger

Filter by patient

location_idinteger

Filter by location

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

Filter by status

updated_sincestring date-time

Treatment plans updated after the specified time (UTC)

include_deletedboolean

Include deleted treatment plans

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,
      "guarantor_id": 116,
      "preparer_id": 42,
      "status": "proposed",
      "note": "Follow-up in 6 months",
      "treatment_plan_creation_date": "01/01/2023",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "deleted_at": "2026-05-12T20:16:57.007Z",
      "foreign_id": "12345678",
      "procedures": [
        {
          "id": 11,
          "location_id": 21,
          "patient_id": 162,
          "provider_id": 84,
          "appointment_id": 283,
          "code": "D6100",
          "name": "Implant Removal",
          "status": "completed",
          "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",
          "foreign_id": "12345",
          "priority": 2,
          "estimates": {
            "patient_fee": {
              "amount": "62.00",
              "currency": "USD"
            },
            "patient_amount_estimate": {
              "amount": "62.00",
              "currency": "USD"
            },
            "discount": {
              "amount": "62.00",
              "currency": "USD"
            },
            "insurance_estimates": [
              {
                "rank": 1,
                "amount": "120.00",
                "currency": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.