PaymentNotice
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
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/PaymentNotice/[id] |
| Vread | GET | /fhir/R4/PaymentNotice/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/PaymentNotice/[id] |
| Patch | PATCH | /fhir/R4/PaymentNotice/[id] |
| Delete | DELETE | /fhir/R4/PaymentNotice/[id] |
| Create | POST | /fhir/R4/PaymentNotice |
| Search | GET | /fhir/R4/PaymentNotice |
| History | GET | /fhir/R4/PaymentNotice/[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 the payment noctice |
status | code | 1..1 | active | cancelled | draft | entered-in-error |
request | Reference | 0..1 | Request reference |
response | Reference | 0..1 | Response reference |
created | dateTime | 1..1 | Creation date |
provider | Reference | 0..1 | Responsible practitioner |
payment | Reference | 1..1 | Payment reference |
paymentDate | date | 0..1 | Payment or clearing date |
payee | Reference | 0..1 | Party being paid |
recipient | Reference | 1..1 | Party being notified |
amount | Money | 1..1 | Monetary amount of the payment |
paymentStatus | CodeableConcept | 0..1 | Issued or cleared Status of the payment |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
created | date | Creation date fro the notice |
identifier | token | The business identifier of the notice |
payment-status | token | The type of payment notice |
provider | reference | The reference to the provider |
request | reference | The Claim |
response | reference | The ClaimResponse |
status | token | The status of the payment notice |
Reference
Official FHIR R4 spec: PaymentNotice.
Maturity: Trial Use 2 (FMM 2).