Treatment Plans

View treatment plan

Returns a single treatment plan with its procedures embedded. Requesting a soft-deleted or unknown treatment plan returns 404.

get/treatment_plans/{id}

Request

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

Path parameters

idinteger required

The ID of the treatment plan

Query parameters

subdomainstring required

Used to scope the request to the specified institution

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.

countinteger

Number of total objects, in case of collection.

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"
      }
    ]
  },
  "count": 2
}

Changes

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