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.

Elements / Differential

What this profile constrains beyond PaymentReconciliation. Anything not listed is unchanged from the base; muted type/cardinality values are the base's, shown for context.

Element Flags Card. Type Description & Constraints
PaymentReconciliation Nexus EMR payment or refund against billing-vendor invoices i
Invariants: nexus-payment-detail-names-invoice, nexus-payment-invoices-indexed, nexus-payment-detail-kind, nexus-payment-one-direction, nexus-payment-amounts-positive, nexus-payment-reversal-has-reason, nexus-payment-refund-has-reason
extension 1..* Extension i
Slicing: value:url (open)
extension:method S 1..1 Extension(extension-PaymentReconciliation.method) How the money was paid: cash, debit, credit card, cheque, e-transfer, insurer EFT i
extension 0..0 Extension i
value[x] 0..1 CodeableConcept Binding: Payment Method Value Set (extensible)
e.g. CASH · DEBC · CCCA …
extension:enterer S 0..1 Extension(extension-PaymentReconciliation.enterer) Who keyed the payment i
extension 0..0 Extension i
value[x] 0..1 Reference(Practitioner Profile | PractitionerRole Profile)
extension:reason S 0..1 Extension(Payment Reason Extension) Why it was reversed or refunded i
identifier S 1..* Identifier The invoices this reconciliation touches, for search i
status S 1..1 code i
created S 1..1 dateTime When the payment was keyed
paymentIssuer S 0..1 Reference(Organization) Who paid i
requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) i
paymentDate S 1..1 date The day the money changed hands
paymentAmount S 1..1 Money The whole amount, always positive
value 1..1 decimal i
currency S 1..1 code
paymentIdentifier S 0..1 Identifier Cheque number, transaction or e-transfer reference i
detail S 1..* BackboneElement One allocation per invoice
type S 1..1 CodeableConcept payment | refund i
request S 1..1 Reference(Resource) The invoice, by its billing-vendor identifier
date S 0..1 date The day the money changed hands
amount S 1..1 Money The amount allocated to this invoice, always positive
processNote S 0..* BackboneElement The office's note on the payment