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
| 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 item |
status | code | 1..1 | draft | issued | balanced | cancelled | entered-in-error |
cancelledReason | string | 0..1 | Reason for cancellation of this Invoice |
type | CodeableConcept | 0..1 | Type of Invoice |
subject | Reference | 0..1 | Recipient(s) of goods and services |
recipient | Reference | 0..1 | Recipient of this invoice |
date | dateTime | 0..1 | Invoice date / posting date |
participant | BackboneElement | 0..* | Participant in creation of this Invoice |
issuer | Reference | 0..1 | Issuing Organization of Invoice |
account | Reference | 0..1 | Account that is being balanced |
lineItem | BackboneElement | 0..* | Line items of this Invoice |
totalPriceComponent | BackboneElement | 0..* | Components of Invoice total |
totalNet | Money | 0..1 | Net total of this Invoice |
totalGross | Money | 0..1 | Gross total of this Invoice |
paymentTerms | markdown | 0..1 | Payment details |
note | Annotation | 0..* | Comments made about the invoice |
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
Official FHIR R4 spec: Invoice.
Maturity: Draft (FMM 0).