FHIR R6 FM Incubator
0.1.0 - ci-build International flag

FHIR R6 FM Incubator, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fm-incubator/ and changes regularly. See the Directory of published versions

Resource Profile: Invoice

Official URL: http://hl7.org/fhir/StructureDefinition/Invoice Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Invoice
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1487

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

Scope and Usage

Tracking Financial information is vital in Patient Administration and Finance systems in most Healthcare Organizations. An invoice is a financial document issued by a healthcare provider to a patient or a payer indicating the goods and services (ChargeItems) performed with their quantities and prices.

Example implementations:

  • Any solution that tracks billing information and needs to issue invoices
  • Private Insurance Providers who want to deliver structured information to patients to increase cost transparency
  • Patient apps that want to include information on the amount and reason of the charged costs for the healthcare services a patient received

Note to Balloters:

​This resource is likely to be removed from the specification and moved to being an Additional Resource after this ballot due to concerns around it's readiness, and the thin implementation experience. Ballot comments on this subject are welcome.

Boundaries and Relationships

The existing Claim resource is constricted to use cases where Claims are sent to insurances for reimbursement, in a message-like style. It neither references ChargeItems nor Accounts.

Competing invoicing standards such as EDIFACT or X12 are aiming at inter-organizational exchange and do not offer human readable representations or traceable links to services rendered which is a requirement for invoicing towards patients. This resource is used where existing ChargeItems in an Account are collected to create an Invoice to be sent out to Individuals or Organizations in a structured way. The invoice is the hospital's view, whereas the Claim is the payer's view on the performed services.

Since the individual ChargeItem resources that make up the line items of the Invoice do not carry any pricing information, ChargeItemDefinitions will have to be applied to the ChargeItems in order to calculate the price components for the Invoice depending on the context of the ChargeItem

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* DomainResource Invoice containing ChargeItems from an Account

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... creation Σ 0..1 dateTime When posted
... period[x] Σ 0..1 Billing date or period
.... periodDate date
.... periodPeriod Period
... participant 0..* BackboneElement Participant in creation of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization | Practitioner | PractitionerRole) Issuing entity
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 0..* BackboneElement Line items of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 0..1 positiveInt Sequence number of line item
.... serviced[x] 0..1 Service data or period
..... servicedDate date
..... servicedPeriod Period
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(Any)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* MonetaryComponent Components of total line item price
... totalPriceComponent 0..* MonetaryComponent Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Invoice.status Base required Invoice Status 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* DomainResource Invoice containing ChargeItems from an Account

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... creation Σ 0..1 dateTime When posted
... period[x] Σ 0..1 Billing date or period
.... periodDate date
.... periodPeriod Period
... participant 0..* BackboneElement Participant in creation of this Invoice
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization | Practitioner | PractitionerRole) Issuing entity
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 0..* BackboneElement Line items of this Invoice
.... sequence 0..1 positiveInt Sequence number of line item
.... serviced[x] 0..1 Service data or period
..... servicedDate date
..... servicedPeriod Period
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(Any)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* MonetaryComponent Components of total line item price
... totalPriceComponent 0..* MonetaryComponent Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Invoice.status Base required Invoice Status 📦6.0.0-ballot3 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* DomainResource Invoice containing ChargeItems from an Account

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... creation Σ 0..1 dateTime When posted
... period[x] Σ 0..1 Billing date or period
.... periodDate date
.... periodPeriod Period
... participant 0..* BackboneElement Participant in creation of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization | Practitioner | PractitionerRole) Issuing entity
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 0..* BackboneElement Line items of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 0..1 positiveInt Sequence number of line item
.... serviced[x] 0..1 Service data or period
..... servicedDate date
..... servicedPeriod Period
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(Any)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* MonetaryComponent Components of total line item price
... totalPriceComponent 0..* MonetaryComponent Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Invoice.status Base required Invoice Status 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DomainResource

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* DomainResource Invoice containing ChargeItems from an Account

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... creation Σ 0..1 dateTime When posted
... period[x] Σ 0..1 Billing date or period
.... periodDate date
.... periodPeriod Period
... participant 0..* BackboneElement Participant in creation of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization | Practitioner | PractitionerRole) Issuing entity
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 0..* BackboneElement Line items of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 0..1 positiveInt Sequence number of line item
.... serviced[x] 0..1 Service data or period
..... servicedDate date
..... servicedPeriod Period
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(Any)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* MonetaryComponent Components of total line item price
... totalPriceComponent 0..* MonetaryComponent Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Invoice.status Base required Invoice Status 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* DomainResource Invoice containing ChargeItems from an Account

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... creation Σ 0..1 dateTime When posted
... period[x] Σ 0..1 Billing date or period
.... periodDate date
.... periodPeriod Period
... participant 0..* BackboneElement Participant in creation of this Invoice
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization | Practitioner | PractitionerRole) Issuing entity
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 0..* BackboneElement Line items of this Invoice
.... sequence 0..1 positiveInt Sequence number of line item
.... serviced[x] 0..1 Service data or period
..... servicedDate date
..... servicedPeriod Period
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(Any)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* MonetaryComponent Components of total line item price
... totalPriceComponent 0..* MonetaryComponent Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Invoice.status Base required Invoice Status 📦6.0.0-ballot3 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice 0..* DomainResource Invoice containing ChargeItems from an Account

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business Identifier for item
... status ?!Σ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type Σ 0..1 CodeableConcept Type of Invoice
... subject Σ 0..1 Reference(Patient | Group) Recipient(s) of goods and services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... creation Σ 0..1 dateTime When posted
... period[x] Σ 0..1 Billing date or period
.... periodDate date
.... periodPeriod Period
... participant 0..* BackboneElement Participant in creation of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 0..1 CodeableConcept Type of involvement in creation of this Invoice
.... actor 1..1 Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) Individual who was involved
... issuer 0..1 Reference(Organization | Practitioner | PractitionerRole) Issuing entity
... account 0..1 Reference(Account) Account that is being balanced
... lineItem 0..* BackboneElement Line items of this Invoice
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 0..1 positiveInt Sequence number of line item
.... serviced[x] 0..1 Service data or period
..... servicedDate date
..... servicedPeriod Period
.... chargeItem[x] 1..1 Reference to ChargeItem containing details of this line item or an inline billing code
..... chargeItemReference Reference(Any)
..... chargeItemCodeableConcept CodeableConcept
.... priceComponent 0..* MonetaryComponent Components of total line item price
... totalPriceComponent 0..* MonetaryComponent Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross Σ 0..1 Money Gross total of this Invoice
... paymentTerms 0..1 markdown Payment details
... note 0..* Annotation Comments made about the invoice

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Invoice.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Invoice.status Base required Invoice Status 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Invoice If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Invoice If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Invoice If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Invoice If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Invoice A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DomainResource

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 0

 

​Other representations of profile: CSV, Excel, Schematron

Notes: