PaymentReconciliation

ResourceFinancial · PaymentTrial useMaturity 2

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

8 of 8 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifier	0..*	Identifier	Business Identifier for a payment reconciliation
statusRequired?!Σ	1..1	code	active | cancelled | draft | entered-in-errorBinding (required): fm-status
periodΣ	0..1	Period	Period covered
createdRequiredΣ	1..1	dateTime	Creation date
paymentIssuerΣ	0..1	Reference(Organization)	Party generating payment
request	0..1	Reference(Task)	Reference to requesting resource
requestor	0..1	Reference(Practitioner | PractitionerRole | Organization)	Responsible practitioner
outcome	0..1	code	queued | complete | error | partialBinding (required): remittance-outcome
disposition	0..1	string	Disposition message
paymentDateRequiredΣ	1..1	date	When payment issued
paymentAmountRequiredΣ	1..1	Money	Total amount of Payment
paymentIdentifier	0..1	Identifier	Business identifier for the payment
detail	0..*	BackboneElement	Settlement particulars
identifier	0..1	Identifier	Business identifier of the payment detail
predecessor	0..1	Identifier	Business identifier of the prior payment detail
typeRequired	1..1	CodeableConcept	Category of paymentBinding (example): payment-type
request	0..1	Reference(Resource)	Request giving rise to the payment
submitter	0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response	0..1	Reference(Resource)	Response committing to a payment
date	0..1	date	Date of commitment to pay
responsible	0..1	Reference(PractitionerRole)	Contact for the response
payee	0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	0..1	Money	Amount allocated to this payable
formCode	0..1	CodeableConcept	Printed form identifierBinding (example): forms
processNote	0..*	BackboneElement	Note concerning processing
type	0..1	code	display | print | printoperBinding (required): note-type
text	0..1	string	Note explanatory text

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/PaymentReconciliation?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
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

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition