---
title: "View claim"
method: GET
path: "/claims/{id}"
tags: ["Claims"]
---

# View claim

`GET /claims/{id}`

This endpoint returns a single insurance claim by its NexHealth id. Use the include parameter to embed related resources: patient, provider, guarantor, charges and/or charge_payouts. Note: when no claim with the given id exists, or it belongs to a location your token cannot access, this endpoint currently responds with HTTP 500 rather than a 404.

## Path parameters

- `id` integer, required

## Query parameters

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

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesLedgerInsuranceClaimResponse — API_V20240412_Entities_Ledger_Insurance_Claim_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` APIV20240412EntitiesLedgerInsuranceClaim
    - `id` integer — Claim id
    - `location_id` integer, nullable — Location id. Null when the claim is not attached to a location
    - `patient_id` integer, nullable — Patient id. Null when the claim is not attached to a patient
    - `provider_id` integer, nullable — Provider id. Null when the claim is not attached to a provider
    - `guarantor_id` integer, nullable — User id of the patient's responsible party. Null when the claim is not attached to a guarantor
    - `status` 'draft' | 'sent' | 'received' | 'canceled', nullable — Claim status
    - `received_at` string, date-time, nullable — Date and time in UTC when the claim was received from insurance
    - `sent_at` string, date-time, nullable — Date and time in UTC when the claim was sent to insurance
    - `note` string, nullable — Claim notes
    - `primary_insurance_plan_id` integer, nullable — Id of the primary insurance plan this claim was or will be sent to
    - `secondary_insurance_plan_id` integer, nullable — Id of the secondary insurance plan this claim was or will be sent to
    - `date_of_service` string, date, nullable — The date in UTC when the procedures included in the claim occurred
    - `totals` APIV20240412EntitiesLedgerChargeClaimTotals
      - `amount_billed_to_insurance` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `estimated_insurance_payment` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `insurance_payment` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `write_off` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
    - `updated_at` string, date-time — Claim update date in UTC
    - `deleted_at` string, date-time, nullable — The UTC date and time the claim was deleted. Null when the claim is not deleted. Deleted claims are only listed when include_deleted is true
    - `patient` APIV20240412EntitiesPatientBasic
      - `id` integer — User id
      - `email` string, nullable — User email
      - `first_name` string — First name
      - `middle_name` string, nullable — Middle name
      - `last_name` string — Last name
      - `name` string — Full name
      - `created_at` string, date-time — User creation date in UTC
      - `updated_at` string, date-time — User last updation date in UTC
      - `institution_id` integer — The institution this user belongs to
      - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system
      - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system
      - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned
      - `inactive` boolean — Is the user inactivated?
      - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source
      - `guarantor_id` integer, nullable — User id of this patient's responsible party
      - `billing_type` string, nullable — Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type
      - `chart_id` string, nullable — User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users
      - `preferred_language` string, nullable — Patient's preferred language as an ISO 639-1 code, if specified in the integrated system
      - `provider_id` integer, nullable — User id of this patient's primary provider
    - `provider` APIV2EntitiesProvider
      - `id` integer — User id
      - `email` string, nullable — User email
      - `first_name` string — First name
      - `middle_name` string, nullable — Middle name
      - `last_name` string — Last name
      - `name` string — Full name
      - `created_at` string, date-time — User creation date in UTC
      - `updated_at` string, date-time — User last updation date in UTC
      - `institution_id` integer — The institution this user belongs to
      - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system
      - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system
      - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned
      - `inactive` boolean — Is the user inactivated?
      - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source
      - `display_name` string — Display name
      - `npi` string — National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system.
      - `tin` string — Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system.
      - `state_license` string — State license number. May be null if the practice did not enter it into the integrated system.
      - `specialty_code` string — Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system.
    - `guarantor` APIV2EntitiesUser
      - `id` integer — User id
      - `email` string, nullable — User email
      - `first_name` string — First name
      - `middle_name` string, nullable — Middle name
      - `last_name` string — Last name
      - `name` string — Full name
      - `created_at` string, date-time — User creation date in UTC
      - `updated_at` string, date-time — User last updation date in UTC
      - `institution_id` integer — The institution this user belongs to
      - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system
      - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system
      - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned
      - `inactive` boolean — Is the user inactivated?
      - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source
    - `charge_payouts` APIV20240412EntitiesLedgerChargePayout[] — Billing details for each charge associated with this claim
      - `amount_billed_to_insurance` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `estimated_insurance_payment` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `insurance_payment` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `write_off` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `allowed_amount` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `fee_schedule_procedure_code` APIV20240412EntitiesFeeScheduleProcedureCode
        - `procedure_code_id` string, nullable — The uuid of the procedure code associated with the fee schedule
        - `fee` APIV2EntitiesPrice
          - `amount` string — The currency value, in whole units (e.g. dollars)
          - `currency` string — The ISO currency code
        - `code` string, nullable — The code of the procedure associated with the fee schedule
        - `id` integer — Fee Schedule Procedure Resource id
        - `location_id` integer, nullable — The location id of the fee schedule
        - `fee_schedule_id` integer, nullable — The id of the fee schedule associated with the fee schedule procedure
        - `updated_at` string, date-time — Fee Schedule Procedure update date in UTC
      - `charge_id` integer — The ID of the charge associated with this payout
    - `charges` APIV20240412EntitiesLedgerChargeBasic[] — Charges associated with this claim
      - `id` integer — Resource id
      - `foreign_id` string — Unique identifier of this resource from the integrated system
      - `location_id` integer, nullable — The ID of the location that this item is for
      - `patient_id` integer, nullable — The ID of the patient that this item is for
      - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for
      - `provider_id` integer, nullable — The ID of the provider that this item is for
      - `procedure_id` integer, nullable — The ID of the procedure associated with this charge
      - `procedure_code` string, nullable — The procedure code associated with this charge
      - `updated_at` string, date-time — Last updated time for item in UTC
      - `description` string, nullable — A description of the charge
      - `fee` APIV2EntitiesPrice
        - `amount` string — The currency value, in whole units (e.g. dollars)
        - `currency` string — The ISO currency code
      - `charged_at` string, date, nullable — The UTC date charge was made
  - `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/versions/a180e830b672/schema)