> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PaymentReconciliation

> This resource provides the details including amount of a payment and allocates the payment items being paid.

## Properties

| Name                | Required | Type                                                                                                                                                                                               | Description                                            |
| ------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| identifier          | No       | [Identifier](/medical-api/fhir/data-types/identifier)\[]                                                                                                                                           | Business Identifier for a payment reconciliation       |
| status              | Yes      | code                                                                                                                                                                                               | active / cancelled / draft / entered-in-error          |
| period              | No       | [Period](/medical-api/fhir/data-types/period)                                                                                                                                                      | Period covered                                         |
| created             | Yes      | dateTime                                                                                                                                                                                           | Creation date                                          |
| paymentIssuer       | No       | Reference\<[Organization](/medical-api/fhir/resources/organization)>                                                                                                                               | Party generating payment                               |
| request             | No       | Reference\<[Task](/medical-api/fhir/resources/task)>                                                                                                                                               | Reference to requesting resource                       |
| requestor           | No       | Reference\<[Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [Organization](/medical-api/fhir/resources/organization)> | Responsible practitioner                               |
| outcome             | No       | code                                                                                                                                                                                               | queued / complete / error / partial                    |
| disposition         | No       | string                                                                                                                                                                                             | Disposition message                                    |
| paymentDate         | Yes      | date                                                                                                                                                                                               | When payment issued                                    |
| paymentAmount       | Yes      | [Money](/medical-api/fhir/data-types/money)                                                                                                                                                        | Total amount of Payment                                |
| paymentIdentifier   | No       | [Identifier](/medical-api/fhir/data-types/identifier)                                                                                                                                              | Business identifier for the payment                    |
| detail              | No       | PaymentReconciliationDetail                                                                                                                                                                        | Settlement particulars                                 |
| - id                | No       | string                                                                                                                                                                                             | Unique id for inter-element referencing                |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                             | Additional content defined by implementations          |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                             | Extensions that cannot be ignored even if unrecognized |
| - identifier        | No       | [Identifier](/medical-api/fhir/data-types/identifier)                                                                                                                                              | Business identifier of the payment detail              |
| - predecessor       | No       | [Identifier](/medical-api/fhir/data-types/identifier)                                                                                                                                              | Business identifier of the prior payment detail        |
| - type              | Yes      | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                    | Category of payment                                    |
| - request           | No       | Reference\<Resource>                                                                                                                                                                               | Request giving rise to the payment                     |
| - submitter         | No       | Reference\<[Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [Organization](/medical-api/fhir/resources/organization)> | Submitter of the request                               |
| - response          | No       | Reference\<Resource>                                                                                                                                                                               | Response committing to a payment                       |
| - date              | No       | date                                                                                                                                                                                               | Date of commitment to pay                              |
| - responsible       | No       | Reference\<[PractitionerRole](/medical-api/fhir/resources/practitionerrole)>                                                                                                                       | Contact for the response                               |
| - payee             | No       | Reference\<[Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [Organization](/medical-api/fhir/resources/organization)> | Recipient of the payment                               |
| - amount            | No       | [Money](/medical-api/fhir/data-types/money)                                                                                                                                                        | Amount allocated to this payable                       |
| formCode            | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                    | Printed form identifier                                |
| processNote         | No       | PaymentReconciliationProcessNote                                                                                                                                                                   | Note concerning processing                             |
| - id                | No       | string                                                                                                                                                                                             | Unique id for inter-element referencing                |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                             | Additional content defined by implementations          |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                             | Extensions that cannot be ignored even if unrecognized |
| - type              | No       | code                                                                                                                                                                                               | display / print / printoper                            |
| - text              | No       | string                                                                                                                                                                                             | Note explanatory text                                  |

## Search Parameters

| Name           | Type      | Description                                           | Expression                          |
| -------------- | --------- | ----------------------------------------------------- | ----------------------------------- |
| created        | date      | The creation date                                     | PaymentReconciliation.created       |
| disposition    | string    | The contents of the disposition message               | PaymentReconciliation.disposition   |
| identifier     | token     | The business identifier of the ExplanationOfBenefit   | PaymentReconciliation.identifier    |
| outcome        | token     | The processing outcome                                | PaymentReconciliation.outcome       |
| payment-issuer | reference | The organization which generated this resource        | PaymentReconciliation.paymentIssuer |
| request        | reference | The reference to the claim                            | PaymentReconciliation.request       |
| requestor      | reference | The reference to the provider who submitted the claim | PaymentReconciliation.requestor     |
| status         | token     | The status of the payment reconciliation              | PaymentReconciliation.status        |

## Inherited Properties

| Name              | Required | Type                                                   | Description                                            |
| ----------------- | -------- | ------------------------------------------------------ | ------------------------------------------------------ |
| id                | No       | string                                                 | Logical id of this artifact                            |
| meta              | No       | [Meta](/medical-api/fhir/data-types/meta)              | Metadata about the resource                            |
| implicitRules     | No       | uri                                                    | A set of rules under which this content was created    |
| language          | No       | code                                                   | Language of the resource content                       |
| text              | No       | [Narrative](/medical-api/fhir/data-types/narrative)    | Text summary of the resource, for human interpretation |
| contained         | No       | Resource\[]                                            | Contained, inline Resources                            |
| extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations          |
| modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored                      |

To view the FHIR specification for this resource, see [PaymentReconciliation](https://www.hl7.org/fhir/StructureDefinition/PaymentReconciliation).
