Charges

Financial data is only read from the EHR on request. To start using these endpoints, email [email protected].

Overview

Charges represent completed procedures recorded in the health record system. They include details like the procedure code, fees, and estimated insurance payment. Each charge contributes to a patient’s balance.

📘
Charges vs. Payments
Charges increase a patient’s balance, while payments reduce it.

Example use cases

Sum together adjustments, payments, and charges to calculate a patient’s balance and determine which charges are unpaid. This is useful for creating an itemized patient bill.
Use charges and insurance coverage data to generate claims and simplify processing.

Charges response

{
  "code": false,
  "description": "Description",
  "error": "Error",
  "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": 2
}