PaymentReconciliation

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

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
identifier	Identifier	0..*	Business Identifier for a payment reconciliation
status	code	1..1	active | cancelled | draft | entered-in-error
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

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

Official FHIR R4 spec: PaymentReconciliation.
Maturity: Trial Use 2 (FMM 2).