type: resource-definitionsresource: Invoice

Invoice Definitions

Invoice

Invoice containing ChargeItems from an Account

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

Cardinality: 0..*

Mappings: v2=FT1; rim=Act[moodCode=EVN]; workflow=Event; w5=financial.support

Invoice.identifier

Business Identifier for item

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

Requirements: Allows Identification of this Invoice instance.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; v2=FT1.2; rim=.identifier

Invoice.status

draft | issued | balanced | cancelled | entered-in-error

Definition: The current state of the Invoice.

Cardinality: 1..1

Type: code

Binding: required:invoice-status

Summary: true

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)

Mappings: w5=FiveWs.status; v2=Varies by domain; rim=.status

Invoice.cancelledReason

Reason for cancellation of this Invoice

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

Comments: Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.

Cardinality: 0..1

Type: string

Summary: false

Invoice.type

Type of Invoice

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

Aliases: type

Cardinality: 0..1

Type: CodeableConcept

Summary: true

Mappings: workflow=Event.code; w5=FiveWs.what[x]; v2=FT1.7; rim=.code

Invoice.subject

Recipient(s) of goods and services

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

Requirements: Links the event to the Patient context.

Aliases: patient

Cardinality: 0..1

Type: Reference(Patient, Group)

Summary: true

Mappings: workflow=Event.subject; w5=FiveWs.subject; v2=PAT in proximity to FT1 segment; rim=.participation[typeCode=SBJ].role

Invoice.recipient

Recipient of this invoice

Definition: The individual or Organization responsible for balancing of this invoice.

Cardinality: 0..1

Type: Reference(Organization, Patient, RelatedPerson)

Summary: true

Mappings: v2=PV1 in proximity to FT1 segment; rim=.inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]

Invoice.creation

When posted

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

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

Cardinality: 0..1

Type: dateTime

Summary: true

Invoice.period[x]

Billing date or period

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

Cardinality: 0..1

Type: date, Period

Summary: true

Invoice.participant

Participant in creation of this Invoice

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

Cardinality: 0..*

Type: BackboneElement

Summary: false

Mappings: v2=EVN.5 or by domain; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

Invoice.participant.role

Type of involvement in creation of this Invoice

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

Mappings: v2=Varies by domain; rim=.participation.functionCode

Invoice.participant.actor

Individual who was involved

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

Mappings: w5=FiveWs.actor; v2=EVN.5 or by domain; rim=.player

Invoice.issuer

Issuing entity

Definition: The organizationissuing the Invoice.

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.

Cardinality: 0..1

Type: Reference(Organization, Practitioner, PractitionerRole)

Summary: false

Mappings: v2=N/A; rim=.scoper

Invoice.account

Account that is being balanced

Definition: Account which is supposed to be balanced with this Invoice.

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.

Cardinality: 0..1

Type: Reference(Account)

Summary: false

Invoice.lineItem

Line items of this Invoice

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.

Cardinality: 0..*

Type: BackboneElement

Summary: false

Mappings: v2=EVN.5 or by domain; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

Invoice.lineItem.sequence

Sequence number of line item

Definition: Sequence in which the items appear on the invoice.

Cardinality: 0..1

Type: positiveInt

Summary: false

Invoice.lineItem.serviced[x]

Service data or period

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

Cardinality: 0..1

Type: date, Period

Summary: false

Invoice.lineItem.chargeItem[x]

Reference to ChargeItem containing details of this line item or an inline billing code

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, CodeableConcept

Summary: false

Mappings: v2=EVN.5 or by domain; rim=.player

Invoice.lineItem.priceComponent

Components of total line item price

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..*

Type: MonetaryComponent

Summary: false

Mappings: v2=EVN.5 or by domain; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

Invoice.totalPriceComponent

Components of Invoice total

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: MonetaryComponent

Summary: false

Mappings: v2=EVN.5 or by domain; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

Invoice.totalNet

Net total of this Invoice

Definition: Invoice total , taxes excluded.

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.

Cardinality: 0..1

Type: Money

Summary: true

Mappings: v2=FT1.22

Invoice.totalGross

Gross total of this Invoice

Definition: Invoice total, tax included.

Cardinality: 0..1

Type: Money

Summary: true

Mappings: v2=FT1.22

Invoice.paymentTerms

Payment details

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

Comments: Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.

Cardinality: 0..1

Type: markdown

Summary: false

Invoice.note

Comments made about the invoice

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

Cardinality: 0..*

Type: Annotation

Summary: false

Mappings: workflow=Event.note; v2=NTE; rim=.inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]