This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Financial Management Work Group | Maturity Level: 0 | Draft | Compartments: Device, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the Invoice resource.
Invoice | |
Definition | Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. |
Control | 1..1 |
Invoice.identifier | |
Definition | Identifier of this Invoice, often used for reference in corresponcence about this invoice or for tracking of payments. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows Identification of this Invoice instance. |
Summary | true |
Invoice.status | |
Definition | The current state of the Invoice. |
Control | 1..1 |
Terminology Binding | InvoiceStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Invoice.cancelledReason | |
Definition | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc). |
Control | 0..1 |
Type | string |
Summary | false |
Comments | Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
Invoice.type | |
Definition | Type of Invoice depending on domain, realm an usage (eg. internal/external, dental, preliminary). |
Control | 0..1 |
Type | CodeableConcept |
Alternate Names | type |
Summary | true |
Invoice.subject | |
Definition | The individual or set of individuals receiving the goods and services billed in this invoice. |
Control | 0..1 |
Type | Reference(Patient | Group) |
Requirements | Links the event to the Patient context. |
Alternate Names | patient |
Summary | true |
Invoice.recipient | |
Definition | The individual or Organization responsible for balancing of this invoice. |
Control | 0..1 |
Type | Reference(Organization | Patient | RelatedPerson) |
Summary | true |
Invoice.date | |
Definition | Date/time(s) of when this Invoice was posted. |
Control | 0..1 |
Type | dateTime |
Summary | true |
Comments | The list of types may be constrained as appropriate for the type of charge item. |
Invoice.participant | |
Definition | Indicates who or what performed or participated in the charged service. |
Control | 0..* |
Summary | false |
Invoice.participant.role | |
Definition | Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. |
Control | 0..1 |
Type | CodeableConcept |
Summary | false |
Invoice.participant.actor | |
Definition | The device, practitioner, etc. who performed or participated in the service. |
Control | 1..1 |
Type | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) |
Summary | false |
Invoice.issuer | |
Definition | The organizationissuing the Invoice. |
Control | 0..1 |
Type | Reference(Organization) |
Summary | false |
Comments | Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered. |
Invoice.account | |
Definition | Account which is supposed to be balanced with this Invoice. |
Control | 0..1 |
Type | Reference(Account) |
Summary | false |
Comments | Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate. |
Invoice.lineItem | |
Definition | Each line item represents one charge for goods ond services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource. |
Control | 0..* |
Summary | false |
Invoice.lineItem.sequence | |
Definition | Sequence in which the items appear on the invoice. |
Control | 0..1 |
Type | positiveInt |
Summary | false |
Invoice.lineItem.chargeItem | |
Definition | The ChargeItem contains information such as the billing code, date, amount etc. |
Control | 1..1 |
Type | Reference(ChargeItem) |
Summary | false |
Invoice.lineItem.priceComponent | |
Definition | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated. |
Control | 0..* |
Summary | false |
Invoice.lineItem.priceComponent.type | |
Definition | This code identifies the type of the component. |
Control | 1..1 |
Terminology Binding | InvoicePriceComponentType (Required) |
Type | code |
Summary | false |
Invoice.lineItem.priceComponent.code | |
Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
Control | 0..1 |
Type | CodeableConcept |
Summary | false |
Invoice.lineItem.priceComponent.factor | |
Definition | The amount calculated for this component. |
Control | 0..1 |
Type | Money |
Summary | false |
Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden. |
Invoice.lineItem.priceComponent.amount | |
Definition | The factor that has been applied on the base price for calculating this component. |
Control | 0..1 |
Type | decimal |
Summary | false |
Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden. |
Invoice.totalPriceComponent | |
Definition | The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated. |
Control | 0..* |
Type | See Invoice.lineItem.priceComponent |
Summary | false |
Invoice.totalNet | |
Definition | Invoice total , taxes excluded. |
Control | 0..1 |
Type | Money |
Summary | true |
Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden. |
Invoice.totalGross | |
Definition | Invoice total, tax included. |
Control | 0..1 |
Type | Money |
Summary | true |
Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overriden. |
Invoice.paymentTerms | |
Definition | Payment details such as banking details, period of payment, deductables, methods of payment. |
Control | 0..1 |
Type | markdown |
Summary | false |
Comments | Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
Invoice.note | |
Definition | Comments made about the invoice by the issuer, subject or other participants. |
Control | 0..* |
Type | Annotation |
Summary | false |