FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R4 R3 R2

Financial Management Work Group Maturity Level : 2   Trial Use Security Category : Patient Compartments : Practitioner

Detailed Descriptions for the elements in the PaymentReconciliation resource.

PaymentReconciliation.total
PaymentReconciliation
Element Id PaymentReconciliation
Definition

This resource provides payment the details and claim references supporting including amount of a bulk payment. payment and allocates the payment items being paid.

Control Cardinality 1..1 0..*
Type DomainResource
PaymentReconciliation.identifier
Element Id PaymentReconciliation.identifier
Definition

The Response business identifier. A unique identifier assigned to this payment reconciliation.

Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Requirements

Allows payment reconciliations to be distinguished and referenced.

PaymentReconciliation.status
Element Id PaymentReconciliation.status
Definition

The status of the resource instance.

Control Cardinality 0..1 1..1
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.period
Element Id PaymentReconciliation.period
Definition

The period of time for which payments have been gathered into this bulk payment for settlement.

Control Cardinality 0..1
Type Period
Requirements

Needed to allow receivers to monitor and reconcile payment issuer schedules.

Summary true
PaymentReconciliation.created
Element Id PaymentReconciliation.created
Definition

The date when the enclosed suite of services were performed or completed. resource was created.

Control Cardinality 0..1 1..1
Type dateTime
Requirements

Need to record a timestamp for use by both the recipient and the issuer.

Summary true
PaymentReconciliation.organization PaymentReconciliation.paymentIssuer
Element Id PaymentReconciliation.paymentIssuer
Definition

The Insurer party who produced this adjudicated response. generated the payment.

Control Cardinality 0..1
Type Reference ( Organization )
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
Element Id PaymentReconciliation.request
Definition

Original request resource reference.

Control Cardinality 0..1
Type Reference ( ProcessRequest Task )
Requirements

Needed to allow the response to be linked to the request.

PaymentReconciliation.requestor
Element Id PaymentReconciliation.requestor
Definition

The practitioner who is responsible for the services rendered to the patient.

Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization )
Requirements

Need to identify the party responsible for the request.

PaymentReconciliation.outcome
Element Id PaymentReconciliation.outcome
Definition

Transaction status: error, complete. The outcome of a request for a reconciliation.

Control Cardinality 0..1
Terminology Binding RemittanceOutcome ( Required )
Type CodeableConcept code
Requirements

To advise the requestor of an overall processing outcome.

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
Element Id PaymentReconciliation.disposition
Definition

A human readable description of the status of the adjudication. request for the reconciliation.

Control Cardinality 0..1
Type string
Requirements

Provided for user display.

PaymentReconciliation.requestProvider PaymentReconciliation.paymentDate
Element Id PaymentReconciliation.paymentDate
Definition

The practitioner who is responsible for the services rendered to date of payment as indicated on the patient. financial instrument.

Control Cardinality 0..1 1..1
Type Reference date ( Practitioner
Requirements

To advise the payee when payment can be expected.

Summary ) true
PaymentReconciliation.requestOrganization PaymentReconciliation.paymentAmount
Element Id PaymentReconciliation.paymentAmount
Definition

The organization which is responsible for Total payment amount as indicated on the services rendered financial instrument.

Cardinality 1..1
Type Money
Requirements

Needed to provide the patient. actual payment amount.

Control Summary true
PaymentReconciliation.paymentIdentifier
Element Id PaymentReconciliation.paymentIdentifier
Definition

Issuer's unique identifier for the payment instrument.

Cardinality 0..1
Type Reference ( Organization Identifier )
Requirements

Enable the receiver to reconcile when payment is received.

Comments

For example: EFT number or check number.

PaymentReconciliation.detail
Element Id PaymentReconciliation.detail
Definition

List Distribution of individual settlement amounts and the corresponding transaction. payment amount for a previously acknowledged payable.

Control Cardinality 0..*
Requirements

Needed to show how the payment amount is distributed across the payables.

PaymentReconciliation.detail.identifier
Element Id PaymentReconciliation.detail.identifier
Definition

Unique identifier for the current payment item for the referenced payable.

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..1
Type Identifier
Requirements

Needed for reconciliation of payments.

PaymentReconciliation.detail.predecessor
Element Id PaymentReconciliation.detail.predecessor
Definition

Unique identifier for the prior payment item for the referenced payable.

Cardinality 0..1
Type Identifier
Requirements

Needed for reconciliation of payments.

PaymentReconciliation.detail.type
Element Id PaymentReconciliation.detail.type
Definition

Code to indicate the nature of the payment, adjustment, funds advance, etc. payment.

Control Cardinality 1..1
Terminology Binding Payment Type Codes ( Example )
Type CodeableConcept
Requirements

Needed to provide context for the amount.

Comments

For example: payment, adjustment, funds advance, etc.

PaymentReconciliation.detail.request
Element Id PaymentReconciliation.detail.request
Definition

The claim or financial resource. A resource, such as a Claim, the evaluation of which could lead to payment.

Control Cardinality 0..1
Type Reference ( Any )
Requirements

Needed to provide a linkage to the original request.

PaymentReconciliation.detail.response PaymentReconciliation.detail.submitter
Element Id PaymentReconciliation.detail.submitter
Definition

The party which submitted the claim response resource. or financial transaction.

Control Cardinality 0..1
Type Reference ( Any Practitioner | PractitionerRole | Organization )
Requirements

Needed for audit and validation.

PaymentReconciliation.detail.submitter PaymentReconciliation.detail.response
Element Id PaymentReconciliation.detail.response
Definition

The Organization A resource, such as a ClaimResponse, which submitted the claim or financial transaction. contains a commitment to payment.

Control Cardinality 0..1
Type Reference ( Organization Any )
Requirements

Needed to provide a linkage to the payment commitment.

PaymentReconciliation.detail.payee PaymentReconciliation.detail.date
Element Id PaymentReconciliation.detail.date
Definition

The organization which date from the response resource containing a commitment to pay.

Cardinality 0..1
Type date
Requirements

Needed for audit and validation.

PaymentReconciliation.detail.responsible
Element Id PaymentReconciliation.detail.responsible
Definition

A reference to the individual who is receiving responsible for inquiries regarding the response and its payment.

Control Cardinality 0..1
Type Reference ( Organization PractitionerRole )
Requirements

To provide contact information.

PaymentReconciliation.detail.date PaymentReconciliation.detail.payee
Element Id PaymentReconciliation.detail.payee
Definition

The date of party which is receiving the invoice or financial resource. payment.

Control Cardinality 0..1
Type date Reference ( Practitioner | PractitionerRole | Organization )
Requirements

Needed for audit and validation.

PaymentReconciliation.detail.amount
Element Id PaymentReconciliation.detail.amount
Definition

Amount paid for this detail. The monetary amount allocated from the total payment to the payable.

Control Cardinality 0..1
Type Money
Requirements

Needed to explain the distribution of the payment to the payables.

PaymentReconciliation.form PaymentReconciliation.formCode
Element Id PaymentReconciliation.formCode
Definition

The A code for the form to be used for printing the content.

Control Cardinality 0..1
Terminology Binding Form Codes Forms ( Example )
Type CodeableConcept
Requirements

Needed to specify the specific form used for producing output for this response.

Definition Comments

Total payment amount. May be needed to identify specific jurisdictional forms.

Control PaymentReconciliation.processNote 0..1
Type Element Id Money PaymentReconciliation.processNote
Definition

Suite of notes. A note that describes or explains the processing in a human readable form.

Control Cardinality 0..*
Requirements

Provides the specific textual explanations associated with the processing.

PaymentReconciliation.processNote.type
Element Id PaymentReconciliation.processNote.type
Definition

The business purpose of the note purpose: Print/Display. text.

Control Cardinality 0..1
Terminology Binding NoteType ( Required )
Type CodeableConcept code
Requirements

To convey the expectation for when the text is used.

PaymentReconciliation.processNote.text
Element Id PaymentReconciliation.processNote.text
Definition

The note text. explanation or description associated with the processing.

Control Cardinality 0..1
Type string
Requirements

Required to provide human readable explanation.