PaymentNotice

ResourceFinancial · PaymentTrial useMaturity 2

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifier	0..*	Identifier	Business Identifier for the payment noctice
statusRequired?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-errorBinding (required): fm-status
request	0..1	Reference(Resource)	Request reference
response	0..1	Reference(Resource)	Response reference
createdRequiredΣ	1..1	dateTime	Creation date
provider	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Responsible practitioner
paymentRequiredΣ	1..1	Reference(PaymentReconciliation)	Payment reference
paymentDate	0..1	date	Payment or clearing date
payee	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Party being paid
recipientRequiredΣ	1..1	Reference(Organization)	Party being notified
amountRequiredΣ	1..1	Money	Monetary amount of the payment
paymentStatus	0..1	CodeableConcept	Issued or cleared Status of the paymentBinding (example): payment-status

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

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

Parameter	Type	Description
`created`	date	Creation date fro the notice `PaymentNotice.created`
`identifier`	token	The business identifier of the notice `PaymentNotice.identifier`
`payment-status`	token	The type of payment notice `PaymentNotice.paymentStatus`
`provider`	reference	The reference to the provider `PaymentNotice.provider`
`request`	reference	The Claim `PaymentNotice.request`
`response`	reference	The ClaimResponse `PaymentNotice.response`
`status`	token	The status of the payment notice `PaymentNotice.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