Class Invoice

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Invoice extends DomainResource
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
See Also:
  • Field Details

    • 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.
    • cancelledReason

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

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

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

      protected Reference recipient
      The individual or Organization responsible for balancing of this invoice.
    • date

      protected DateTimeType date
      Depricared by the element below.
    • creation

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

      protected DataType period
      Date/time(s) range of services included in this invoice.
    • participant

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

      protected Reference issuer
      The organizationissuing the Invoice.
    • account

      protected Reference 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 as 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

      protected Money totalNet
      Invoice total , taxes excluded.
    • totalGross

      protected Money totalGross
      Invoice total, tax included.
    • paymentTerms

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

      protected List<Annotation> note
      Comments made about the invoice by the issuer, subject, or other participants.
    • SP_ACCOUNT

      public static final String SP_ACCOUNT
      Search parameter: account

      Description: Account that is being balanced
      Type: reference
      Path: Invoice.account

      See Also:
    • ACCOUNT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACCOUNT
      Fluent Client search parameter constant for account

      Description: Account that is being balanced
      Type: reference
      Path: Invoice.account

    • INCLUDE_ACCOUNT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ACCOUNT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Invoice:account".
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: Invoice date / posting date
      Type: date
      Path: Invoice.date

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: Invoice date / posting date
      Type: date
      Path: Invoice.date

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Business Identifier for item
      Type: token
      Path: Invoice.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Business Identifier for item
      Type: token
      Path: Invoice.identifier

    • SP_ISSUER

      public static final String SP_ISSUER
      Search parameter: issuer

      Description: Issuing Organization of Invoice
      Type: reference
      Path: Invoice.issuer

      See Also:
    • ISSUER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ISSUER
      Fluent Client search parameter constant for issuer

      Description: Issuing Organization of Invoice
      Type: reference
      Path: Invoice.issuer

    • INCLUDE_ISSUER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ISSUER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Invoice:issuer".
    • SP_PARTICIPANT_ROLE

      public static final String SP_PARTICIPANT_ROLE
      Search parameter: participant-role

      Description: Type of involvement in creation of this Invoice
      Type: token
      Path: Invoice.participant.role

      See Also:
    • PARTICIPANT_ROLE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARTICIPANT_ROLE
      Fluent Client search parameter constant for participant-role

      Description: Type of involvement in creation of this Invoice
      Type: token
      Path: Invoice.participant.role

    • SP_PARTICIPANT

      public static final String SP_PARTICIPANT
      Search parameter: participant

      Description: Individual who was involved
      Type: reference
      Path: Invoice.participant.actor

      See Also:
    • PARTICIPANT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
      Fluent Client search parameter constant for participant

      Description: Individual who was involved
      Type: reference
      Path: Invoice.participant.actor

    • INCLUDE_PARTICIPANT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Invoice:participant".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Recipient(s) of goods and services
      Type: reference
      Path: Invoice.subject.where(resolve() is Patient)

      See Also:
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Recipient(s) of goods and services
      Type: reference
      Path: Invoice.subject.where(resolve() is Patient)

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Invoice:patient".
    • SP_RECIPIENT

      public static final String SP_RECIPIENT
      Search parameter: recipient

      Description: Recipient of this invoice
      Type: reference
      Path: Invoice.recipient

      See Also:
    • RECIPIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECIPIENT
      Fluent Client search parameter constant for recipient

      Description: Recipient of this invoice
      Type: reference
      Path: Invoice.recipient

    • INCLUDE_RECIPIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Invoice:recipient".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: draft | issued | balanced | cancelled | entered-in-error
      Type: token
      Path: Invoice.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: draft | issued | balanced | cancelled | entered-in-error
      Type: token
      Path: Invoice.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Recipient(s) of goods and services
      Type: reference
      Path: Invoice.subject

      See Also:
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Recipient(s) of goods and services
      Type: reference
      Path: Invoice.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Invoice:subject".
    • SP_TOTALGROSS

      public static final String SP_TOTALGROSS
      Search parameter: totalgross

      Description: Gross total of this Invoice
      Type: quantity
      Path: Invoice.totalGross

      See Also:
    • TOTALGROSS

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam TOTALGROSS
      Fluent Client search parameter constant for totalgross

      Description: Gross total of this Invoice
      Type: quantity
      Path: Invoice.totalGross

    • SP_TOTALNET

      public static final String SP_TOTALNET
      Search parameter: totalnet

      Description: Net total of this Invoice
      Type: quantity
      Path: Invoice.totalNet

      See Also:
    • TOTALNET

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam TOTALNET
      Fluent Client search parameter constant for totalnet

      Description: Net total of this Invoice
      Type: quantity
      Path: Invoice.totalNet

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Type of Invoice
      Type: token
      Path: Invoice.type

      See Also:
    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: Type of Invoice
      Type: token
      Path: Invoice.type

  • Constructor Details

  • Method Details