This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Financial
Management
Work
Group
|
Normative
|
|
Compartments : Practitioner |
Detailed Descriptions for the elements in the PaymentReconciliation resource.
| PaymentReconciliation | |
|
| PaymentReconciliation |
| Definition |
This
resource
provides
|
| Short Display | PaymentReconciliation resource |
|
|
0..* |
|
| DomainResource |
| Summary | false |
| PaymentReconciliation.identifier | |
|
| PaymentReconciliation.identifier |
| Definition |
|
|
|
Business Identifier for a payment reconciliation |
| Note |
This
is
a
business
|
|
|
0..* |
| Type | Identifier |
| Requirements | Allows payment reconciliations to be distinguished and referenced. |
| Summary | false |
| PaymentReconciliation.type | |
| Element Id | PaymentReconciliation.type |
| Definition | Code to indicate the nature of the payment such as payment, adjustment. |
| Short Display | Category of payment |
| Cardinality | 1..1 |
| Terminology Binding | Payment Type Codes ( Extensible ) |
| Type | CodeableConcept |
| Summary | true |
| PaymentReconciliation.status | |
|
| PaymentReconciliation.status |
| Definition |
The status of the resource instance. |
| Short Display | active | cancelled | draft | entered-in-error |
| Cardinality |
|
| Terminology Binding | Financial Resource Status Codes ( Required ) |
| Type | code |
| Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
| Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. |
| Summary | true |
| Comments |
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| PaymentReconciliation.statusReason | |
| Element Id | PaymentReconciliation.statusReason |
| Definition | Used to indicate why the status has changed. |
| Short Display | Reason for status change |
| Cardinality | 0..1 |
| Type | string |
| Requirements | This is used to implement conformance on other elements. |
| Summary | true |
| Comments | Implementation guides may consider adding invariants such that if status = cancelled, statusReason SHALL be supplied. |
| PaymentReconciliation.kind | |
| Element Id | PaymentReconciliation.kind |
| Definition | The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc. |
| Short Display | Workflow originating payment |
| Cardinality | 0..1 |
| Terminology Binding | Payment Kind ( Extensible ) |
| Type | CodeableConcept |
| Summary | false |
| PaymentReconciliation.period | |
|
| PaymentReconciliation.period |
| Definition |
The period of time for which payments have been gathered into this bulk payment for settlement. |
| Short Display | Period covered |
| Cardinality | 0..1 |
| Type | Period |
| Requirements | Needed to allow receivers to monitor and reconcile payment issuer schedules. |
| Summary | true |
| PaymentReconciliation.created | |
|
| PaymentReconciliation.created |
| Definition |
The
date
when
the
|
| Short Display | Creation date |
| Cardinality | 1..1 |
| Type | dateTime |
| Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
| Summary | true |
| PaymentReconciliation.enterer | |
| Element Id | PaymentReconciliation.enterer |
| Definition | Payment enterer if not the actual payment issuer. |
| Short Display | Who entered the payment |
| Cardinality | 0..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization ) |
|
|
false |
|
|
|
| Element Id | PaymentReconciliation.issuerType |
| Definition |
The type of the source such as patient or insurance. |
| Short Display | Nature of the source |
| Cardinality | 0..1 |
| Terminology Binding | Payment Issuer Type ( Extensible ) |
| Type | CodeableConcept |
| Requirements | Providers may need to identify the source to know to which sub-ledger to apply the payment. |
| Summary | false |
| PaymentReconciliation.paymentIssuer | |
| Element Id | PaymentReconciliation.paymentIssuer |
| Definition |
The
|
| Short Display | Party generating payment |
| Cardinality | 0..1 |
| Type | Reference ( Organization | Patient | RelatedPerson ) |
| Requirements | Need to identify the party resonsible for the payment and this resource. |
| Summary | true |
| Comments | This party is also responsible for the reconciliation. |
| PaymentReconciliation.request | |
|
| PaymentReconciliation.request |
| Definition |
Original request resource reference. |
| Short Display | Reference to requesting resource |
| Cardinality | 0..1 |
| Type | Reference ( Task ) |
| Requirements | Needed to allow the response to be linked to the request. |
| Summary | false |
| PaymentReconciliation.requestor | |
| Element Id | PaymentReconciliation.requestor |
| Definition | The practitioner who is responsible for the services rendered to the patient. |
| Short Display | Responsible practitioner |
| Cardinality | 0..1 |
| Type |
Reference
(
|
| Requirements | Need to identify the party responsible for the request. |
| Summary | false |
| PaymentReconciliation.outcome | |
|
| PaymentReconciliation.outcome |
| Definition |
|
| Short Display | queued | complete | error | partial |
| Cardinality | 0..1 |
| Terminology Binding |
|
| Type | code |
| Requirements |
To advise the requestor of an overall processing outcome. |
| Summary | false |
| Comments | The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). |
| PaymentReconciliation.disposition | |
|
|
PaymentReconciliation.disposition |
| Definition |
A
human
readable
description
of
the
status
of
the
|
| Short Display | Disposition message |
|
|
0..1 |
| Type | string |
| Requirements |
Provided for user display. |
| Summary | false |
|
|
|
|
|
PaymentReconciliation.date |
| Definition |
The
|
| Short Display | When payment issued |
| Cardinality | 1..1 |
| Type | date |
| Requirements |
To
advise
the
|
|
|
true |
| PaymentReconciliation.location | |
| Element Id | PaymentReconciliation.location |
| Definition | The location of the site or device for electronic transfers or physical location for cash payments. |
| Short Display | Where payment collected |
| Cardinality | 0..1 |
| Type |
Reference
(
|
| Summary | false |
|
|
|
| Element Id | PaymentReconciliation.method |
| Definition |
The means of payment such as check, card cash, or electronic funds transfer. |
| Short Display | Payment instrument |
| Cardinality | 0..1 |
| Terminology Binding |
hl7VS-paymentMethodCode
(
Extensible
)
|
| Type | CodeableConcept |
| Summary | false |
| PaymentReconciliation.cardBrand | |
| Element Id | PaymentReconciliation.cardBrand |
| Definition |
The
|
| Short Display | Type of card |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| PaymentReconciliation.accountNumber | |
| Element Id | PaymentReconciliation.accountNumber |
| Definition | A portion of the account number, often the last 4 digits, used for verification not charging purposes. |
| Short Display | Digits for verification |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| PaymentReconciliation.expirationDate | |
| Element Id | PaymentReconciliation.expirationDate |
| Definition | The year and month (YYYY-MM) when the instrument, typically card, expires. |
| Short Display | Expiration year-month |
| Cardinality | 0..1 |
| Type | date |
| Summary | false |
| PaymentReconciliation.processor | |
| Element Id | PaymentReconciliation.processor |
| Definition | The name of the card processor, etf processor, bank for checks. |
| Short Display | Processor name |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| PaymentReconciliation.referenceNumber | |
| Element Id | PaymentReconciliation.referenceNumber |
| Definition | The check number, eft reference, car processor reference. |
| Short Display | Check number or payment reference |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| PaymentReconciliation.authorization | |
| Element Id | PaymentReconciliation.authorization |
| Definition | An alphanumeric issued by the processor to confirm the successful issuance of payment. |
| Short Display | Authorization number |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| PaymentReconciliation.tenderedAmount | |
| Element Id | PaymentReconciliation.tenderedAmount |
| Definition | The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid. |
| Short Display | Amount offered by the issuer |
| Cardinality | 0..1 |
| Type | Money |
| Summary | false |
| PaymentReconciliation.returnedAmount | |
| Element Id | PaymentReconciliation.returnedAmount |
| Definition |
The
amount
returned
by
the
receiver
which
is
|
| Short Display | Amount returned by the receiver |
| Cardinality | 0..1 |
| Type | Money |
| Summary | false |
| Comments | For profiles where the intention is to support actual payment advice then the cardinality must be set to 1..1. |
| PaymentReconciliation.amount | |
| Element Id | PaymentReconciliation.amount |
| Definition | Total payment amount as indicated on the financial instrument. |
| Short Display | Total amount of Payment |
| Cardinality | 0..1 |
| Type | Money |
| Requirements | Needed to provide the actual payment amount. |
| Summary | true |
| PaymentReconciliation.paymentIdentifier | |
| Element Id | PaymentReconciliation.paymentIdentifier |
| Definition |
Issuer's
unique
identifier
for
the
|
| Short Display | Business identifier for the payment |
| Cardinality | 0..1 |
| Type | Identifier |
| Requirements | Enable the receiver to reconcile when payment is received. |
| Summary | false |
| Comments | For example: EFT number or check number. |
| PaymentReconciliation.allocation | |
| Element Id | PaymentReconciliation.allocation |
| Definition |
Distribution
of
the
|
| Short Display | Settlement particulars |
| Cardinality | 0..* |
| Requirements | Needed to show how the payment amount is distributed across the payables. |
| Summary | false |
|
PaymentReconciliation.allocation.identifier
|
|
| Element Id | PaymentReconciliation.allocation.identifier |
| Definition | Unique identifier for the current payment item for the referenced payable. |
| Short Display | Business identifier of the payment detail |
| Note | This is a business identifier, not a resource identifier (see discussion ) |
| Cardinality | 0..1 |
| Type | Identifier |
| Requirements | Needed for reconciliation of payments. |
| Summary | false |
| PaymentReconciliation.allocation.predecessor | |
| Element Id | PaymentReconciliation.allocation.predecessor |
| Definition | Unique identifier for the prior payment item for the referenced payable. |
| Short Display | Business identifier of the prior payment detail |
| Cardinality | 0..1 |
| Type | Identifier |
| Requirements | Needed for reconciliation of payments. |
| Summary | false |
| PaymentReconciliation.allocation.target | |
| Element Id | PaymentReconciliation.allocation.target |
| Definition | Specific resource to which the payment/adjustment/advance applies. |
| Short Display | Subject of the payment |
| Cardinality | 0..1 |
| Type |
Reference
(
|
| Summary | false |
|
|
|
|
| PaymentReconciliation.allocation.targetItem[x] |
| Definition |
|
| Short Display |
Sub-element
of
|
| Cardinality | 0..1 |
| Type | string | Identifier | positiveInt |
| [x] Note | See Choice of Datatypes for further information about how to use [x] |
| Summary | false |
| PaymentReconciliation.allocation.encounter | |
| Element Id | PaymentReconciliation.allocation.encounter |
| Definition | The Encounter to which this payment applies, may be completed by the receiver, used for search. |
| Short Display | Applied-to encounter |
| Cardinality | 0..1 |
|
| Reference ( Encounter ) |
| Summary | false |
|
|
|
| Element Id | PaymentReconciliation.allocation.account |
| Definition |
The Account to which this payment applies, may be completed by the receiver, used for search. |
| Short Display | Applied-to account |
| Cardinality | 0..1 |
| Type | Reference ( Account ) |
| Summary | false |
| PaymentReconciliation.allocation.type | |
| Element Id | PaymentReconciliation.allocation.type |
| Definition |
Code
to
indicate
the
nature
of
the
|
| Short Display | Category of payment |
| Cardinality |
|
| Terminology Binding |
Payment
Type
Codes
(
|
| Type | CodeableConcept |
| Requirements |
Needed to provide context for the amount. |
| Summary | false |
| Comments | For example: payment, adjustment, funds advance, etc. |
|
|
|
|
|
PaymentReconciliation.allocation.submitter |
| Definition |
The
party
which
submitted
the
claim
or
financial
|
| Short Display | Submitter of the request |
| Cardinality | 0..1 |
| Type |
Reference
(
|
| Requirements |
Needed for audit and validation. |
| Summary | false |
|
|
|
|
|
PaymentReconciliation.allocation.response |
| Definition |
|
| Short Display | Response committing to a payment |
| Cardinality | 0..1 |
| Type |
Reference
(
|
| Requirements |
Needed to provide a linkage to the payment commitment. |
| Summary | false |
|
|
|
|
|
PaymentReconciliation.allocation.date |
| Definition |
The
|
| Short Display | Date of commitment to pay |
|
|
0..1 |
| Type | date |
| Requirements | Needed for audit and validation. |
| Summary | false |
| PaymentReconciliation.allocation.responsible | |
| Element Id | PaymentReconciliation.allocation.responsible |
| Definition | A reference to the individual who is responsible for inquiries regarding the response and its payment. |
| Short Display | Contact for the response |
| Cardinality | 0..1 |
| Type |
Reference
(
|
| Requirements |
To provide contact information. |
| Summary | false |
|
|
|
|
| PaymentReconciliation.allocation.payee |
| Definition |
The
|
| Short Display | Recipient of the payment |
| Cardinality | 0..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization ) |
| Requirements |
Needed for audit and validation. |
| Summary | false |
|
|
|
|
|
PaymentReconciliation.allocation.amount |
| Definition |
The
|
| Short Display | Amount allocated to this payable |
|
|
0..1 |
| Type | Money |
| Requirements |
Needed to explain the distribution of the payment to the payables. |
| Summary | false |
|
|
|
|
| PaymentReconciliation.allocation.noteNumber |
| Definition |
|
| Short Display | Applicable note numbers |
| Cardinality |
|
| Type | positiveInt |
| Requirements |
Provides a condensed manner for associating human readable descriptive explanations on the allocation item. |
| Summary | false |
|
|
|
|
|
PaymentReconciliation.formCode |
| Definition |
|
| Short Display | Printed form identifier |
| Cardinality | 0..1 |
| Terminology Binding | Form Codes ( Example ) |
| Type | CodeableConcept |
| Requirements |
Needed to specify the specific form used for producing output for this response. |
| Summary | false |
| Comments | May be needed to identify specific jurisdictional forms. |
|
|
|
| Element Id | PaymentReconciliation.processNote |
| Definition |
A note that describes or explains the processing in a human readable form. |
| Short Display | Note concerning processing |
| Cardinality | 0..* |
| Requirements |
|
|
|
false |
| PaymentReconciliation.processNote.class | |
| Element Id | PaymentReconciliation.processNote.class |
| Definition | A code to indicate the business purpose of the note. |
| Short Display | Business kind of note |
| Cardinality | 0..1 |
| Terminology Binding | ProcessNoteClass : |
| Type | CodeableConcept |
| Requirements |
Process Notes may encompass a significant number of kinds of notes. These could be disclaimers (particularly useful for predetermination), a statement about adjudication, a conditional statement, or others. |
| Summary | false |
|
|
|
|
| PaymentReconciliation.processNote.number |
| Definition |
|
| Short Display | Note instance identifier |
| Cardinality | 0..1 |
|
| positiveInt |
| Requirements | Necessary to provide a mechanism to link from allocations. |
| Summary | false |
| PaymentReconciliation.processNote.type | |
|
|
PaymentReconciliation.processNote.type |
| Definition |
The
business
purpose
of
the
note
|
| Short Display | display | print | printoper |
|
|
0..1 |
| Terminology Binding | NoteType ( Required ) |
| Type | code |
| Requirements |
To convey the expectation for when the text is used. |
| Summary | false |
| PaymentReconciliation.processNote.text | |
|
| PaymentReconciliation.processNote.text |
| Definition |
The
|
| Short Display | Note explanatory text |
| Cardinality | 0..1 |
| Type | markdown |
| Requirements |
Required to provide human readable explanation. |
| Summary | false |