Invoice constructor

const Invoice({
  1. @Default(R5ResourceType.Invoice) @JsonKey(unknownEnumValue: R5ResourceType.Invoice) R5ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') FhirId? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. List<Identifier>? identifier,
  14. FhirCode? status,
  15. @JsonKey(name: '_status') Element? statusElement,
  16. String? cancelledReason,
  17. @JsonKey(name: '_cancelledReason') Element? cancelledReasonElement,
  18. CodeableConcept? type,
  19. Reference? subject,
  20. Reference? recipient,
  21. FhirDateTime? date,
  22. @JsonKey(name: '_date') Element? dateElement,
  23. FhirDateTime? creation,
  24. @JsonKey(name: '_creation') Element? creationElement,
  25. FhirDate? periodDate,
  26. @JsonKey(name: '_periodDate') Element? periodDateElement,
  27. Period? periodPeriod,
  28. List<InvoiceParticipant>? participant,
  29. Reference? issuer,
  30. Reference? account,
  31. List<InvoiceLineItem>? lineItem,
  32. List<MonetaryComponent>? totalPriceComponent,
  33. Money? totalNet,
  34. Money? totalGross,
  35. FhirMarkdown? paymentTerms,
  36. @JsonKey(name: '_paymentTerms') Element? paymentTermsElement,
  37. List<Annotation>? note,
})

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

resourceType This is a Invoice resource

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

meta 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.

implicitRules 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.

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

text 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.

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

extension_ ("extension") 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 managable, 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.

modifierExtension 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 managable, 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).

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

status The current state of the Invoice.

statusElement ("_status") Extensions for status

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

cancelledReasonElement ("_cancelledReason") Extensions for cancelledReason

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

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

recipient The individual or Organization responsible for balancing of this invoice.

date Depricared by the element below.

dateElement ("_date") Extensions for date

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

creationElement ("_creation") Extensions for creation

periodDate Date/time(s) range of services included in this invoice.

periodDateElement ("_periodDate") Extensions for periodDate

periodPeriod Date/time(s) range of services included in this invoice.

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

issuer The organizationissuing the Invoice.

account Account which is supposed to be balanced with this Invoice.

lineItem Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.

totalPriceComponent 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.

totalNet Invoice total , taxes excluded.

totalGross Invoice total, tax included.

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

paymentTermsElement ("_paymentTerms") Extensions for paymentTerms

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

Implementation

const factory Invoice({
  /// [resourceType] This is a Invoice resource
  @Default(R5ResourceType.Invoice)
  @JsonKey(unknownEnumValue: R5ResourceType.Invoice)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [meta] 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.
  FhirMeta? meta,

  /// [implicitRules] 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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] 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.
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart
  ///  from the resource that contains them - they cannot be identified
  ///  independently, nor can they have their own independent transaction
  ///  scope. This is allowed to be a Parameters resource if and only if it
  ///  is referenced by a resource that provides context/meaning.
  List<Resource>? contained,

  /// [extension_] ("extension") 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 managable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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 managable, 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).
  List<FhirExtension>? modifierExtension,

  /// [identifier] Identifier of this Invoice, often used for reference in
  ///  correspondence about this invoice or for tracking of payments.
  List<Identifier>? identifier,

  /// [status] The current state of the Invoice.
  FhirCode? status,

  /// [statusElement] ("_status") Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [cancelledReason] In case of Invoice cancellation a reason must be
  ///  given (entered in error, superseded by corrected invoice etc.).
  String? cancelledReason,

  /// [cancelledReasonElement] ("_cancelledReason") Extensions for
  ///  cancelledReason
  @JsonKey(name: '_cancelledReason') Element? cancelledReasonElement,

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

  /// [subject] The individual or set of individuals receiving the goods and
  ///  services billed in this invoice.
  Reference? subject,

  /// [recipient] The individual or Organization responsible for balancing of
  ///  this invoice.
  Reference? recipient,

  /// [date] Depricared by the element below.
  FhirDateTime? date,

  /// [dateElement] ("_date") Extensions for date
  @JsonKey(name: '_date') Element? dateElement,

  /// [creation] Date/time(s) of when this Invoice was posted.
  FhirDateTime? creation,

  /// [creationElement] ("_creation") Extensions for creation
  @JsonKey(name: '_creation') Element? creationElement,

  /// [periodDate] Date/time(s) range of services included in this invoice.
  FhirDate? periodDate,

  /// [periodDateElement] ("_periodDate") Extensions for periodDate
  @JsonKey(name: '_periodDate') Element? periodDateElement,

  /// [periodPeriod] Date/time(s) range of services included in this invoice.
  Period? periodPeriod,

  /// [participant] Indicates who or what performed or participated in the
  ///  charged service.
  List<InvoiceParticipant>? participant,

  /// [issuer] The organizationissuing the Invoice.
  Reference? issuer,

  /// [account] Account which is supposed to be balanced with this Invoice.
  Reference? account,

  /// [lineItem] Each line item represents one charge for goods and services
  ///  rendered. Details such.ofType(date), code and amount are found in the
  ///  referenced ChargeItem resource.
  List<InvoiceLineItem>? lineItem,

  /// [totalPriceComponent] 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.
  List<MonetaryComponent>? totalPriceComponent,

  /// [totalNet] Invoice total , taxes excluded.
  Money? totalNet,

  /// [totalGross] Invoice total, tax included.
  Money? totalGross,

  /// [paymentTerms] Payment details such as banking details, period of
  ///  payment, deductibles, methods of payment.
  FhirMarkdown? paymentTerms,

  /// [paymentTermsElement] ("_paymentTerms") Extensions for paymentTerms
  @JsonKey(name: '_paymentTerms') Element? paymentTermsElement,

  /// [note] Comments made about the invoice by the issuer, subject, or other
  ///  participants.
  List<Annotation>? note,
}) = _Invoice;