Skip to main content

PaymentReconciliation

This resource provides the details including amount of a payment and allocates the payment items being paid. If the element is present, it must have either a @value, an @id, or extensions

type PaymentReconciliation implements Resource {
  identifier: [Identifier]
  status: String
  period: Period
  created: Date
  paymentIssuer: Reference
  request: Reference
  requestor: Reference
  outcome: String
  disposition: String
  paymentDate: Date
  paymentAmount: Money
  paymentIdentifier: Identifier
  detail: [PaymentReconciliationDetail]
  formCode: CodeableConcept
  processNote: [PaymentReconciliationProcessNote]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

PaymentReconciliation.identifier ● [Identifier] list object​

A unique identifier assigned to this payment reconciliation.

PaymentReconciliation.status ● String scalar​

The status of the resource instance.

PaymentReconciliation.period ● Period object​

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

PaymentReconciliation.created ● Date scalar​

The date when the resource was created.

PaymentReconciliation.paymentIssuer ● Reference object​

The party who generated the payment.

PaymentReconciliation.request ● Reference object​

Original request resource reference.

PaymentReconciliation.requestor ● Reference object​

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

PaymentReconciliation.outcome ● String scalar​

The outcome of a request for a reconciliation.

PaymentReconciliation.disposition ● String scalar​

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

PaymentReconciliation.paymentDate ● Date scalar​

The date of payment as indicated on the financial instrument.

PaymentReconciliation.paymentAmount ● Money object​

Total payment amount as indicated on the financial instrument.

PaymentReconciliation.paymentIdentifier ● Identifier object​

Issuer s unique identifier for the payment instrument.

PaymentReconciliation.detail ● [PaymentReconciliationDetail] list object​

Distribution of the payment amount for a previously acknowledged payable.

PaymentReconciliation.formCode ● CodeableConcept object​

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

PaymentReconciliation.processNote ● [PaymentReconciliationProcessNote] list object​

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

PaymentReconciliation.text ● Narrative object​

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

PaymentReconciliation.contained ● [Resource] list interface​

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

PaymentReconciliation.extension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

PaymentReconciliation.modifierExtension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

PaymentReconciliation.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

PaymentReconciliation.meta ● Meta object​

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

PaymentReconciliation.implicitRules ● Uri scalar​

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

PaymentReconciliation.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

PaymentReconciliation query ● PaymentReconciliationCreate mutation ● PaymentReconciliationList query ● PaymentReconciliationUpdate mutation