API Reference

Insurance Plans

This page has been frozen to prevent breaking changes. To test our most up to date ledger and insurance integration, please navigate to our beta version from the top navigation.

🚧

Supported Integrations

For now Insurance Plans are only supported for Open Dental, Eaglesoft, Dentrix Enterprise, and Dentrix.

The Insurance Plans resource allows you to see what insurance is available in a health record system. This gives you an idea of what insurances are accepted by a practice though it is worth noting some practices may input plans they do not accept into their EHR.

In the NexHealth Synchronizer API, patients have "insurance_coverages" which connect an insurance plan and patient together.

Insurance plans contain general information like group number, employer, and address of the insurance provider, whereas insurance coverages contain patient specific information like their subscriber number, the patient subscriber relationship, and the coverage's effective date.

Accessing Patient Coverages

To access a patient's coverage you can make requests to /patients/{id}/insurance_coverages or pass "include[]=insurance_coverages" as a query parameters to /patients or /patients/{id}.

Insurance Plans Response Object

{
  "code": false,
  "description": "Description",
  "error": [
    "Error"
  ],
  "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": 5,
      "foreign_id": "1"
    }
  ],
  "count": 2
}