# PaymentReconciliation

Canonical page: https://docs.ovok.com/api/fhir/r4/payment-reconciliation

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/PaymentReconciliation/[id]` |
| Vread | `GET` | `/fhir/R4/PaymentReconciliation/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/PaymentReconciliation/[id]` |
| Patch | `PATCH` | `/fhir/R4/PaymentReconciliation/[id]` |
| Delete | `DELETE` | `/fhir/R4/PaymentReconciliation/[id]` |
| Create | `POST` | `/fhir/R4/PaymentReconciliation` |
| Search | `GET` | `/fhir/R4/PaymentReconciliation` |
| History | `GET` | `/fhir/R4/PaymentReconciliation/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business Identifier for a payment reconciliation |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| cancelled \| draft \| entered-in-error |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | Period covered |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `1..1` | Creation date |
| <span id="element-payment-issuer"></span>`paymentIssuer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Party generating payment |
| <span id="element-request"></span>`request` | [Reference](/fhir-elements/complex/reference) | `0..1` | Reference to requesting resource |
| <span id="element-requestor"></span>`requestor` | [Reference](/fhir-elements/complex/reference) | `0..1` | Responsible practitioner |
| <span id="element-outcome"></span>`outcome` | [code](/fhir-elements/primitive/code) | `0..1` | queued \| complete \| error \| partial |
| <span id="element-disposition"></span>`disposition` | [string](/fhir-elements/primitive/string) | `0..1` | Disposition message |
| <span id="element-payment-date"></span>`paymentDate` | [date](/fhir-elements/primitive/date) | `1..1` | When payment issued |
| <span id="element-payment-amount"></span>`paymentAmount` | [Money](/fhir-elements/complex/money) | `1..1` | Total amount of Payment |
| <span id="element-payment-identifier"></span>`paymentIdentifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Business identifier for the payment |
| <span id="element-detail"></span>`detail` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Settlement particulars |
| <span id="element-form-code"></span>`formCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Printed form identifier |
| <span id="element-process-note"></span>`processNote` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Note concerning processing |

## Resource-specific search parameters [#resource-specific-search-parameters]

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

## Reference [#reference]

Official FHIR R4 spec: [PaymentReconciliation](https://hl7.org/fhir/R4/paymentreconciliation.html).  
Maturity: Trial Use 2 (FMM 2).
