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 IdInvoice
Definition

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Short DisplayInvoice containing ChargeItems from an Account
Cardinality0..*
TypeDomainResource
Summaryfalse
Invoice.identifier
Element IdInvoice.identifier
Definition

Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.

Short DisplayBusiness Identifier for item
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows Identification of this Invoice instance.

Summarytrue
Invoice.status
Element IdInvoice.status
Definition

The current state of the Invoice.

Short Displaydraft | issued | balanced | cancelled | entered-in-error
Cardinality1..1
Terminology BindingInvoiceStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
Invoice.cancelledReason
Element IdInvoice.cancelledReason
Definition

In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).

Short DisplayReason for cancellation of this Invoice
Cardinality0..1
Typestring
Summaryfalse
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 IdInvoice.type
Definition

Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

Short DisplayType of Invoice
Cardinality0..1
TypeCodeableConcept
Alternate Namestype
Summarytrue
Invoice.subject
Element IdInvoice.subject
Definition

The individual or set of individuals receiving the goods and services billed in this invoice.

Short DisplayRecipient(s) of goods and services
Cardinality0..1
TypeReference(Patient | Group)
Requirements

Links the event to the Patient context.

Alternate Namespatient
Summarytrue
Invoice.recipient
Element IdInvoice.recipient
Definition

The individual or Organization responsible for balancing of this invoice.

Short DisplayRecipient of this invoice
Cardinality0..1
TypeReference(Organization | Patient | RelatedPerson)
Summarytrue
Invoice.date
Element IdInvoice.date
Definition

Depricared by the element below.

Short DisplayDEPRICATED
Cardinality0..1
TypedateTime
Requirements

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

Summaryfalse
Invoice.creation
Element IdInvoice.creation
Definition

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

Short DisplayWhen posted
Cardinality0..1
TypedateTime
Summarytrue
Comments

The list of types may be constrained as appropriate for the type of charge item.

Invoice.period[x]
Element IdInvoice.period[x]
Definition

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

Short DisplayBilling date or period
Cardinality0..1
Typedate|Period
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Invoice.participant
Element IdInvoice.participant
Definition

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

Short DisplayParticipant in creation of this Invoice
Cardinality0..*
Summaryfalse
Invoice.participant.role
Element IdInvoice.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 DisplayType of involvement in creation of this Invoice
Cardinality0..1
TypeCodeableConcept
Summaryfalse
Invoice.participant.actor
Element IdInvoice.participant.actor
Definition

The device, practitioner, etc. who performed or participated in the service.

Short DisplayIndividual who was involved
Cardinality1..1
TypeReference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson)
Summaryfalse
Invoice.issuer
Element IdInvoice.issuer
Definition

The organizationissuing the Invoice.

Short DisplayIssuing Organization of Invoice
Cardinality0..1
TypeReference(Organization)
Summaryfalse
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 IdInvoice.account
Definition

Account which is supposed to be balanced with this Invoice.

Short DisplayAccount that is being balanced
Cardinality0..1
TypeReference(Account)
Summaryfalse
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 IdInvoice.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.

Short DisplayLine items of this Invoice
Cardinality0..*
Summaryfalse
Invoice.lineItem.sequence
Element IdInvoice.lineItem.sequence
Definition

Sequence in which the items appear on the invoice.

Short DisplaySequence number of line item
Cardinality0..1
TypepositiveInt
Summaryfalse
Invoice.lineItem.serviced[x]
Element IdInvoice.lineItem.serviced[x]
Definition

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

Short DisplayService data or period
Cardinality0..1
Typedate|Period
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Invoice.lineItem.chargeItem[x]
Element IdInvoice.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 DisplayReference to ChargeItem containing details of this line item or an inline billing code
Cardinality1..1
TypeReference(ChargeItem)|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Invoice.lineItem.priceComponent
Element IdInvoice.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 DisplayComponents of total line item price
Cardinality0..*
TypeMonetaryComponent
Summaryfalse
Invoice.totalPriceComponent
Element IdInvoice.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 DisplayComponents of Invoice total
Cardinality0..*
TypeMonetaryComponent
Summaryfalse
Invoice.totalNet
Element IdInvoice.totalNet
Definition

Invoice total , taxes excluded.

Short DisplayNet total of this Invoice
Cardinality0..1
TypeMoney
Summarytrue
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 IdInvoice.totalGross
Definition

Invoice total, tax included.

Short DisplayGross total of this Invoice
Cardinality0..1
TypeMoney
Summarytrue
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 IdInvoice.paymentTerms
Definition

Payment details such as banking details, period of payment, deductibles, methods of payment.

Short DisplayPayment details
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdInvoice.note
Definition

Comments made about the invoice by the issuer, subject, or other participants.

Short DisplayComments made about the invoice
Cardinality0..*
TypeAnnotation
Summaryfalse