Skip to content

Payment Reconciliation Profile

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-core-paymentreconciliation
Statusdraft · 1.33.0
BasePaymentReconciliation (constraint)
SourceFSH · JSON

Defines the Nexus EMR FHIR profile for a payment or refund taken at the clinic against private and third-party invoices raised at the billing vendor. One reconciliation per money event: a payment split across several invoices is one reconciliation with one detail per invoice. Invoices are named by the billing vendor's invoice identifier. Amounts are always positive; the detail type says whether money came in or went back. A reversal sets status to cancelled with a reason and keeps the record.

Examples

Payment split debit · Refund cheque

Payment split debit

PaymentReconciliation/payment-split-debit — claims conformance to Payment Reconciliation Profile

{
  "resourceType": "PaymentReconciliation",
  "id": "payment-split-debit",
  "meta": {
    "profile": [
      "https://fhir.apps.health/StructureDefinition/nexus-core-paymentreconciliation"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>A debit payment of $120.00 taken at the front desk on October 27, 2026, split across two invoices held at the billing vendor: $75.00 to the first and $45.00 to the second. One payment, one receipt, two allocations.</p></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.method",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0570",
            "code": "DEBC",
            "display": "Debit Card"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.enterer",
      "valueReference": {
        "reference": "Practitioner/dr-emil-navarro"
      }
    }
  ],
  "identifier": [
    {
      "system": "https://fhir.apps.health/NamingSystem/nexus-clinicaid-invoice-uuid",
      "value": "3f6b2c1e-8a4d-4f0b-9c2e-5d7a1b9e4c60"
    },
    {
      "system": "https://fhir.apps.health/NamingSystem/nexus-clinicaid-invoice-uuid",
      "value": "a91d7e42-0c3b-4e8f-b6a5-2f4c8d1e7b93"
    }
  ],
  "status": "active",
  "created": "2026-10-27T14:32:05Z",
  "paymentDate": "2026-10-27",
  "paymentAmount": {
    "value": 120,
    "currency": "CAD"
  },
  "paymentIdentifier": {
    "value": "TXN-004817"
  },
  "paymentIssuer": {
    "display": "Northwind Mutual Insurance"
  },
  "detail": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/payment-type",
            "code": "payment",
            "display": "Payment"
          }
        ]
      },
      "request": {
        "identifier": {
          "system": "https://fhir.apps.health/NamingSystem/nexus-clinicaid-invoice-uuid",
          "value": "3f6b2c1e-8a4d-4f0b-9c2e-5d7a1b9e4c60"
        }
      },
      "date": "2026-10-27",
      "amount": {
        "value": 75,
        "currency": "CAD"
      }
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/payment-type",
            "code": "payment",
            "display": "Payment"
          }
        ]
      },
      "request": {
        "identifier": {
          "system": "https://fhir.apps.health/NamingSystem/nexus-clinicaid-invoice-uuid",
          "value": "a91d7e42-0c3b-4e8f-b6a5-2f4c8d1e7b93"
        }
      },
      "date": "2026-10-27",
      "amount": {
        "value": 45,
        "currency": "CAD"
      }
    }
  ],
  "processNote": [
    {
      "type": "display",
      "text": "Paid for both visits at once."
    }
  ]
}