NEnexhealth
Insurance

View insurance coverages (beta)

🚧 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 query param location_id; adds response fields data[].benefits_remaining, data[].benefits_remaining.amount, data[].benefits_remaining.currency, data[].subscriber (+4 more); changes response field data[].subscription_relation.

This endpoint returns insurance coverages for the specified location, optionally filtered by patient_id, updated_since, or active status (defaults to active only).

get/insurance_coverages

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/insurance_coverages
  • Auth
    API key in header Authorization

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

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.

updated_sincestring date-time

Insurance coverages updated after the specified time (UTC)

patient_idinteger

Filter by patient

activeboolean

Filter active/inactive insurance coverages

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": 18,
      "subscription_relation": "self",
      "patient_id": 25,
      "priority": 2,
      "plan_id": 18,
      "subscriber_num": "123456789",
      "effective_date": "2022-01-01",
      "expiration_date": "2022-12-31",
      "insurance_type": "dental",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "active": true,
      "subscriber": {
        "id": 415,
        "name": "John Smith",
        "date_of_birth": "1990-06-05",
        "postal_code": "20814"
      },
      "benefits_remaining": {
        "amount": "62.00",
        "currency": "USD"
      }
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

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