Charges

Before you start

NexHealth reads financial data from the health record system only on request. To turn it on for your API key, email [email protected]. Sandbox locations have it on.
Every request needs a bearer token from POST /authenticates. See Authentication.
Requests take the practice's subdomain and, for most endpoints, a location_id. See Institutions, syncs, and locations.

Overview

Charges are the completed procedures that the practice has recorded in the health record system. They include details like the procedure code, fees and estimated insurance payment. Each charge adds to a patient's balance.

📘
Charges vs. payments
Charges increase a patient's balance. Payments reduce it.

Example use cases

Add up adjustments, payments and charges to calculate a patient's balance and find which charges are unpaid. This is useful for an itemized patient bill.
Use charges and insurance coverage data to generate claims and simplify processing.

Charges response

{
  "code": true,
  "description": null,
  "error": null,
  "data": {
    "id": 113,
    "foreign_id": "1234-5678",
    "location_id": 10,
    "patient_id": 3,
    "guarantor_id": 5,
    "provider_id": 15,
    "updated_at": "2024-09-05T20:31:17.007Z",
    "description": "This is a description",
    "deleted_at": "2024-09-15T11:21:26.003Z",
    "fee": {
      "amount": "62.00",
      "currency": "USD"
    },
    "charged_at": "2024-10-05",
    "procedure_id": "NHP:JXZEQ1234",
    "claim_ids": [
      2222,
      3333
    ],
    "payment_estimate_total": {
      "amount": "62.00",
      "currency": "USD"
    },
    "write_off_estimate_total": {
      "amount": "62.00",
      "currency": "USD"
    },
    "write_off_total": {
      "amount": "62.00",
      "currency": "USD"
    },
    "patient": {
      ...
    },
    "provider": {
      ...
    },
    "guarantor": {
      ...
    },
    "procedure": {
      ...
    },
    "claims": [
      {
        ...
      }
    ]
  },
  "count": null
}