---
title: "View treatment plan (beta)"
method: GET
path: "/treatment_plans/{id}"
tags: ["Treatment Plans"]
---

# View treatment plan (beta)

`GET /treatment_plans/{id}`

## Request

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

> 🚧 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 response fields `data.created_at`, `data.deleted_at`, `data.foreign_id`, `data.guarantor_id` (+19 more).

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesTreatmentPlanResponse: API_V31_Entities_TreatmentPlan_Response model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesTreatmentPlan
    - `id` integer: Resource ID
    - `name` string: The name of the treatment plan
    - `patient_id` integer: The ID of patient this treatment plan is for
    - `guarantor_id` integer: The ID of the guarantor for this treatment plan
    - `preparer_id` integer: The ID of the user who prepared this treatment plan
    - `status` 'not_applicable' | 'proposed' | 'accepted' | 'rejected' | 'completed': Status of the treatment plan
    - `note` string: Note on the treatment plan
    - `treatment_plan_creation_date` string: Treatment plan creation date as reported by the integrated system
    - `created_at` string, date-time: Treatment plan creation date in UTC
    - `updated_at` string, date-time: Treatment plan update date in UTC
    - `deleted_at` string, date-time: Treatment plan deletion date in UTC; null for live plans
    - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `procedures` APIV31EntitiesTreatmentTreatmentPlanProcedure[]: Procedures assigned to the treatment plan, ordered by priority; procedures without a priority come last.
      - `id` integer: Procedure ID
      - `location_id` integer, nullable: Location ID
      - `patient_id` integer, nullable: Patient ID
      - `provider_id` integer, nullable: Provider ID
      - `appointment_id` integer, nullable: Appointment ID. Null when the procedure is not attached to an appointment
      - `code` string, nullable: Procedure code
      - `name` string, nullable: Procedure name
      - `status` 'planned' | 'scheduled' | 'completed' | 'inactive' | 'referred' | 'existing', nullable: Procedure status
      - `updated_at` string, date-time: Procedure update date in UTC
      - `body_site` APIV2EntitiesProcedureBodySite
        - `tooth` string[]: Tooth identifier strings, typically tooth numbers
        - `surface` string: Tooth surface codes
      - `fee` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `start_date` string, date, nullable: Start date for procedure
      - `end_date` string, date, nullable: End date for procedure
      - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
      - `priority` integer, nullable: Ordering rank of this procedure within the plan (EHR priority/visit/phase). Lower values come first; null when the EHR assigns none.
      - `estimates` APIV31EntitiesTreatmentProcedureCostEstimate
        - `patient_fee` APIV2EntitiesPrice
          - `amount` string: The currency value, in whole units (e.g. dollars)
          - `currency` string: The ISO currency code
        - `patient_amount_estimate` APIV2EntitiesPrice
          - `amount` string: The currency value, in whole units (e.g. dollars)
          - `currency` string: The ISO currency code
        - `discount` APIV2EntitiesPrice
          - `amount` string: The currency value, in whole units (e.g. dollars)
          - `currency` string: The ISO currency code
        - `insurance_estimates` APIV31EntitiesTreatmentInsuranceEstimate[]: Insurance contribution estimates ranked by coverage order (rank: 1 = primary, rank: 2 = secondary). Entries with no estimate value are omitted.
          - `rank` integer: Coverage rank (1 = primary, 2 = secondary).
          - `amount` string: Estimated insurance contribution, in major currency units.
          - `currency` string: ISO 4217 currency code.
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)