PaymentReconciliation
This resource provides the details including amount of a payment and allocates the payment items being paid.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/PaymentReconciliation| 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
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Business Identifier for a payment reconciliation |
status | code | 1..1 | active | cancelled | draft | entered-in-error modifier |
period | Period | 0..1 | Period covered |
created | dateTime | 1..1 | Creation date |
paymentIssuer | Reference | 0..1 | Party generating payment |
request | Reference | 0..1 | Reference to requesting resource |
requestor | Reference | 0..1 | Responsible practitioner |
outcome | code | 0..1 | queued | complete | error | partial |
disposition | string | 0..1 | Disposition message |
paymentDate | date | 1..1 | When payment issued |
paymentAmount | Money | 1..1 | Total amount of Payment |
paymentIdentifier | Identifier | 0..1 | Business identifier for the payment |
detail | BackboneElement | 0..* | Settlement particulars |
formCode | CodeableConcept | 0..1 | Printed form identifier |
processNote | BackboneElement | 0..* | Note concerning processing |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
PaymentReconciliation - Maturity: Trial Use 2 (FMM 2).