Class Invoice.LineItem.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.Invoice.LineItem.Builder
-
- Enclosing class:
- Invoice.LineItem
public static class Invoice.LineItem.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Invoice.LineItem
build()
Build theInvoice.LineItem
Invoice.LineItem.Builder
chargeItem(Element chargeItem)
The ChargeItem contains information such as the billing code, date, amount etc.Invoice.LineItem.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.Invoice.LineItem.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Invoice.LineItem.Builder
from(Invoice.LineItem lineItem)
Invoice.LineItem.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Invoice.LineItem.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May 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.Invoice.LineItem.Builder
modifierExtension(Extension... modifierExtension)
May 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.Invoice.LineItem.Builder
priceComponent(java.util.Collection<Invoice.LineItem.PriceComponent> priceComponent)
The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions.Invoice.LineItem.Builder
priceComponent(Invoice.LineItem.PriceComponent... priceComponent)
The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions.Invoice.LineItem.Builder
sequence(PositiveInt sequence)
Sequence in which the items appear on the invoice.protected void
validate(Invoice.LineItem lineItem)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Invoice.LineItem.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public Invoice.LineItem.Builder extension(Extension... extension)
May 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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Invoice.LineItem.Builder extension(java.util.Collection<Extension> extension)
May 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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public Invoice.LineItem.Builder modifierExtension(Extension... modifierExtension)
May 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).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public Invoice.LineItem.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May 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).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
sequence
public Invoice.LineItem.Builder sequence(PositiveInt sequence)
Sequence in which the items appear on the invoice.- Parameters:
sequence
- Sequence number of line item- Returns:
- A reference to this Builder instance
-
chargeItem
public Invoice.LineItem.Builder chargeItem(Element chargeItem)
The 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.This element is required.
This is a choice element with the following allowed types:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
chargeItem
- Reference to ChargeItem containing details of this line item or an inline billing code- Returns:
- A reference to this Builder instance
-
priceComponent
public Invoice.LineItem.Builder priceComponent(Invoice.LineItem.PriceComponent... priceComponent)
The 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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
priceComponent
- Components of total line item price- Returns:
- A reference to this Builder instance
-
priceComponent
public Invoice.LineItem.Builder priceComponent(java.util.Collection<Invoice.LineItem.PriceComponent> priceComponent)
The 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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
priceComponent
- Components of total line item price- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public Invoice.LineItem build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Invoice.LineItem
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid LineItem per the base specification
-
validate
protected void validate(Invoice.LineItem lineItem)
-
from
protected Invoice.LineItem.Builder from(Invoice.LineItem lineItem)
-
-