java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.model.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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Invoice.InvoiceLineItemComponent`
`static class`	`Invoice.InvoiceLineItemPriceComponentComponent`
`static class`	`Invoice.InvoiceParticipantComponent`
`static class`	`Invoice.InvoicePriceComponentType`
`static class`	`Invoice.InvoicePriceComponentTypeEnumFactory`
`static class`	`Invoice.InvoiceStatus`
`static class`	`Invoice.InvoiceStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Reference`	`account`	Account which is supposed to be balanced with this Invoice.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ACCOUNT`	Fluent Client search parameter constant for account
`protected Account`	`accountTarget`	The actual object that is the target of the reference (Account which is supposed to be balanced with this Invoice.)
`protected StringType`	`cancelledReason`	In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
`protected DateTimeType`	`date`	Date/time(s) of when this Invoice was posted.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`protected List<Identifier>`	`identifier`	Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ACCOUNT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ISSUER`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PARTICIPANT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RECIPIENT`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT`	Constant for fluent queries to be used to add include statements.
`protected Reference`	`issuer`	The organizationissuing the Invoice.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ISSUER`	Fluent Client search parameter constant for issuer
`protected Organization`	`issuerTarget`	The actual object that is the target of the reference (The organizationissuing the Invoice.)
`protected List<Invoice.InvoiceLineItemComponent>`	`lineItem`	Each line item represents one charge for goods and services rendered.
`protected List<Annotation>`	`note`	Comments made about the invoice by the issuer, subject, or other participants.
`protected List<Invoice.InvoiceParticipantComponent>`	`participant`	Indicates who or what performed or participated in the charged service.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PARTICIPANT`	Fluent Client search parameter constant for participant
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PARTICIPANT_ROLE`	Fluent Client search parameter constant for participant-role
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT`	Fluent Client search parameter constant for patient
`protected MarkdownType`	`paymentTerms`	Payment details such as banking details, period of payment, deductibles, methods of payment.
`protected Reference`	`recipient`	The individual or Organization responsible for balancing of this invoice.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RECIPIENT`	Fluent Client search parameter constant for recipient
`protected Resource`	`recipientTarget`	The actual object that is the target of the reference (The individual or Organization responsible for balancing of this invoice.)
`static String`	`SP_ACCOUNT`	Search parameter: account
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_ISSUER`	Search parameter: issuer
`static String`	`SP_PARTICIPANT`	Search parameter: participant
`static String`	`SP_PARTICIPANT_ROLE`	Search parameter: participant-role
`static String`	`SP_PATIENT`	Search parameter: patient
`static String`	`SP_RECIPIENT`	Search parameter: recipient
`static String`	`SP_STATUS`	Search parameter: status
`static String`	`SP_SUBJECT`	Search parameter: subject
`static String`	`SP_TOTALGROSS`	Search parameter: totalgross
`static String`	`SP_TOTALNET`	Search parameter: totalnet
`static String`	`SP_TYPE`	Search parameter: type
`protected Enumeration<Invoice.InvoiceStatus>`	`status`	The current state of the Invoice.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status
`protected Reference`	`subject`	The individual or set of individuals receiving the goods and services billed in this invoice.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT`	Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget`	The actual object that is the target of the reference (The individual or set of individuals receiving the goods and services billed in this invoice.)
`protected Money`	`totalGross`	Invoice total, tax included.
`static ca.uhn.fhir.rest.gclient.QuantityClientParam`	`TOTALGROSS`	Fluent Client search parameter constant for totalgross
`protected Money`	`totalNet`	Invoice total , taxes excluded.
`static ca.uhn.fhir.rest.gclient.QuantityClientParam`	`TOTALNET`	Fluent Client search parameter constant for totalnet
`protected List<Invoice.InvoiceLineItemPriceComponentComponent>`	`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.
`protected CodeableConcept`	`type`	Type of Invoice depending on domain, realm an usage (e.g.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE`	Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor Description

Invoice()
Constructor

Invoice(Enumeration<Invoice.InvoiceStatus> status)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Invoice`	`addIdentifier(Identifier t)`
`Invoice.InvoiceLineItemComponent`	`addLineItem()`
`Invoice`	`addLineItem(Invoice.InvoiceLineItemComponent t)`
`Annotation`	`addNote()`
`Invoice`	`addNote(Annotation t)`
`Invoice.InvoiceParticipantComponent`	`addParticipant()`
`Invoice`	`addParticipant(Invoice.InvoiceParticipantComponent t)`
`Invoice.InvoiceLineItemPriceComponentComponent`	`addTotalPriceComponent()`
`Invoice`	`addTotalPriceComponent(Invoice.InvoiceLineItemPriceComponentComponent t)`
`Invoice`	`copy()`
`void`	`copyValues(Invoice dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Reference`	`getAccount()`
`Account`	`getAccountTarget()`
`String`	`getCancelledReason()`
`StringType`	`getCancelledReasonElement()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Reference`	`getIssuer()`
`Organization`	`getIssuerTarget()`
`List<Invoice.InvoiceLineItemComponent>`	`getLineItem()`
`Invoice.InvoiceLineItemComponent`	`getLineItemFirstRep()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`List<Invoice.InvoiceParticipantComponent>`	`getParticipant()`
`Invoice.InvoiceParticipantComponent`	`getParticipantFirstRep()`
`String`	`getPaymentTerms()`
`MarkdownType`	`getPaymentTermsElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Reference`	`getRecipient()`
`Resource`	`getRecipientTarget()`
`ResourceType`	`getResourceType()`
`Invoice.InvoiceStatus`	`getStatus()`
`Enumeration<Invoice.InvoiceStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`Money`	`getTotalGross()`
`Money`	`getTotalNet()`
`List<Invoice.InvoiceLineItemPriceComponentComponent>`	`getTotalPriceComponent()`
`Invoice.InvoiceLineItemPriceComponentComponent`	`getTotalPriceComponentFirstRep()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAccount()`
`boolean`	`hasCancelledReason()`
`boolean`	`hasCancelledReasonElement()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIssuer()`
`boolean`	`hasLineItem()`
`boolean`	`hasNote()`
`boolean`	`hasParticipant()`
`boolean`	`hasPaymentTerms()`
`boolean`	`hasPaymentTermsElement()`
`boolean`	`hasRecipient()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasTotalGross()`
`boolean`	`hasTotalNet()`
`boolean`	`hasTotalPriceComponent()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Invoice`	`setAccount(Reference value)`
`Invoice`	`setAccountTarget(Account value)`
`Invoice`	`setCancelledReason(String value)`
`Invoice`	`setCancelledReasonElement(StringType value)`
`Invoice`	`setDate(Date value)`
`Invoice`	`setDateElement(DateTimeType value)`
`Invoice`	`setIdentifier(List<Identifier> theIdentifier)`
`Invoice`	`setIssuer(Reference value)`
`Invoice`	`setIssuerTarget(Organization value)`
`Invoice`	`setLineItem(List<Invoice.InvoiceLineItemComponent> theLineItem)`
`Invoice`	`setNote(List<Annotation> theNote)`
`Invoice`	`setParticipant(List<Invoice.InvoiceParticipantComponent> theParticipant)`
`Invoice`	`setPaymentTerms(String value)`
`Invoice`	`setPaymentTermsElement(MarkdownType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Invoice`	`setRecipient(Reference value)`
`Invoice`	`setRecipientTarget(Resource value)`
`Invoice`	`setStatus(Invoice.InvoiceStatus value)`
`Invoice`	`setStatusElement(Enumeration<Invoice.InvoiceStatus> value)`
`Invoice`	`setSubject(Reference value)`
`Invoice`	`setSubjectTarget(Resource value)`
`Invoice`	`setTotalGross(Money value)`
`Invoice`	`setTotalNet(Money value)`
`Invoice`	`setTotalPriceComponent(List<Invoice.InvoiceLineItemPriceComponentComponent> theTotalPriceComponent)`
`Invoice`	`setType(CodeableConcept value)`
`protected Invoice`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
  - status
```
protected Enumeration<Invoice.InvoiceStatus> status
```
    The current state of the Invoice.
  - cancelledReason
```
protected StringType 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.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (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.
  - recipientTarget
```
protected Resource recipientTarget
```
    The actual object that is the target of the reference (The individual or Organization responsible for balancing of this invoice.)
  - date
```
protected DateTimeType date
```
    Date/time(s) of when this Invoice was posted.
  - participant
```
protected List<Invoice.InvoiceParticipantComponent> participant
```
    Indicates who or what performed or participated in the charged service.
  - issuer
```
protected Reference issuer
```
    The organizationissuing the Invoice.
  - issuerTarget
```
protected Organization issuerTarget
```
    The actual object that is the target of the reference (The organizationissuing the Invoice.)
  - account
```
protected Reference account
```
    Account which is supposed to be balanced with this Invoice.
  - accountTarget
```
protected Account accountTarget
```
    The actual object that is the target of the reference (Account which is supposed to be balanced with this Invoice.)
  - lineItem
```
protected List<Invoice.InvoiceLineItemComponent> 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
```
protected List<Invoice.InvoiceLineItemPriceComponentComponent> 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
```
protected MarkdownType 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_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Invoice date / posting date
    Type: date
    Path: Invoice.date
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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_TOTALGROSS
```
public static final String SP_TOTALGROSS
```
    Search parameter: totalgross
    Description: Gross total of this Invoice
    Type: quantity
    Path: Invoice.totalGross
    
    See Also:
    
    Constant Field Values
  - 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_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: Recipient(s) of goods and services
    Type: reference
    Path: Invoice.subject
    
    See Also:
    
    Constant Field Values
  - 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_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:
    
    Constant Field Values
  - 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_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: Type of Invoice
    Type: token
    Path: Invoice.type
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_ISSUER
```
public static final String SP_ISSUER
```
    Search parameter: issuer
    Description: Issuing Organization of Invoice
    Type: reference
    Path: Invoice.issuer
    
    See Also:
    
    Constant Field Values
  - 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
```
public static final String SP_PARTICIPANT
```
    Search parameter: participant
    Description: Individual who was involved
    Type: reference
    Path: Invoice.participant.actor
    
    See Also:
    
    Constant Field Values
  - 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_TOTALNET
```
public static final String SP_TOTALNET
```
    Search parameter: totalnet
    Description: Net total of this Invoice
    Type: quantity
    Path: Invoice.totalNet
    
    See Also:
    
    Constant Field Values
  - 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_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Recipient(s) of goods and services
    Type: reference
    Path: Invoice.subject
    
    See Also:
    
    Constant Field Values
  - 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
  - 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:
    
    Constant Field Values
  - 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_ACCOUNT
```
public static final String SP_ACCOUNT
```
    Search parameter: account
    Description: Account that is being balanced
    Type: reference
    Path: Invoice.account
    
    See Also:
    
    Constant Field Values
  - 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_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:
    
    Constant Field Values
  - 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
- Constructor Detail
  - Invoice
```
public Invoice()
```
    Constructor
  - Invoice
```
public Invoice(Enumeration<Invoice.InvoiceStatus> status)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.)
  - setIdentifier
```
public Invoice setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Invoice addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getStatusElement
```
public Enumeration<Invoice.InvoiceStatus> getStatusElement()
```
    Returns:
    
    status (The current state of the Invoice.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Invoice setStatusElement(Enumeration<Invoice.InvoiceStatus> value)
```
    Parameters:
    
    value - status (The current state of the Invoice.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Invoice.InvoiceStatus getStatus()
```
    Returns:
    
    The current state of the Invoice.
  - setStatus
```
public Invoice setStatus(Invoice.InvoiceStatus value)
```
    Parameters:
    
    value - The current state of the Invoice.
  - getCancelledReasonElement
```
public StringType getCancelledReasonElement()
```
    Returns:
    
    cancelledReason (In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).). This is the underlying object with id, value and extensions. The accessor "getCancelledReason" gives direct access to the value
  - hasCancelledReasonElement
```
public boolean hasCancelledReasonElement()
```
  - hasCancelledReason
```
public boolean hasCancelledReason()
```
  - setCancelledReasonElement
```
public Invoice setCancelledReasonElement(StringType value)
```
    Parameters:
    
    value - cancelledReason (In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).). This is the underlying object with id, value and extensions. The accessor "getCancelledReason" gives direct access to the value
  - getCancelledReason
```
public String getCancelledReason()
```
    Returns:
    
    In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
  - setCancelledReason
```
public Invoice setCancelledReason(String value)
```
    Parameters:
    
    value - In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Invoice setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The individual or set of individuals receiving the goods and services billed in this invoice.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Invoice setSubject(Reference value)
```
    Parameters:
    
    value - subject (The individual or set of individuals receiving the goods and services billed in this invoice.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual or set of individuals receiving the goods and services billed in this invoice.)
  - setSubjectTarget
```
public Invoice setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual or set of individuals receiving the goods and services billed in this invoice.)
  - getRecipient
```
public Reference getRecipient()
```
    Returns:
    
    recipient (The individual or Organization responsible for balancing of this invoice.)
  - hasRecipient
```
public boolean hasRecipient()
```
  - setRecipient
```
public Invoice setRecipient(Reference value)
```
    Parameters:
    
    value - recipient (The individual or Organization responsible for balancing of this invoice.)
  - getRecipientTarget
```
public Resource getRecipientTarget()
```
    Returns:
    
    recipient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual or Organization responsible for balancing of this invoice.)
  - setRecipientTarget
```
public Invoice setRecipientTarget(Resource value)
```
    Parameters:
    
    value - recipient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual or Organization responsible for balancing of this invoice.)
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (Date/time(s) of when this Invoice was posted.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - hasDateElement
```
public boolean hasDateElement()
```
  - hasDate
```
public boolean hasDate()
```
  - setDateElement
```
public Invoice setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (Date/time(s) of when this Invoice was posted.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    Date/time(s) of when this Invoice was posted.
  - setDate
```
public Invoice setDate(Date value)
```
    Parameters:
    
    value - Date/time(s) of when this Invoice was posted.
  - getParticipant
```
public List<Invoice.InvoiceParticipantComponent> getParticipant()
```
    Returns:
    
    participant (Indicates who or what performed or participated in the charged service.)
  - setParticipant
```
public Invoice setParticipant(List<Invoice.InvoiceParticipantComponent> theParticipant)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasParticipant
```
public boolean hasParticipant()
```
  - addParticipant
```
public Invoice.InvoiceParticipantComponent addParticipant()
```
  - addParticipant
```
public Invoice addParticipant(Invoice.InvoiceParticipantComponent t)
```
  - getParticipantFirstRep
```
public Invoice.InvoiceParticipantComponent getParticipantFirstRep()
```
    Returns:
    
    The first repetition of repeating field participant, creating it if it does not already exist
  - getIssuer
```
public Reference getIssuer()
```
    Returns:
    
    issuer (The organizationissuing the Invoice.)
  - hasIssuer
```
public boolean hasIssuer()
```
  - setIssuer
```
public Invoice setIssuer(Reference value)
```
    Parameters:
    
    value - issuer (The organizationissuing the Invoice.)
  - getIssuerTarget
```
public Organization getIssuerTarget()
```
    Returns:
    
    issuer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organizationissuing the Invoice.)
  - setIssuerTarget
```
public Invoice setIssuerTarget(Organization value)
```
    Parameters:
    
    value - issuer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organizationissuing the Invoice.)
  - getAccount
```
public Reference getAccount()
```
    Returns:
    
    account (Account which is supposed to be balanced with this Invoice.)
  - hasAccount
```
public boolean hasAccount()
```
  - setAccount
```
public Invoice setAccount(Reference value)
```
    Parameters:
    
    value - account (Account which is supposed to be balanced with this Invoice.)
  - getAccountTarget
```
public Account getAccountTarget()
```
    Returns:
    
    account The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Account which is supposed to be balanced with this Invoice.)
  - setAccountTarget
```
public Invoice setAccountTarget(Account value)
```
    Parameters:
    
    value - account The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Account which is supposed to be balanced with this Invoice.)
  - getLineItem
```
public List<Invoice.InvoiceLineItemComponent> getLineItem()
```
    Returns:
    
    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.)
  - setLineItem
```
public Invoice setLineItem(List<Invoice.InvoiceLineItemComponent> theLineItem)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasLineItem
```
public boolean hasLineItem()
```
  - addLineItem
```
public Invoice.InvoiceLineItemComponent addLineItem()
```
  - addLineItem
```
public Invoice addLineItem(Invoice.InvoiceLineItemComponent t)
```
  - getLineItemFirstRep
```
public Invoice.InvoiceLineItemComponent getLineItemFirstRep()
```
    Returns:
    
    The first repetition of repeating field lineItem, creating it if it does not already exist
  - getTotalPriceComponent
```
public List<Invoice.InvoiceLineItemPriceComponentComponent> getTotalPriceComponent()
```
    Returns:
    
    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.)
  - setTotalPriceComponent
```
public Invoice setTotalPriceComponent(List<Invoice.InvoiceLineItemPriceComponentComponent> theTotalPriceComponent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasTotalPriceComponent
```
public boolean hasTotalPriceComponent()
```
  - addTotalPriceComponent
```
public Invoice.InvoiceLineItemPriceComponentComponent addTotalPriceComponent()
```
  - addTotalPriceComponent
```
public Invoice addTotalPriceComponent(Invoice.InvoiceLineItemPriceComponentComponent t)
```
  - getTotalPriceComponentFirstRep
```
public Invoice.InvoiceLineItemPriceComponentComponent getTotalPriceComponentFirstRep()
```
    Returns:
    
    The first repetition of repeating field totalPriceComponent, creating it if it does not already exist
  - getTotalNet
```
public Money getTotalNet()
```
    Returns:
    
    totalNet (Invoice total , taxes excluded.)
  - hasTotalNet
```
public boolean hasTotalNet()
```
  - setTotalNet
```
public Invoice setTotalNet(Money value)
```
    Parameters:
    
    value - totalNet (Invoice total , taxes excluded.)
  - getTotalGross
```
public Money getTotalGross()
```
    Returns:
    
    totalGross (Invoice total, tax included.)
  - hasTotalGross
```
public boolean hasTotalGross()
```
  - setTotalGross
```
public Invoice setTotalGross(Money value)
```
    Parameters:
    
    value - totalGross (Invoice total, tax included.)
  - getPaymentTermsElement
```
public MarkdownType getPaymentTermsElement()
```
    Returns:
    
    paymentTerms (Payment details such as banking details, period of payment, deductibles, methods of payment.). This is the underlying object with id, value and extensions. The accessor "getPaymentTerms" gives direct access to the value
  - hasPaymentTermsElement
```
public boolean hasPaymentTermsElement()
```
  - hasPaymentTerms
```
public boolean hasPaymentTerms()
```
  - setPaymentTermsElement
```
public Invoice setPaymentTermsElement(MarkdownType value)
```
    Parameters:
    
    value - paymentTerms (Payment details such as banking details, period of payment, deductibles, methods of payment.). This is the underlying object with id, value and extensions. The accessor "getPaymentTerms" gives direct access to the value
  - getPaymentTerms
```
public String getPaymentTerms()
```
    Returns:
    
    Payment details such as banking details, period of payment, deductibles, methods of payment.
  - setPaymentTerms
```
public Invoice setPaymentTerms(String value)
```
    Parameters:
    
    value - Payment details such as banking details, period of payment, deductibles, methods of payment.
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Comments made about the invoice by the issuer, subject, or other participants.)
  - setNote
```
public Invoice setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public Invoice addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Invoice copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Invoice dst)
```
  - typedCopy
```
protected Invoice typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Constructor	Description
`Invoice()`	Constructor
`Invoice(Enumeration<Invoice.InvoiceStatus> status)`	Constructor

Class Invoice

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

Methods inherited from class org.hl7.fhir.r4.model.Resource

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

identifier

status

cancelledReason

type

subject

subjectTarget

recipient

recipientTarget

date

participant

issuer

issuerTarget

account

accountTarget

lineItem

totalPriceComponent

totalNet

totalGross

paymentTerms

note

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_TOTALGROSS

TOTALGROSS

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_PARTICIPANT_ROLE

PARTICIPANT_ROLE

SP_TYPE

TYPE

SP_ISSUER

ISSUER

INCLUDE_ISSUER

SP_PARTICIPANT

PARTICIPANT

INCLUDE_PARTICIPANT

SP_TOTALNET

TOTALNET

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_RECIPIENT

RECIPIENT

INCLUDE_RECIPIENT

SP_ACCOUNT

ACCOUNT

INCLUDE_ACCOUNT

SP_STATUS

STATUS

Constructor Detail

Invoice

Invoice

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep