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.
Elements / Key elements
The working view: must-support, required, modifier and sliced elements from the effective (snapshot) definition.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentReconciliation | 0..* | Nexus EMR payment or refund against billing-vendor invoices i Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, 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 |
||
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| extension | 1..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:method | S | 1..1 | Extension(extension-PaymentReconciliation.method) | How the money was paid: cash, debit, credit card, cheque, e-transfer, insurer EFT i Invariants: ele-1, ext-1 |
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.method |
|
| extension:enterer | S | 0..1 | Extension(extension-PaymentReconciliation.enterer) | Who keyed the payment i Invariants: ele-1, ext-1 |
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.enterer |
|
| extension:reason | S | 0..1 | Extension(Payment Reason Extension) | Why it was reversed or refunded i Invariants: ele-1, ext-1 |
| identifier | S | 1..* | Identifier | The invoices this reconciliation touches, for search i Invariants: ele-1 |
| status | S ?! | 1..1 | code | active | cancelled | draft | entered-in-error i Binding: fm-status ( required)Invariants: ele-1 |
| created | S | 1..1 | dateTime | When the payment was keyed Invariants: ele-1 |
| paymentIssuer | S | 0..1 | Reference(Organization) | Who paid i Invariants: ele-1 |
| paymentDate | S | 1..1 | date | The day the money changed hands Invariants: ele-1 |
| paymentAmount | S | 1..1 | Money | The whole amount, always positive Invariants: ele-1 |
| value | 1..1 | decimal | Numerical value (with implicit precision) i Invariants: ele-1 |
|
| currency | S | 1..1 | code | ISO 4217 Currency Code Binding: currencies ( required)Invariants: ele-1 |
| paymentIdentifier | S | 0..1 | Identifier | Cheque number, transaction or e-transfer reference i Invariants: ele-1 |
| detail | S | 1..* | BackboneElement | One allocation per invoice Invariants: ele-1 |
| type | S | 1..1 | CodeableConcept | payment | refund i Binding: payment-type ( example)Invariants: ele-1 |
| request | S | 1..1 | Reference(Resource) | The invoice, by its billing-vendor identifier Invariants: ele-1 |
| date | S | 0..1 | date | The day the money changed hands Invariants: ele-1 |
| amount | S | 1..1 | Money | The amount allocated to this invoice, always positive Invariants: ele-1 |
| processNote | S | 0..* | BackboneElement | The office's note on the payment Invariants: ele-1 |