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 / Snapshot
The full effective definition: base PaymentReconciliation with this profile's constraints applied.
| 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 |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation i Invariants: ele-1 |
|
| contained | 0..* | Resource | Contained, inline Resources i | |
| 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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) 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 |
|
| value[x] | 0..1 | CodeableConcept | Payment instrument Binding: Payment Method Value Set ( extensible)e.g. CASH · DEBC · CCCA …Invariants: ele-1 |
|
| extension:enterer | S | 0..1 | Extension(extension-PaymentReconciliation.enterer) | Who keyed the payment i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) 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 |
|
| value[x] | 0..1 | Reference(Practitioner Profile | PractitionerRole Profile) | Who entered the payment Invariants: ele-1 |
|
| extension:reason | S | 0..1 | Extension(Payment Reason Extension) | Why it was reversed or refunded i Invariants: ele-1, ext-1 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored 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 |
| period | 0..1 | Period | Period covered 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 |
| request | 0..1 | Reference(Task) | Reference to requesting resource Invariants: ele-1 |
|
| requestor | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner i Invariants: ele-1 |
|
| outcome | 0..1 | code | queued | complete | error | partial i Binding: remittance-outcome ( required)Invariants: ele-1 |
|
| disposition | 0..1 | string | Disposition message 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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| identifier | 0..1 | Identifier | Business identifier of the payment detail Invariants: ele-1 |
|
| predecessor | 0..1 | Identifier | Business identifier of the prior payment detail 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 |
| submitter | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Submitter of the request Invariants: ele-1 |
|
| response | 0..1 | Reference(Resource) | Response committing to a payment Invariants: ele-1 |
|
| date | S | 0..1 | date | The day the money changed hands Invariants: ele-1 |
| responsible | 0..1 | Reference(PractitionerRole) | Contact for the response Invariants: ele-1 |
|
| payee | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Recipient of the payment Invariants: ele-1 |
|
| amount | S | 1..1 | Money | The amount allocated to this invoice, always positive Invariants: ele-1 |
| formCode | 0..1 | CodeableConcept | Printed form identifier i Binding: forms ( example)Invariants: ele-1 |
|
| processNote | S | 0..* | BackboneElement | The office's note on the payment Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| type | 0..1 | code | display | print | printoper Binding: note-type ( required)Invariants: ele-1 |
|
| text | 0..1 | string | Note explanatory text Invariants: ele-1 |