Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Claims

View claims

This endpoint returns a list of insurance claims for a location. You can filter by patient_id, guarantor_id, provider_id, updated_since or date_of_service, and must provide at least one of these filters. location_id is always required, but does not satisfy the at-least-one-filter requirement on its own. Soft-deleted claims are excluded unless include_deleted is true.

get/claims

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • updated_at
  • -updated_at
patient_idinteger

The ID of the patient associated with the claim

guarantor_idinteger

The ID of the guarantor associated with the claim

provider_idinteger

The ID of the provider associated with the claim

updated_sincestring date-time

Claims updated at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned

date_of_servicestring date

Claims whose date of service exactly matches the specified date

include_deletedboolean

Include soft-deleted claims in the results

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": 10,
      "location_id": 1,
      "patient_id": 1002,
      "provider_id": 101,
      "guarantor_id": 1001,
      "status": "sent",
      "received_at": "2024-06-10T15:16:57.000Z",
      "sent_at": "2024-06-03T11:23:12.000Z",
      "note": "Claim was sent to the insurance company",
      "primary_insurance_plan_id": 10021,
      "secondary_insurance_plan_id": 10022,
      "date_of_service": "2024-06-03",
      "totals": {
        "amount_billed_to_insurance": {
          "amount": "62.00",
          "currency": "USD"
        },
        "estimated_insurance_payment": {
          "amount": "62.00",
          "currency": "USD"
        },
        "insurance_payment": {
          "amount": "62.00",
          "currency": "USD"
        },
        "write_off": {
          "amount": "62.00",
          "currency": "USD"
        }
      },
      "updated_at": "2020-06-05T20:16:57.007Z",
      "deleted_at": "2022-01-01T00:00:00Z"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}