View insurance coverages
This endpoint returns a list of insurance coverages. All filters are optional: without any filters, every active insurance coverage for the institution is returned. Only active coverages are included by default; pass active=false to list inactive coverages instead.
Query parameters
Used to scope the request to the specified institution
First item of the current page. Starts empty
Last item of the current page. Starts empty
Number of results to return per page. Maximum allowed amount is 1000.
Insurance coverages updated at or after the specified time (UTC). The comparison is inclusive and matches when either the coverage or its subscription was updated since the given time
Filter for coverages of a specific patient. Responds with a 404 when no patient with this id exists
Filter active (true) or inactive (false) insurance coverages. Defaults to true, so inactive coverages are only returned when this is explicitly set to false
Headers
The NexHealth API version
Response
Successful
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
}
],
"page_info": {
"has_previous_page": false,
"has_next_page": false,
"start_cursor": "AAAAA",
"end_cursor": "BBBBBB"
}
}