v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Insurance

View insurance coverage

This endpoint returns a single insurance coverage by its NexHealth id, including details of the subscriber who holds the coverage. Responds with a 404 when no coverage with this id exists for the institution.

get/insurance_coverages/{id}

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