PaymentReconciliation

Trial Use 4 Financial

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/PaymentReconciliation

Interaction	Method	Path
Read	`GET`	`/fhir/R5/PaymentReconciliation/[id]`
Vread	`GET`	`/fhir/R5/PaymentReconciliation/[id]/_history/[vid]`
Update	`PUT`	`/fhir/R5/PaymentReconciliation/[id]`
Patch	`PATCH`	`/fhir/R5/PaymentReconciliation/[id]`
Delete	`DELETE`	`/fhir/R5/PaymentReconciliation/[id]`
Create	`POST`	`/fhir/R5/PaymentReconciliation`
Search	`GET`	`/fhir/R5/PaymentReconciliation?...`
History	`GET`	`/fhir/R5/PaymentReconciliation/[id]/_history`
Type-history	`GET`	`/fhir/R5/PaymentReconciliation/_history`

Element	Type(s)	Cardinality	Description
`identifier`	`Identifier`	`0..*`	Business Identifier for a payment reconciliation
`type`	`CodeableConcept`	`1..1`	Category of payment
`status`	`code`	`1..1`	active
`kind`	`CodeableConcept`	`0..1`	Workflow originating payment
`period`	`Period`	`0..1`	Period covered
`created`	`dateTime`	`1..1`	Creation date
`enterer`	`Reference`	`0..1`	Who entered the payment
`issuerType`	`CodeableConcept`	`0..1`	Nature of the source
`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
`disposition`	`string`	`0..1`	Disposition message
`date`	`date`	`1..1`	When payment issued
`location`	`Reference`	`0..1`	Where payment collected
`method`	`CodeableConcept`	`0..1`	Payment instrument
`cardBrand`	`string`	`0..1`	Type of card
`accountNumber`	`string`	`0..1`	Digits for verification
`expirationDate`	`date`	`0..1`	Expiration year-month
`processor`	`string`	`0..1`	Processor name
`referenceNumber`	`string`	`0..1`	Check number or payment reference
`authorization`	`string`	`0..1`	Authorization number
`tenderedAmount`	`Money`	`0..1`	Amount offered by the issuer
`returnedAmount`	`Money`	`0..1`	Amount returned by the receiver
`amount`	`Money`	`1..1`	Total amount of Payment
`paymentIdentifier`	`Identifier`	`0..1`	Business identifier for the payment
`allocation`	`BackboneElement`	`0..*`	Settlement particulars
`formCode`	`CodeableConcept`	`0..1`	Printed form identifier
`processNote`	`BackboneElement`	`0..*`	Note concerning processing

Parameter	Type	Description
`allocation-account`	`reference`	The account to which payment or adjustment was applied.
`allocation-encounter`	`reference`	The encounter to which payment or adjustment was applied.
`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