Invoice

ResourceFinancial · BillingTrial useMaturity 0

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

13 of 13 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business Identifier for item
statusRequired?!Σ	1..1	code	draft | issued | balanced | cancelled | entered-in-errorBinding (required): invoice-status
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
dateΣ	0..1	dateTime	Invoice date / posting date
participant	0..*	BackboneElement	Participant in creation of this Invoice
role	0..1	CodeableConcept	Type of involvement in creation of this Invoice
actorRequired	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]Required	1..1	Reference(ChargeItem) | CodeableConcept	Reference to ChargeItem containing details of this line item or an inline billing code
priceComponent	0..*	BackboneElement	Components of total line item price
typeRequired	1..1	code	base | surcharge | deduction | discount | tax | informationalBinding (required): invoice-priceComponentType
code	0..1	CodeableConcept	Code identifying the specific component
factor	0..1	decimal	Factor used for calculating this component
amount	0..1	Money	Monetary amount associated with this component
totalPriceComponent	0..*	Same as Invoice.lineItem.priceComponent	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

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Invoice?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
account	reference	Account that is being balanced Invoice.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
participant	reference	Individual who was involved Invoice.participant.actor
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)
recipient	reference	Recipient of this invoice Invoice.recipient
status	token	draft | issued | balanced | cancelled | entered-in-error Invoice.status
subject	reference	Recipient(s) of goods and services Invoice.subject
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

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition