NEnexhealth
Insurance

View insurance coverage (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 response fields data.benefits_remaining, data.benefits_remaining.amount, data.benefits_remaining.currency, data.subscriber.postal_code; changes response field data.subscription_relation.

get/insurance_coverages/{id}

Request

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

Path parameters

idinteger required

Insurance coverage ID

Query parameters

subdomainstring required

Used to scope the request to the specified institution

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.

countinteger

Number of total objects, in case of collection.

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"
    }
  },
  "count": 2
}

Changes

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