0% found this document useful (0 votes)
10 views17 pages

FHIR Invoice Structure Definition Guide

The document outlines the FHIR Structure Definition for an Invoice resource, which includes details about collected ChargeItems from an Account along with calculated prices for billing purposes. It specifies various properties, types, and requirements for the Invoice, including metadata, status, participants, and payment terms. The document is currently in draft status and is intended for use in the financial management domain of healthcare.

Uploaded by

qtt2nvhj55
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as XLSX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
10 views17 pages

FHIR Invoice Structure Definition Guide

The document outlines the FHIR Structure Definition for an Invoice resource, which includes details about collected ChargeItems from an Account along with calculated prices for billing purposes. It specifies various properties, types, and requirements for the Invoice, including metadata, status, participants, and payment terms. The document is currently in draft status and is intended for use in the financial management domain of healthcare.

Uploaded by

qtt2nvhj55
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as XLSX, PDF, TXT or read online on Scribd

Property

URL
Version
Name
Title
Status
Experimental
Date
Publisher
Contact
Contact
Jurisdiction
Description
Purpose
Copyright
FHIR Version
Kind
Type
Base Definition
Abstract
Derivation
Value
[Link]
6.0.0-ballot3
Invoice

draft
false
2025-08-25T21:44:10+00:00
HL7 International / Financial Management
null ([Link]
null ([Link]
World
Invoice containing collected ChargeItems from an Account with calculated individual and total price
for Billing purpose.

6.0.0-ballot3
resource
Invoice
[Link]
false
specialization
ID Path Label Min Max Must Support?
Invoice Invoice 0 *
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 *
[Link] [Link] 0 *
[Link] [Link] 0 *
[Link] [Link] 0 *
[Link] [Link] 1 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link][x] [Link][x] 0 1
[Link] [Link] 0 *
[Link] [Link] 0 1
[Link] [Link] 0 *
[Link] [Link] 0 *
[Link] [Link] 0 1
[Link] [Link] 1 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 *
[Link] [Link] 0 1
[Link] [Link] 0 *
[Link] [Link] 0 *
[Link] [Link] 0 1
[Link][x] [Link][x] 0 1
[Link][x] [Link][x] 1 1
[Link] [Link] 0 *
[Link] [Link] 0 *
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 1
[Link] [Link] 0 *
Is Modifier? Is Summary?

Y
Y
Y Y

Y Y
Y
Y Y

Y
Y
Y

Y
Y

Y Y

Y Y

Y
Y
Type(s)

id
Meta
uri
code
Narrative
Resource
Extension
Extension
Identifier
code
string
CodeableConcept
Reference(Patient|Group)
Reference(Organization|Patient|RelatedPerson)
dateTime
dateTime
date
Period
BackboneElement
string
Extension
Extension
CodeableConcept
Reference(Practitioner|Organization|Patient|PractitionerRole|Device|
RelatedPerson)
Reference(Organization)
Reference(Account)
BackboneElement
string
Extension
Extension
positiveInt
date
Period
Reference(ChargeItem)
CodeableConcept
MonetaryComponent
MonetaryComponent
Money
Money
markdown
Annotation
Short
Invoice containing ChargeItems from an Account
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for item
draft | issued | balanced | cancelled | entered-in-error
Reason for cancellation of this Invoice
Type of Invoice
Recipient(s) of goods and services
Recipient of this invoice
DEPRICATED
When posted
Billing date or period
Participant in creation of this Invoice
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of involvement in creation of this Invoice
Individual who was involved
Issuing Organization of Invoice
Account that is being balanced
Line items of this Invoice
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Sequence number of line item
Service data or period
Reference to ChargeItem containing details of this line item or an inline billing code
Components of total line item price
Components of Invoice total
Net total of this Invoice
Gross total of this Invoice
Payment details
Comments made about the invoice
Definition
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not
always be associated
A reference to a set ofwith
rulesversion changes
that were to the
followed resource.
when the resource was constructed, and which must be understood when
processing
The base language in which the resource is written. an implementation guide that defines the special rules along with other
the content. Often, this is a reference to
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the
resource to a human.
These resources The
do not narrative
have need not encode
an independent all the
existence structured
apart from the data, but is
resource required
that contains to contain sufficient
them - they cannot detail
be to
identified
May be usedindependently,
to representnor can theyinformation
additional have their that
ownisindependent transaction
not part of the scope. of
basic definition This
theisresource.
allowed toTobemake
a Parameters
the use of
extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies Though
the
understanding
Identifier of thisofInvoice,
the element
often that
usedcontains it and/or
for reference the understanding
in correspondence of the
about thiscontaining
invoice orelement's descendants.
for tracking of [Link]
The current state of the Invoice.
In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
The individual or set of individuals receiving the goods and services billed in this invoice.
The individual or Organization responsible for balancing of this invoice.
Depricared by the element below.
Date/time(s) of when this Invoice was posted.
Date/time(s) range of services included in this invoice.
Indicates who or what performed or participated in the charged service.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain
spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of
extensions
May be used safe and managable,
to represent there
additional is a strict that
information set ofis governance applied
not part of the basic to the definition
definition of the and use of
element extensions.
and Though
that modifies the
understanding of the element in which it is contained and/or the understanding of the containing element's
Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the descendants.
Participant
The device,may be a billing
practitioner, [Link] or anotherorkind
who performed of [Link] the service.
participated
The organizationissuing the Invoice.
Account which is supposed to be balanced with this Invoice.
Each line item represents one charge for goods and services rendered. Details [Link](date), code and amount are
found inidthe
Unique forreferenced
the element ChargeItem resource.
within a resource (for internal references). This may be any string value that does not contain
spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of
extensions
May be used safe and managable,
to represent there
additional is a strict that
information set of
is governance applied
not part of the basic to the definition
definition of the and use of
element andextensions. Though
that modifies the
understanding of the element in which it is
Sequence in which the items appear on the invoice. contained and/or the understanding of the containing element's descendants.
Date/time(s) range when this service was delivered or completed.
The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the
lineItem,
The priceinline
for a billing codes may
ChargeItem can bebe added
calculatedusing
asthe CodeableConcept
a base data type instead ofthat
price with surcharges/deductions the apply
Reference.
in certain conditions. A
ChargeItemDefinition
The total amount for theresource
Invoicethat
maydefines the prices,
be calculated factors
as the sumand conditions
of the that
line items apply
with to a billing code is currently
surcharges/deductions under
that apply in
certain conditions.
Invoice total , taxes The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the
excluded.
Invoice total, tax included.
Payment details such as banking details, period of payment, deductibles, methods of payment.
Comments made about the invoice by the issuer, subject, or other participants.
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional
update. Otherwise, the use of the resouce id depends on the given use case.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the
usefulness
Language isofprovided
the data to
in support
the longindexing
term. However, the existing
and accessibility health eco-system
(typically, is highly
services such as textfractured,
to speechandusenot
theyet ready totag).
language
The html language
Contained resources tagdoinnot
thehave
narrative appliesResources
a narrative. to the narrative. The
that are notlanguage
containedtag on the resource
SHOULD may be used
have a narrative. to specify
In some cases,the
a
resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult satisfied). This
(and
Therecontext
can bedependent) to restore itwith
no stigma associated again.
the Contained resources
use of extensions by may have profiles
any application, and tags
project, in their meta
or standard elements,
- regardless of but
the
institution
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the to
or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification
institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to

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

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

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the
institution
There canor bejurisdiction
no stigma that uses orwith
associated defines the extensions.
the use of extensionsThe
by use
any of extensions
application, is whatorallows
project, the -FHIR
standard specification
regardless of the to
institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to

Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which
Organization the the
Systems posting services have been
ChargeItems rendered.
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

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the
institution
There canor bejurisdiction
no stigma that uses orwith
associated defines the extensions.
the use of extensionsThe
by use
any of extensions
application, is whatorallows
project, the -FHIR
standard specification
regardless of the to
institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to

There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The
list
Thereprices orreason
is no are usually defined
to carry in a back
the price in thecatalogue of athe
instance of billing codes
ChargeItem (seecircumstances
unless [Link]). Derived override.
require a manual profiles may
The
list prices or are usually defined in a back catalogue of the billing codes (see [Link]). Derived profiles may
Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have
been filled.
Requirements

Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of ext
of modifier
Allows extensions]([Link]#modifierExtension).
Identification of this Invoice instance.

Links the event to the Patient context.

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

Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of ext
of modifier extensions]([Link]#modifierExtension).

Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of ext
of modifier extensions]([Link]#modifierExtension).
Default Value Meaning When Missing Fixed Value Pattern Example
Minimum Value Maximum Value Maximum Length Binding Strength

required

required
Binding Description Binding Value Set Code

IETF language tag for a human language [Link]

Codes identifying the lifecycle stage of an Invoice. [Link]


Slicing Discriminator Slicing Description Slicing Ordered Base Max
*
1
1
1
1
1
*
*
*
*
1
1
1
1
1
1
1
1
*
1
*
*
1
1
1
1
*
1
*
*
1
1
1
*
*
1
1
1
*
Condition(s)

dom-6
dom-2
dom-4dom-3dom-5

ele-1

ele-1
Constrain Mapping: Workflow Pattern Mapping: FiveWs Pattern Mapping
t(s)
dom-2:If Event [Link]
the
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All [Link]
FHIR
ele-1:All [Link]
FHIR
ele-1:All
FHIR
ele-1:All [Link] [Link][x]
FHIR
ele-1:All [Link] [Link][x]
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All [Link]
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All
FHIR
ele-1:All [Link]
FHIR
Mapping: HL7 V2 Mapping
FT1

FT1.2
Varies by domain

FT1.7
PAT in proximity to FT1 segment
PV1 in proximity to FT1 segment

EVN.5 or by domain

Varies by domain
EVN.5 or by domain
N/A

EVN.5 or by domain

EVN.5 or by domain
EVN.5 or by domain
EVN.5 or by domain
FT1.22
FT1.22

NTE
Mapping: RIM Mapping
Entity, Role, or Act,Act[moodCode=EVN]

[Link]?
N/A
N/A
N/A
.identifier
.status

.code
.participation[typeCode=SBJ].role
.inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]

.participation[typeCode=PRF].role[[Link]=INSTANCE]
n/a
n/a
N/A
.[Link]
.player
.scoper

.participation[typeCode=PRF].role[[Link]=INSTANCE]
n/a
n/a
N/A

.player
.participation[typeCode=PRF].role[[Link]=INSTANCE]
.participation[typeCode=PRF].role[[Link]=INSTANCE]

.inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN,
moodCode=EVN].value[xsi:type=ST]

You might also like