Payment Reconciliation Profile¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-core-paymentreconciliation |
|---|---|
| Status | draft · 1.33.0 |
| Base | PaymentReconciliation (constraint) |
| Source | FSH · 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
Refund cheque
PaymentReconciliation/refund-cheque — claims conformance to Payment Reconciliation Profile
{
"resourceType": "PaymentReconciliation",
"id": "refund-cheque",
"meta": {
"profile": [
"https://fhir.apps.health/StructureDefinition/nexus-core-paymentreconciliation"
]
},
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>A refund of $30.00 by cheque on October 28, 2026, against one invoice held at the billing vendor, because the service was billed at the wrong fee. The amount is positive: the detail type <code>refund</code>, not the sign, says the money went back.</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": "CHCK",
"display": "Check"
}
]
}
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.enterer",
"valueReference": {
"reference": "Practitioner/dr-emil-navarro"
}
},
{
"url": "https://fhir.apps.health/StructureDefinition/nexus-payment-reason",
"valueString": "Billed at the wrong fee; difference returned."
}
],
"identifier": [
{
"system": "https://fhir.apps.health/NamingSystem/nexus-clinicaid-invoice-uuid",
"value": "3f6b2c1e-8a4d-4f0b-9c2e-5d7a1b9e4c60"
}
],
"status": "active",
"created": "2026-10-28T10:05:41Z",
"paymentDate": "2026-10-28",
"paymentAmount": {
"value": 30,
"currency": "CAD"
},
"paymentIdentifier": {
"value": "Cheque 1042"
},
"detail": [
{
"type": {
"coding": [
{
"system": "https://fhir.apps.health/CodeSystem/nexus-payment-type",
"code": "refund",
"display": "Refund"
}
]
},
"request": {
"identifier": {
"system": "https://fhir.apps.health/NamingSystem/nexus-clinicaid-invoice-uuid",
"value": "3f6b2c1e-8a4d-4f0b-9c2e-5d7a1b9e4c60"
}
},
"date": "2026-10-28",
"amount": {
"value": 30,
"currency": "CAD"
}
}
]
}