Insurance
View insurance plan
This endpoint returns a single insurance plan by its NexHealth id. Use the include parameter to embed related resources: patient_coverages, subscribers and/or fee_schedule. Responds with a 404 when no plan with the given id exists for the institution.
get/insurance_plans/{id}
Path parameters
idinteger required
Id of the insurance plan
Query parameters
subdomainstring required
Used to scope the request to the specified institution
include[]string[]
Resources to be included in the response
Headers
Nex-Api-Versionstring required
The NexHealth API version
Response
Successful
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"
}
},
"count": 2
}