NEnexhealth
Insurance

View insurance plans (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[].annual_max_individual, data[].annual_max_individual.amount, data[].annual_max_individual.currency, data[].benefit_year_renewal_month (+19 more).

This endpoint returns insurance plans for the specified location, optionally filtered by payer_id, group_num, or updated_since.

get/insurance_plans

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/insurance_plans
  • 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.

sortstring

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

Available fields:

  • updated_at
  • -updated_at
updated_sincestring date-time

Insurance plans updated after the specified time (UTC)

payer_idstring

A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically

group_numstring

Group number

include_deletedboolean

Include deleted insurance plans

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,
      "payer_id": "87726",
      "name": "United Healthcare",
      "address": "123 Law St",
      "address2": "85335, North East",
      "city": "New York",
      "state": "NY",
      "zip_code": "54700",
      "country_code": "US",
      "group_num": "12345",
      "employer_name": "Walmart",
      "foreign_id": "1",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "deleted_at": "2024-09-15T11:21:26.003Z",
      "patient_coverages": [
        {
          "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"
        }
      ],
      "subscribers": [
        {
          "id": 415,
          "name": "John Smith",
          "date_of_birth": "1990-06-05"
        }
      ],
      "fee_schedule": {
        "id": 113,
        "name": "Cash",
        "active": true,
        "location_id": 21,
        "updated_at": "2020-06-05T20:16:57.007Z"
      },
      "annual_max_individual": {
        "amount": "62.00",
        "currency": "USD"
      },
      "benefit_year_renewal_month": 1
    }
  ],
  "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.