Skip to main content

Invoice

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. If the element is present, it must have either a @value, an @id, or extensions

type Invoice implements Resource {
  identifier: [Identifier]
  status: String
  cancelledReason: String
  type: CodeableConcept
  subject: Reference
  recipient: Reference
  date: Date
  participant: [InvoiceParticipant]
  issuer: Reference
  account: Reference
  lineItem: [InvoiceLineItem]
  totalPriceComponent: [InvoicePriceComponent]
  totalNet: Money
  totalGross: Money
  paymentTerms: String
  note: [Annotation]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

Invoice.identifier ● [Identifier] list object​

Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.

Invoice.status ● String scalar​

The current state of the Invoice.

Invoice.cancelledReason ● String scalar​

In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).

Invoice.type ● CodeableConcept object​

Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

Invoice.subject ● Reference object​

The individual or set of individuals receiving the goods and services billed in this invoice.

Invoice.recipient ● Reference object​

The individual or Organization responsible for balancing of this invoice.

Invoice.date ● Date scalar​

Date/time(s) of when this Invoice was posted.

Invoice.participant ● [InvoiceParticipant] list object​

Indicates who or what performed or participated in the charged service.

Invoice.issuer ● Reference object​

The organizationissuing the Invoice.

Invoice.account ● Reference object​

Account which is supposed to be balanced with this Invoice.

Invoice.lineItem ● [InvoiceLineItem] list object​

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.

Invoice.totalPriceComponent ● [InvoicePriceComponent] list object​

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.

Invoice.totalNet ● Money object​

Invoice total , taxes excluded.

Invoice.totalGross ● Money object​

Invoice total, tax included.

Invoice.paymentTerms ● String scalar​

Payment details such as banking details, period of payment, deductibles, methods of payment.

Invoice.note ● [Annotation] list object​

Comments made about the invoice by the issuer, subject, or other participants.

Invoice.text ● Narrative object​

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. 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.contained ● [Resource] list interface​

These 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.extension ● [Extension] list object​

May 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.modifierExtension ● [Extension] list object​

May 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.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Invoice.meta ● Meta object​

The 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.implicitRules ● Uri scalar​

A 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.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

Invoice query ● InvoiceCreate mutation ● InvoiceList query ● InvoiceUpdate mutation