---
title: "View insurance plan"
method: GET
path: "/insurance_plans/{id}"
tags: ["Insurance"]
---

# View insurance plan

`GET /insurance_plans/{id}`

This endpoint returns a single insurance plan by its NexHealth id. Use the include parameter to embed related resources: patient_coverages, subscribers and/or fee_schedule. Responds with a 404 when no plan with the given id exists for the institution.

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required
- `include[]` string[]

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesInsuranceEhrPlanWithIncludesResponse — API_V20240412_Entities_Insurance_EhrPlanWithIncludes_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` APIV20240412EntitiesInsuranceEhrPlanWithIncludes
    - `id` integer — Plan id
    - `payer_id` string, nullable — A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically
    - `name` string, nullable — Plan name
    - `address` string, nullable — Street address
    - `address2` string, nullable — Street address 2
    - `city` string, nullable — City
    - `state` string, nullable — 2 letter state code
    - `zip_code` string, nullable — Zip code
    - `country_code` string, nullable — 2 letter country code
    - `group_num` string, nullable — Group number
    - `employer_name` string, nullable — Employer name
    - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system
    - `updated_at` string, date-time — Insurance Plan update date in UTC
    - `deleted_at` string, date-time, nullable — The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true
    - `patient_coverages` APIV2EntitiesInsurancePatientCoverage[] — List of patient coverages for this plan
      - `id` integer — Coverage id
      - `subscription_relation` 'self' | 'spouse' | 'child' | 'employee' | 'handicap_dep' | 'signif_other' | 'injured_plaintiff' | 'life_partner' | 'dependent' | 'other' — The relationship of this patient to the subscriber
      - `patient_id` integer, nullable — The ID of the covered patient
      - `priority` integer, nullable — The relative priority of this insurance coverage where the lowest value is the patient's primary insurance and higher values represent secondary and tertiary policies
      - `plan_id` integer, nullable — The ID of the insurance plan this coverage subscribes to
      - `subscriber_num` string, nullable — The subscriber's identification number for the plan
      - `effective_date` string, date, nullable — The date the coverage takes effect
      - `expiration_date` string, date, nullable — The date the coverage expires
    - `subscribers` APIV2EntitiesInsuranceSubscriber[] — List of individuals who hold subscriptions to this plan
      - `id` integer — The subscriber's id
      - `name` string — The subscriber's full name
      - `date_of_birth` string, nullable — The subscriber's date of birth in YYYY-MM-DD format
    - `fee_schedule` APIEntitiesFeeSchedule
      - `id` integer — Fee schedule id
      - `name` string — The name of the fee schedule
      - `active` boolean, nullable — Indicates if the fee schedule is active
      - `location_id` integer, nullable — The id of the location this fee schedule belongs to
      - `updated_at` string, date-time — Fee Schedule update date in UTC
  - `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.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)