# Invoice

Canonical page: https://docs.ovok.com/api/fhir/r4/invoice

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

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/Invoice/[id]` |
| Vread | `GET` | `/fhir/R4/Invoice/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Invoice/[id]` |
| Patch | `PATCH` | `/fhir/R4/Invoice/[id]` |
| Delete | `DELETE` | `/fhir/R4/Invoice/[id]` |
| Create | `POST` | `/fhir/R4/Invoice` |
| Search | `GET` | `/fhir/R4/Invoice` |
| History | `GET` | `/fhir/R4/Invoice/[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 item |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| issued \| balanced \| cancelled \| entered-in-error |
| <span id="element-cancelled-reason"></span>`cancelledReason` | [string](/fhir-elements/primitive/string) | `0..1` | Reason for cancellation of this Invoice |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Type of Invoice |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..1` | Recipient(s) of goods and services |
| <span id="element-recipient"></span>`recipient` | [Reference](/fhir-elements/complex/reference) | `0..1` | Recipient of this invoice |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Invoice date / posting date |
| <span id="element-participant"></span>`participant` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Participant in creation of this Invoice |
| <span id="element-issuer"></span>`issuer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Issuing Organization of Invoice |
| <span id="element-account"></span>`account` | [Reference](/fhir-elements/complex/reference) | `0..1` | Account that is being balanced |
| <span id="element-line-item"></span>`lineItem` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Line items of this Invoice |
| <span id="element-total-price-component"></span>`totalPriceComponent` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Components of Invoice total |
| <span id="element-total-net"></span>`totalNet` | [Money](/fhir-elements/complex/money) | `0..1` | Net total of this Invoice |
| <span id="element-total-gross"></span>`totalGross` | [Money](/fhir-elements/complex/money) | `0..1` | Gross total of this Invoice |
| <span id="element-payment-terms"></span>`paymentTerms` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Payment details |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments made about the invoice |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `account` | reference | Account that is being balanced |
| `date` | date | Invoice date / posting date |
| `identifier` | token | Business Identifier for item |
| `issuer` | reference | Issuing Organization of Invoice |
| `participant` | reference | Individual who was involved |
| `participant-role` | token | Type of involvement in creation of this Invoice |
| `patient` | reference | Recipient(s) of goods and services |
| `recipient` | reference | Recipient of this invoice |
| `status` | token | draft \| issued \| balanced \| cancelled \| entered-in-error |
| `subject` | reference | Recipient(s) of goods and services |
| `totalgross` | quantity | Gross total of this Invoice |
| `totalnet` | quantity | Net total of this Invoice |
| `type` | token | Type of Invoice |

## Reference [#reference]

Official FHIR R4 spec: [Invoice](https://hl7.org/fhir/R4/invoice.html).  
Maturity: Draft (FMM 0).
