Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). 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

8.30 Resource Invoice - Content

Financial Management icon Work Group Maturity Level : 0   Trial Use Security Category : Patient Compartments : Device , Patient , Practitioner , RelatedPerson

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

8.30.1 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

8.30.2 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

8.30.3 References to this Resource

No resources refer to this resource directly.

8.30.4 Resource Content

Structure

1..1 Code identifying the specific component see priceComponent
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Invoice TU 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
InvoiceStatus ( Required )
. . . 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
. . . date 0..1 dateTime DEPRICATED
... creation Σ 0..1 dateTime When posted
... period[x] Invoice Σ 0..1 Billing date / posting 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 ) Issuing Organization of Invoice
. . . 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
. . . . chargeItem[x] serviced[x] 1..1 0..1 Reference to ChargeItem containing details of this line item Service data or an inline billing code period
. . . . chargeItemReference . servicedDate Reference ( ChargeItem date )
. . . . . chargeItemCodeableConcept servicedPeriod CodeableConcept Period
. . . priceComponent . chargeItem[x] 0..* 1..1 BackboneElement Components Reference to ChargeItem containing details of total this line item price or an inline billing code
. . . . type . chargeItemReference code base | surcharge | deduction | discount | tax | informational InvoicePriceComponentType Reference ( Required ChargeItem )
. . . . . code chargeItemCodeableConcept 0..1 CodeableConcept
. . . factor . priceComponent 0..1 0..* decimal MonetaryComponent Factor used for calculating this component amount 0..1 Money Components of total line item price

Monetary amount associated with this component
. . . 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

Invoice ( DomainResource ) Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments identifier : Identifier [0..*] The current state of the Invoice (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) InvoiceStatus ! » In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.) cancelledReason : string [0..1] Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary) type : CodeableConcept [0..1] The individual or set of individuals receiving the goods and services billed in this invoice subject : Reference [0..1] « Patient | Group » The individual or Organization responsible for balancing of this invoice recipient : Reference [0..1] « Organization | Patient | RelatedPerson » Depricared by the element below date : dateTime [0..1] Date/time(s) of when this Invoice was posted date creation : dateTime [0..1] Date/time(s) range of services included in this invoice period[x] : DataType [0..1] « date | Period » The organizationissuing the Invoice issuer : Reference [0..1] « Organization » Account which is supposed to be balanced with this Invoice account : Reference [0..1] « Account » 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 totalPriceComponent : MonetaryComponent [0..*] Invoice total , taxes excluded totalNet : Money [0..1] Invoice total, tax included totalGross : Money [0..1] Payment details such as banking details, period of payment, deductibles, methods of payment paymentTerms : markdown [0..1] Comments made about the invoice by the issuer, subject, or other participants note : Annotation [0..*] Participant 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 role : CodeableConcept [0..1] The device, practitioner, etc. who performed or participated in the service actor : Reference [1..1] « Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson » LineItem Sequence in which the items appear on the invoice sequence : positiveInt [0..1] Date/time(s) range when this service was delivered or completed serviced[x] : DataType [0..1] « date | Period » 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 chargeItem[x] : Element DataType [1..1] « Reference ( ChargeItem )| CodeableConcept » PriceComponent This code identifies the type of the component type : code [1..1] « null (Strength=Required) InvoicePriceComponentType ! » A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc code : CodeableConcept [0..1] The factor that has been applied on the base price for calculating this component factor : decimal [0..1] The amount calculated for this component amount : Money [0..1] Indicates who or what performed or participated in the charged service participant [0..*] 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 priceComponent : MonetaryComponent [0..*] Indicates who or what performed or participated in the charged service participant [0..*] 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 lineItem [0..*] 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 totalPriceComponent [0..*]

XML Template 

<Invoice xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for item --></identifier>
 <status value="[code]"/><!-- 1..1 draft | issued | balanced | cancelled | entered-in-error -->
 <cancelledReason value="[string]"/><!-- 0..1 Reason for cancellation of this Invoice -->
 <type><!-- 0..1 CodeableConcept Type of Invoice --></type>
 <subject><!-- 0..1 Reference(Group|Patient) Recipient(s) of goods and services --></subject>
 <recipient><!-- 0..1 Reference(Organization|Patient|RelatedPerson) Recipient of this invoice --></recipient>
 <

 <date value="[dateTime]"/><!-- 0..1 DEPRICATED -->
 <creation value="[dateTime]"/><!-- 0..1 When posted -->
 <period[x]><!-- 0..1 date|Period Billing date or period --></period[x]>

 <participant>  <!-- 0..* Participant in creation of this Invoice -->
  <role><!-- 0..1 CodeableConcept Type of involvement in creation of this Invoice --></role>
  <actor><!-- 1..1 Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) Individual who was involved --></actor>
 </participant>
 <issuer><!-- 0..1 Reference(Organization) Issuing Organization of Invoice --></issuer>
 <account><!-- 0..1 Reference(Account) Account that is being balanced --></account>
 <lineItem>  <!-- 0..* Line items of this Invoice -->
  <sequence value="[positiveInt]"/><!-- 0..1 Sequence number of line item -->
  <serviced[x]><!-- 0..1 date|Period Service data or period --></serviced[x]>

  <chargeItem[x]><!-- 1..1 Reference(ChargeItem)|CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code --></chargeItem[x]>
  <
   <
   <</code>
   <
   <</amount>
  </priceComponent>

  <priceComponent><!-- 0..* MonetaryComponent Components of total line item price --></priceComponent>

 </lineItem>
 <</totalPriceComponent>

 <totalPriceComponent><!-- 0..* MonetaryComponent Components of Invoice total --></totalPriceComponent>

 <totalNet><!-- 0..1 Money Net total of this Invoice --></totalNet>
 <totalGross><!-- 0..1 Money Gross total of this Invoice --></totalGross>
 <paymentTerms value="[markdown]"/><!-- 0..1 Payment details -->
 <note><!-- 0..* Annotation Comments made about the invoice --></note>
</Invoice>

JSON Template 

{doco
  "resourceType" : "Invoice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for item
  "status" : "<code>", // R!  draft | issued | balanced | cancelled | entered-in-error
  "cancelledReason" : "<string>", // Reason for cancellation of this Invoice
  "type" : { CodeableConcept }, // Type of Invoice
  "subject" : { Reference(Group|Patient) }, // Recipient(s) of goods and services
  "recipient" : { Reference(Organization|Patient|RelatedPerson) }, // Recipient of this invoice
  "

  "date" : "<dateTime>", // DEPRICATED
  "creation" : "<dateTime>", // When posted
  // period[x]: Billing date or period. One of these 2:

  "periodDate" : "<date>",
  "periodPeriod" : { Period },

  "participant" : [{ // Participant in creation of this Invoice
    "role" : { CodeableConcept }, // Type of involvement in creation of this Invoice
    "actor" : { Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) } // R!  Individual who was involved
  }],
  "issuer" : { Reference(Organization) }, // Issuing Organization of Invoice
  "account" : { Reference(Account) }, // Account that is being balanced
  "lineItem" : [{ // Line items of this Invoice
    "sequence" : "<positiveInt>", // Sequence number of line item
    // serviced[x]: Service data or period. One of these 2:
    "servicedDate" : "<date>",
    "servicedPeriod" : { Period },

    // chargeItem[x]: 
      Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2:
    "chargeItemReference" : { Reference(ChargeItem) },
    "chargeItemCodeableConcept" : { CodeableConcept },
    "
      "
      "
      "
      "
    }]

    "priceComponent" : [{ MonetaryComponent }] // Components of total line item price

  }],
  "

  "totalPriceComponent" : [{ MonetaryComponent }], // Components of Invoice total

  "totalNet" : { Money }, // Net total of this Invoice
  "totalGross" : { Money }, // Gross total of this Invoice
  "paymentTerms" : "<markdown>", // Payment details
  "note" : [{ Annotation }] // Comments made about the invoice
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Invoice;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Invoice.identifier [ Identifier ], ... ; # 0..* Business Identifier for item
  fhir:Invoice.status [ code ]; # 1..1 draft | issued | balanced | cancelled | entered-in-error
  fhir:Invoice.cancelledReason [ string ]; # 0..1 Reason for cancellation of this Invoice
  fhir:Invoice.type [ CodeableConcept ]; # 0..1 Type of Invoice
  fhir:Invoice.subject [ Reference(Group|Patient) ]; # 0..1 Recipient(s) of goods and services
  fhir:Invoice.recipient [ Reference(Organization|Patient|RelatedPerson) ]; # 0..1 Recipient of this invoice
  fhir:

  fhir:Invoice.date [ dateTime ]; # 0..1 DEPRICATED
  fhir:Invoice.creation [ dateTime ]; # 0..1 When posted
  # Invoice.period[x] : 0..1 Billing date or period. One of these 2
    fhir:Invoice.periodDate [ date ]
    fhir:Invoice.periodPeriod [ Period ]

  fhir:Invoice.participant [ # 0..* Participant in creation of this Invoice
    fhir:Invoice.participant.role [ CodeableConcept ]; # 0..1 Type of involvement in creation of this Invoice
    fhir:Invoice.participant.actor [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Individual who was involved
  ], ...;
  fhir:Invoice.issuer [ Reference(Organization) ]; # 0..1 Issuing Organization of Invoice
  fhir:Invoice.account [ Reference(Account) ]; # 0..1 Account that is being balanced
  fhir:Invoice.lineItem [ # 0..* Line items of this Invoice
    fhir:Invoice.lineItem.sequence [ positiveInt ]; # 0..1 Sequence number of line item
    # Invoice.lineItem.serviced[x] : 0..1 Service data or period. One of these 2
      fhir:Invoice.lineItem.servicedDate [ date ]
      fhir:Invoice.lineItem.servicedPeriod [ Period ]

    # Invoice.lineItem.chargeItem[x] : 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2
      fhir:Invoice.lineItem.chargeItemReference [ Reference(ChargeItem) ]
      fhir:Invoice.lineItem.chargeItemCodeableConcept [ CodeableConcept ]
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ], ...;

    fhir:Invoice.lineItem.priceComponent [ MonetaryComponent ], ... ; # 0..* Components of total line item price

  ], ...;
  fhir:

  fhir:Invoice.totalPriceComponent [ MonetaryComponent ], ... ; # 0..* Components of Invoice total

  fhir:Invoice.totalNet [ Money ]; # 0..1 Net total of this Invoice
  fhir:Invoice.totalGross [ Money ]; # 0..1 Gross total of this Invoice
  fhir:Invoice.paymentTerms [ markdown ]; # 0..1 Payment details
  fhir:Invoice.note [ Annotation ], ... ; # 0..* Comments made about the invoice
]

Changes since R4

Invoice
Invoice.creation
  • No Changes Added Element
Invoice.period[x]
  • Added Element
Invoice.lineItem.serviced[x]
  • Added Element
Invoice.lineItem.priceComponent
  • Type changed from BackboneElement to MonetaryComponent
  • Type changed from BackboneElement to MonetaryComponent
Invoice.totalPriceComponent
  • Add Type MonetaryComponent, MonetaryComponent
  • Add Type MonetaryComponent, MonetaryComponent
Invoice.lineItem.priceComponent.type
  • deleted
Invoice.lineItem.priceComponent.code
  • deleted
Invoice.lineItem.priceComponent.factor
  • deleted
Invoice.lineItem.priceComponent.amount
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

Structure

1..1 Code identifying the specific component Monetary amount associated with this component see priceComponent
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Invoice TU 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
InvoiceStatus ( Required )
. . . 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
. . . date 0..1 dateTime DEPRICATED
... creation Σ 0..1 dateTime When posted
... period[x] Invoice Σ 0..1 Billing date / posting 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 ) Issuing Organization of Invoice
. . . 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
. . . . chargeItem[x] serviced[x] 1..1 0..1 Reference to ChargeItem containing details of this line item Service data or an inline billing code period
. . . . chargeItemReference . servicedDate Reference ( ChargeItem date )
. . . . . chargeItemCodeableConcept servicedPeriod CodeableConcept Period
. . . priceComponent . chargeItem[x] 0..* 1..1 BackboneElement Components Reference to ChargeItem containing details of total this line item price or an inline billing code
. . . . type . chargeItemReference code base | surcharge | deduction | discount | tax | informational InvoicePriceComponentType Reference ( Required ChargeItem )
. . . . . code chargeItemCodeableConcept 0..1 CodeableConcept
. . . factor . priceComponent 0..1 0..* decimal MonetaryComponent Factor used for calculating this component amount 0..1 Components of total line item price
Money
. . . 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

Invoice ( DomainResource ) Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments identifier : Identifier [0..*] The current state of the Invoice (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) InvoiceStatus ! » In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.) cancelledReason : string [0..1] Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary) type : CodeableConcept [0..1] The individual or set of individuals receiving the goods and services billed in this invoice subject : Reference [0..1] « Patient | Group » The individual or Organization responsible for balancing of this invoice recipient : Reference [0..1] « Organization | Patient | RelatedPerson » Depricared by the element below date : dateTime [0..1] Date/time(s) of when this Invoice was posted date creation : dateTime [0..1] Date/time(s) range of services included in this invoice period[x] : DataType [0..1] « date | Period » The organizationissuing the Invoice issuer : Reference [0..1] « Organization » Account which is supposed to be balanced with this Invoice account : Reference [0..1] « Account » 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 totalPriceComponent : MonetaryComponent [0..*] Invoice total , taxes excluded totalNet : Money [0..1] Invoice total, tax included totalGross : Money [0..1] Payment details such as banking details, period of payment, deductibles, methods of payment paymentTerms : markdown [0..1] Comments made about the invoice by the issuer, subject, or other participants note : Annotation [0..*] Participant 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 role : CodeableConcept [0..1] The device, practitioner, etc. who performed or participated in the service actor : Reference [1..1] « Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson » LineItem Sequence in which the items appear on the invoice sequence : positiveInt [0..1] Date/time(s) range when this service was delivered or completed serviced[x] : DataType [0..1] « date | Period » 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 chargeItem[x] : Element DataType [1..1] « Reference ( ChargeItem )| CodeableConcept » PriceComponent This code identifies the type of the component type : code [1..1] « null (Strength=Required) InvoicePriceComponentType ! » A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc code : CodeableConcept [0..1] The factor that has been applied on the base price for calculating this component factor : decimal [0..1] The amount calculated for this component amount : Money [0..1] Indicates who or what performed or participated in the charged service participant [0..*] 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 priceComponent : MonetaryComponent [0..*] Indicates who or what performed or participated in the charged service participant [0..*] 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 lineItem [0..*] 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 totalPriceComponent [0..*]

XML Template 

<Invoice xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier for item --></identifier>
 <status value="[code]"/><!-- 1..1 draft | issued | balanced | cancelled | entered-in-error -->
 <cancelledReason value="[string]"/><!-- 0..1 Reason for cancellation of this Invoice -->
 <type><!-- 0..1 CodeableConcept Type of Invoice --></type>
 <subject><!-- 0..1 Reference(Group|Patient) Recipient(s) of goods and services --></subject>
 <recipient><!-- 0..1 Reference(Organization|Patient|RelatedPerson) Recipient of this invoice --></recipient>
 <

 <date value="[dateTime]"/><!-- 0..1 DEPRICATED -->
 <creation value="[dateTime]"/><!-- 0..1 When posted -->
 <period[x]><!-- 0..1 date|Period Billing date or period --></period[x]>

 <participant>  <!-- 0..* Participant in creation of this Invoice -->
  <role><!-- 0..1 CodeableConcept Type of involvement in creation of this Invoice --></role>
  <actor><!-- 1..1 Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) Individual who was involved --></actor>
 </participant>
 <issuer><!-- 0..1 Reference(Organization) Issuing Organization of Invoice --></issuer>
 <account><!-- 0..1 Reference(Account) Account that is being balanced --></account>
 <lineItem>  <!-- 0..* Line items of this Invoice -->
  <sequence value="[positiveInt]"/><!-- 0..1 Sequence number of line item -->
  <serviced[x]><!-- 0..1 date|Period Service data or period --></serviced[x]>

  <chargeItem[x]><!-- 1..1 Reference(ChargeItem)|CodeableConcept Reference to ChargeItem containing details of this line item or an inline billing code --></chargeItem[x]>
  <
   <
   <</code>
   <
   <</amount>
  </priceComponent>

  <priceComponent><!-- 0..* MonetaryComponent Components of total line item price --></priceComponent>

 </lineItem>
 <</totalPriceComponent>

 <totalPriceComponent><!-- 0..* MonetaryComponent Components of Invoice total --></totalPriceComponent>

 <totalNet><!-- 0..1 Money Net total of this Invoice --></totalNet>
 <totalGross><!-- 0..1 Money Gross total of this Invoice --></totalGross>
 <paymentTerms value="[markdown]"/><!-- 0..1 Payment details -->
 <note><!-- 0..* Annotation Comments made about the invoice --></note>
</Invoice>

JSON Template 

{doco
  "resourceType" : "Invoice",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for item
  "status" : "<code>", // R!  draft | issued | balanced | cancelled | entered-in-error
  "cancelledReason" : "<string>", // Reason for cancellation of this Invoice
  "type" : { CodeableConcept }, // Type of Invoice
  "subject" : { Reference(Group|Patient) }, // Recipient(s) of goods and services
  "recipient" : { Reference(Organization|Patient|RelatedPerson) }, // Recipient of this invoice
  "

  "date" : "<dateTime>", // DEPRICATED
  "creation" : "<dateTime>", // When posted
  // period[x]: Billing date or period. One of these 2:

  "periodDate" : "<date>",
  "periodPeriod" : { Period },

  "participant" : [{ // Participant in creation of this Invoice
    "role" : { CodeableConcept }, // Type of involvement in creation of this Invoice
    "actor" : { Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) } // R!  Individual who was involved
  }],
  "issuer" : { Reference(Organization) }, // Issuing Organization of Invoice
  "account" : { Reference(Account) }, // Account that is being balanced
  "lineItem" : [{ // Line items of this Invoice
    "sequence" : "<positiveInt>", // Sequence number of line item
    // serviced[x]: Service data or period. One of these 2:
    "servicedDate" : "<date>",
    "servicedPeriod" : { Period },

    // chargeItem[x]: 
      Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2:
    "chargeItemReference" : { Reference(ChargeItem) },
    "chargeItemCodeableConcept" : { CodeableConcept },
    "
      "
      "
      "
      "
    }]

    "priceComponent" : [{ MonetaryComponent }] // Components of total line item price

  }],
  "

  "totalPriceComponent" : [{ MonetaryComponent }], // Components of Invoice total

  "totalNet" : { Money }, // Net total of this Invoice
  "totalGross" : { Money }, // Gross total of this Invoice
  "paymentTerms" : "<markdown>", // Payment details
  "note" : [{ Annotation }] // Comments made about the invoice
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Invoice;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Invoice.identifier [ Identifier ], ... ; # 0..* Business Identifier for item
  fhir:Invoice.status [ code ]; # 1..1 draft | issued | balanced | cancelled | entered-in-error
  fhir:Invoice.cancelledReason [ string ]; # 0..1 Reason for cancellation of this Invoice
  fhir:Invoice.type [ CodeableConcept ]; # 0..1 Type of Invoice
  fhir:Invoice.subject [ Reference(Group|Patient) ]; # 0..1 Recipient(s) of goods and services
  fhir:Invoice.recipient [ Reference(Organization|Patient|RelatedPerson) ]; # 0..1 Recipient of this invoice
  fhir:

  fhir:Invoice.date [ dateTime ]; # 0..1 DEPRICATED
  fhir:Invoice.creation [ dateTime ]; # 0..1 When posted
  # Invoice.period[x] : 0..1 Billing date or period. One of these 2
    fhir:Invoice.periodDate [ date ]
    fhir:Invoice.periodPeriod [ Period ]

  fhir:Invoice.participant [ # 0..* Participant in creation of this Invoice
    fhir:Invoice.participant.role [ CodeableConcept ]; # 0..1 Type of involvement in creation of this Invoice
    fhir:Invoice.participant.actor [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 1..1 Individual who was involved
  ], ...;
  fhir:Invoice.issuer [ Reference(Organization) ]; # 0..1 Issuing Organization of Invoice
  fhir:Invoice.account [ Reference(Account) ]; # 0..1 Account that is being balanced
  fhir:Invoice.lineItem [ # 0..* Line items of this Invoice
    fhir:Invoice.lineItem.sequence [ positiveInt ]; # 0..1 Sequence number of line item
    # Invoice.lineItem.serviced[x] : 0..1 Service data or period. One of these 2
      fhir:Invoice.lineItem.servicedDate [ date ]
      fhir:Invoice.lineItem.servicedPeriod [ Period ]

    # Invoice.lineItem.chargeItem[x] : 1..1 Reference to ChargeItem containing details of this line item or an inline billing code. One of these 2
      fhir:Invoice.lineItem.chargeItemReference [ Reference(ChargeItem) ]
      fhir:Invoice.lineItem.chargeItemCodeableConcept [ CodeableConcept ]
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ], ...;

    fhir:Invoice.lineItem.priceComponent [ MonetaryComponent ], ... ; # 0..* Components of total line item price

  ], ...;
  fhir:

  fhir:Invoice.totalPriceComponent [ MonetaryComponent ], ... ; # 0..* Components of Invoice total

  fhir:Invoice.totalNet [ Money ]; # 0..1 Net total of this Invoice
  fhir:Invoice.totalGross [ Money ]; # 0..1 Gross total of this Invoice
  fhir:Invoice.paymentTerms [ markdown ]; # 0..1 Payment details
  fhir:Invoice.note [ Annotation ], ... ; # 0..* Comments made about the invoice
]

Changes since Release 4

Invoice
Invoice.creation
  • No Changes Added Element
Invoice.period[x]
  • Added Element
Invoice.lineItem.serviced[x]
  • Added Element
Invoice.lineItem.priceComponent
  • Type changed from BackboneElement to MonetaryComponent
  • Type changed from BackboneElement to MonetaryComponent
Invoice.totalPriceComponent
  • Add Type MonetaryComponent, MonetaryComponent
  • Add Type MonetaryComponent, MonetaryComponent
Invoice.lineItem.priceComponent.type
  • deleted
Invoice.lineItem.priceComponent.code
  • deleted
Invoice.lineItem.priceComponent.factor
  • deleted
Invoice.lineItem.priceComponent.amount
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

8.30.4.1 Terminology Bindings

Invoice.lineItem.priceComponent.type Required InvoicePriceComponentType
Path Definition Type Reference
Invoice.status

Codes identifying the lifecycle stage of an Invoice.

Required InvoiceStatus

8.30.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
account reference Account that is being balanced Invoice.account
( Account )
date date Invoice date / posting date Invoice.date
identifier token Business Identifier for item Invoice.identifier
issuer reference Issuing Organization of Invoice Invoice.issuer
( Organization )
participant reference Individual who was involved Invoice.participant.actor
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson )
participant-role token Type of involvement in creation of this Invoice Invoice.participant.role
patient reference Recipient(s) of goods and services Invoice.subject.where(resolve() is Patient)
( Patient )
recipient reference Recipient of this invoice Invoice.recipient
( Organization , Patient , RelatedPerson )
status token draft | issued | balanced | cancelled | entered-in-error Invoice.status
subject reference Recipient(s) of goods and services Invoice.subject
( Group , Patient )
totalgross quantity Gross total of this Invoice Invoice.totalGross
totalnet quantity Net total of this Invoice Invoice.totalNet
type token Type of Invoice Invoice.type