FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Financial Management icon Work GroupMaturity Level: 0 Trial UseSecurity 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.

Short Display Invoice containing ChargeItems from an Account
Cardinality 0..*
Type DomainResource
Summary false
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.

Short Display Business Identifier for item
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.

Short Display draft | issued | balanced | cancelled | entered-in-error
Cardinality 1..1
Terminology Binding Invoice Status (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.).

Short Display Reason for cancellation of this Invoice
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).

Short Display Type of Invoice
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.

Short Display Recipient(s) of goods and services
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.

Short Display Recipient of this invoice
Cardinality 0..1
Type Reference(Organization | Patient | RelatedPerson)
Summary true
Invoice.date
Element Id Invoice.date
Definition

Depricared by the element below.

Short Display DEPRICATED
Cardinality 0..1
Type dateTime
Requirements

Required to suppress the Data Type VirtualServiceDetail: ERROR: Invoice::date: Expression 'Invoice.date' has illegal path.

Summary false
Invoice.creation
Element Id Invoice.creation
Definition

Date/time(s) of when this Invoice was posted.

Short Display When 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.period[x]
Element Id Invoice.period[x]
Definition

Date/time(s) range of services included in this invoice.

Short Display Billing date or period
Cardinality 0..1
Type date|Period
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Invoice.participant
Element Id Invoice.participant
Definition

Indicates who or what performed or participated in the charged service.

Short Display Participant in creation of this Invoice
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.

Short Display Type of involvement in creation of this Invoice
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.

Short Display Individual who was involved
Cardinality 1..1
Type Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson)
Summary false
Invoice.issuer
Element Id Invoice.issuer
Definition

The organizationissuing the Invoice.

Short Display Issuing Organization of 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.

Short Display Account that is being balanced
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.ofType(date), code and amount are found in the referenced ChargeItem resource.

Short Display Line items of this Invoice
Cardinality 0..*
Summary false
Invoice.lineItem.sequence
Element Id Invoice.lineItem.sequence
Definition

Sequence in which the items appear on the invoice.

Short Display Sequence number of line item
Cardinality 0..1
Type positiveInt
Summary false
Invoice.lineItem.serviced[x]
Element Id Invoice.lineItem.serviced[x]
Definition

Date/time(s) range when this service was delivered or completed.

Short Display Service data or period
Cardinality 0..1
Type date|Period
[x] Note See Choice of Datatypes for further information about how to use [x]
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.

Short Display Reference to ChargeItem containing details of this line item or an inline billing code
Cardinality 1..1
Type Reference(ChargeItem)|CodeableConcept
[x] Note See Choice of Datatypes 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.

Short Display Components of total line item price
Cardinality 0..*
Type MonetaryComponent
Summary false
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.

Short Display Components of Invoice total
Cardinality 0..*
Type MonetaryComponent
Summary false
Invoice.totalNet
Element Id Invoice.totalNet
Definition

Invoice total , taxes excluded.

Short Display Net total of this Invoice
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.

Short Display Gross total of this Invoice
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.

Short Display Payment details
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.

Short Display Comments made about the invoice
Cardinality 0..*
Type Annotation
Summary false