This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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 | Trial Use | Security Category: Patient | Compartments: Device, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the Invoice resource.
Invoice | |
Element Id | Invoice |
Definition | Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. |
Cardinality | 0..* |
Type | DomainResource |
Invoice.identifier | |
Element Id | Invoice.identifier |
Definition | Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Allows Identification of this Invoice instance. |
Summary | true |
Invoice.status | |
Element Id | Invoice.status |
Definition | The current state of the Invoice. |
Cardinality | 1..1 |
Terminology Binding | InvoiceStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Summary | true |
Invoice.cancelledReason | |
Element Id | Invoice.cancelledReason |
Definition | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). |
Cardinality | 0..1 |
Type | string |
Summary | false |
Comments | Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. |
Invoice.type | |
Element Id | Invoice.type |
Definition | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). |
Cardinality | 0..1 |
Type | CodeableConcept |
Alternate Names | type |
Summary | true |
Invoice.subject | |
Element Id | Invoice.subject |
Definition | The individual or set of individuals receiving the goods and services billed in this invoice. |
Cardinality | 0..1 |
Type | Reference(Patient | Group) |
Requirements | Links the event to the Patient context. |
Alternate Names | patient |
Summary | true |
Invoice.recipient | |
Element Id | Invoice.recipient |
Definition | The individual or Organization responsible for balancing of this invoice. |
Cardinality | 0..1 |
Type | Reference(Organization | Patient | RelatedPerson) |
Summary | true |
Invoice.date | |
Element Id | Invoice.date |
Definition | Date/time(s) of when this Invoice was posted. |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
Comments | The list of types may be constrained as appropriate for the type of charge item. |
Invoice.participant | |
Element Id | Invoice.participant |
Definition | Indicates who or what performed or participated in the charged service. |
Cardinality | 0..* |
Summary | false |
Invoice.participant.role | |
Element Id | 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. |
Cardinality | 0..1 |
Type | CodeableConcept |
Summary | false |
Invoice.participant.actor | |
Element Id | Invoice.participant.actor |
Definition | The device, practitioner, etc. who performed or participated in the service. |
Cardinality | 1..1 |
Type | Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) |
Summary | false |
Invoice.issuer | |
Element Id | Invoice.issuer |
Definition | The organizationissuing the Invoice. |
Cardinality | 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 | |
Element Id | Invoice.account |
Definition | Account which is supposed to be balanced with this Invoice. |
Cardinality | 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 | |
Element Id | Invoice.lineItem |
Definition | Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource. |
Cardinality | 0..* |
Summary | false |
Invoice.lineItem.sequence | |
Element Id | Invoice.lineItem.sequence |
Definition | Sequence in which the items appear on the invoice. |
Cardinality | 0..1 |
Type | positiveInt |
Summary | false |
Invoice.lineItem.chargeItem[x] | |
Element Id | Invoice.lineItem.chargeItem[x] |
Definition | The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. |
Cardinality | 1..1 |
Type | Reference(ChargeItem)|CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Invoice.lineItem.priceComponent | |
Element Id | 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 development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated. |
Cardinality | 0..* |
Summary | false |
Invoice.lineItem.priceComponent.type | |
Element Id | Invoice.lineItem.priceComponent.type |
Definition | This code identifies the type of the component. |
Cardinality | 1..1 |
Terminology Binding | InvoicePriceComponentType (Required) |
Type | code |
Summary | false |
Invoice.lineItem.priceComponent.code | |
Element Id | Invoice.lineItem.priceComponent.code |
Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
Cardinality | 0..1 |
Type | CodeableConcept |
Summary | false |
Invoice.lineItem.priceComponent.factor | |
Element Id | Invoice.lineItem.priceComponent.factor |
Definition | The factor that has been applied on the base price for calculating this component. |
Cardinality | 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 overridden. |
Invoice.lineItem.priceComponent.amount | |
Element Id | Invoice.lineItem.priceComponent.amount |
Definition | The amount calculated for this component. |
Cardinality | 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 overridden. |
Invoice.totalPriceComponent | |
Element Id | 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. |
Cardinality | 0..* |
Type | See Invoice.lineItem.priceComponent |
Summary | false |
Invoice.totalNet | |
Element Id | Invoice.totalNet |
Definition | Invoice total , taxes excluded. |
Cardinality | 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 overridden. |
Invoice.totalGross | |
Element Id | Invoice.totalGross |
Definition | Invoice total, tax included. |
Cardinality | 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 overridden. |
Invoice.paymentTerms | |
Element Id | Invoice.paymentTerms |
Definition | Payment details such as banking details, period of payment, deductibles, methods of payment. |
Cardinality | 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 | |
Element Id | Invoice.note |
Definition | Comments made about the invoice by the issuer, subject, or other participants. |
Cardinality | 0..* |
Type | Annotation |
Summary | false |