Invoice
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/Invoice| 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(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Business Identifier for item |
status | code | 1..1 | draft | issued | balanced | cancelled | entered-in-error modifier |
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 | — | 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
Reference
- Official FHIR R4 spec:
Invoice - Maturity: Draft (FMM 0).