# PaymentNotice

Canonical page: https://docs.ovok.com/api/fhir/r4/payment-notice

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business Identifier for the payment noctice |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| cancelled \| draft \| entered-in-error |
| <span id="element-request"></span>`request` | [Reference](/fhir-elements/complex/reference) | `0..1` | Request reference |
| <span id="element-response"></span>`response` | [Reference](/fhir-elements/complex/reference) | `0..1` | Response reference |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `1..1` | Creation date |
| <span id="element-provider"></span>`provider` | [Reference](/fhir-elements/complex/reference) | `0..1` | Responsible practitioner |
| <span id="element-payment"></span>`payment` | [Reference](/fhir-elements/complex/reference) | `1..1` | Payment reference |
| <span id="element-payment-date"></span>`paymentDate` | [date](/fhir-elements/primitive/date) | `0..1` | Payment or clearing date |
| <span id="element-payee"></span>`payee` | [Reference](/fhir-elements/complex/reference) | `0..1` | Party being paid |
| <span id="element-recipient"></span>`recipient` | [Reference](/fhir-elements/complex/reference) | `1..1` | Party being notified |
| <span id="element-amount"></span>`amount` | [Money](/fhir-elements/complex/money) | `1..1` | Monetary amount of the payment |
| <span id="element-payment-status"></span>`paymentStatus` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Issued or cleared Status of the payment |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [PaymentNotice](https://hl7.org/fhir/R4/paymentnotice.html).  
Maturity: Trial Use 2 (FMM 2).
