Skip to main content

Invoice

PropertyValue
Publisher
NameInvoice
URLhttp://hl7.org/fhir/StructureDefinition/Invoice
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Invoice0..*InvoiceInvoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
Invoice.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Invoice.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Invoice.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Invoice.language0..1codeThe base language in which the resource is written.
Invoice.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Invoice.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Invoice.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Invoice.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Invoice.identifier0..*IdentifierIdentifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
Invoice.status1..1codeThe current state of the Invoice.
Invoice.cancelledReason0..1stringIn case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
Invoice.type0..1CodeableConceptType of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
Invoice.subject0..1ReferenceThe individual or set of individuals receiving the goods and services billed in this invoice.
Invoice.recipient0..1ReferenceThe individual or Organization responsible for balancing of this invoice.
Invoice.date0..1dateTimeDate/time(s) of when this Invoice was posted.
Invoice.participant0..*BackboneElementIndicates who or what performed or participated in the charged service.
Invoice.participant.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Invoice.participant.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Invoice.participant.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Invoice.participant.role0..1CodeableConceptDescribes 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.
Invoice.participant.actor1..1ReferenceThe device, practitioner, etc. who performed or participated in the service.
Invoice.issuer0..1ReferenceThe organizationissuing the Invoice.
Invoice.account0..1ReferenceAccount which is supposed to be balanced with this Invoice.
Invoice.lineItem0..*BackboneElementEach line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
Invoice.lineItem.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Invoice.lineItem.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Invoice.lineItem.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Invoice.lineItem.sequence0..1positiveIntSequence in which the items appear on the invoice.
Invoice.lineItem.chargeItem[x]1..1ReferenceThe 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.
Invoice.lineItem.priceComponent0..*BackboneElementThe 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.
Invoice.lineItem.priceComponent.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Invoice.lineItem.priceComponent.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Invoice.lineItem.priceComponent.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Invoice.lineItem.priceComponent.type1..1codeThis code identifies the type of the component.
Invoice.lineItem.priceComponent.code0..1CodeableConceptA code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
Invoice.lineItem.priceComponent.factor0..1decimalThe factor that has been applied on the base price for calculating this component.
Invoice.lineItem.priceComponent.amount0..1MoneyThe amount calculated for this component.
Invoice.totalPriceComponent0..*InvoiceThe 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.
Invoice.totalNet0..1MoneyInvoice total , taxes excluded.
Invoice.totalGross0..1MoneyInvoice total, tax included.
Invoice.paymentTerms0..1markdownPayment details such as banking details, period of payment, deductibles, methods of payment.
Invoice.note0..*AnnotationComments made about the invoice by the issuer, subject, or other participants.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
accountreferenceAccount that is being balancedInvoice.account
datedateInvoice date / posting dateInvoice.date
identifiertokenBusiness Identifier for itemInvoice.identifier
issuerreferenceIssuing Organization of InvoiceInvoice.issuer
participantreferenceIndividual who was involvedInvoice.participant.actor
participant-roletokenType of involvement in creation of this InvoiceInvoice.participant.role
patientreferenceRecipient(s) of goods and servicesInvoice.subject.where(resolve() is Patient)
recipientreferenceRecipient of this invoiceInvoice.recipient
statustokendraft / issued / balanced / cancelled / entered-in-errorInvoice.status
subjectreferenceRecipient(s) of goods and servicesInvoice.subject
totalgrossquantityGross total of this InvoiceInvoice.totalGross
totalnetquantityNet total of this InvoiceInvoice.totalNet
typetokenType of InvoiceInvoice.type