Package org.hl7.fhir.r5.model

Class Invoice.InvoiceLineItemComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.Invoice.InvoiceLineItemComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Invoice

public static class Invoice.InvoiceLineItemComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected DataType	chargeItem	The ChargeItem contains information such as the billing code, date, amount etc.
protected List<MonetaryComponent>	priceComponent	The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions.
protected PositiveIntType	sequence	Sequence in which the items appear on the invoice.
protected DataType	serviced	Date/time(s) range when this service was delivered or completed.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
InvoiceLineItemComponent()	Constructor
InvoiceLineItemComponent(DataType chargeItem)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
MonetaryComponent	addPriceComponent()
Invoice.InvoiceLineItemComponent	addPriceComponent(MonetaryComponent t)
Invoice.InvoiceLineItemComponent	copy()
void	copyValues(Invoice.InvoiceLineItemComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
DataType	getChargeItem()
CodeableConcept	getChargeItemCodeableConcept()
Reference	getChargeItemReference()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<MonetaryComponent>	getPriceComponent()
MonetaryComponent	getPriceComponentFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
int	getSequence()
PositiveIntType	getSequenceElement()
DataType	getServiced()
DateType	getServicedDateType()
Period	getServicedPeriod()
String[]	getTypesForProperty(int hash, String name)
boolean	hasChargeItem()
boolean	hasChargeItemCodeableConcept()
boolean	hasChargeItemReference()
boolean	hasPriceComponent()
boolean	hasSequence()
boolean	hasSequenceElement()
boolean	hasServiced()
boolean	hasServicedDateType()
boolean	hasServicedPeriod()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Invoice.InvoiceLineItemComponent	setChargeItem(DataType value)
Invoice.InvoiceLineItemComponent	setPriceComponent(List<MonetaryComponent> thePriceComponent)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Invoice.InvoiceLineItemComponent	setSequence(int value)
Invoice.InvoiceLineItemComponent	setSequenceElement(PositiveIntType value)
Invoice.InvoiceLineItemComponent	setServiced(DataType value)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

sequence

protected PositiveIntType sequence

Sequence in which the items appear on the invoice.

serviced

protected DataType serviced

Date/time(s) range when this service was delivered or completed.

chargeItem

protected DataType 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.

priceComponent

protected List<MonetaryComponent> 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.

Constructor Details

InvoiceLineItemComponent

public InvoiceLineItemComponent()

Constructor

InvoiceLineItemComponent

public InvoiceLineItemComponent(DataType chargeItem)

Constructor

Method Details

getSequenceElement

public PositiveIntType getSequenceElement()

Returns:

sequence (Sequence in which the items appear on the invoice.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

hasSequenceElement

public boolean hasSequenceElement()

hasSequence

public boolean hasSequence()

setSequenceElement

public Invoice.InvoiceLineItemComponent setSequenceElement(PositiveIntType value)

Parameters:

value - sequence (Sequence in which the items appear on the invoice.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

getSequence

public int getSequence()

Returns:

Sequence in which the items appear on the invoice.

setSequence

public Invoice.InvoiceLineItemComponent setSequence(int value)

Parameters:

value - Sequence in which the items appear on the invoice.

getServiced

public DataType getServiced()

Returns:

serviced (Date/time(s) range when this service was delivered or completed.)

getServicedDateType

public DateType getServicedDateType()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

serviced (Date/time(s) range when this service was delivered or completed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasServicedDateType

public boolean hasServicedDateType()

getServicedPeriod

public Period getServicedPeriod()
                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

serviced (Date/time(s) range when this service was delivered or completed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasServicedPeriod

public boolean hasServicedPeriod()

hasServiced

public boolean hasServiced()

setServiced

public Invoice.InvoiceLineItemComponent setServiced(DataType value)

Parameters:

value - serviced (Date/time(s) range when this service was delivered or completed.)

getChargeItem

public DataType getChargeItem()

Returns:

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

getChargeItemReference

public Reference getChargeItemReference()
                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasChargeItemReference

public boolean hasChargeItemReference()

getChargeItemCodeableConcept

public CodeableConcept getChargeItemCodeableConcept()
                                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasChargeItemCodeableConcept

public boolean hasChargeItemCodeableConcept()

hasChargeItem

public boolean hasChargeItem()

setChargeItem

public Invoice.InvoiceLineItemComponent setChargeItem(DataType value)

Parameters:

value - 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.)

getPriceComponent

public List<MonetaryComponent> getPriceComponent()

Returns:

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

setPriceComponent

public Invoice.InvoiceLineItemComponent setPriceComponent(List<MonetaryComponent> thePriceComponent)

Returns:

Returns a reference to this for easy method chaining

hasPriceComponent

public boolean hasPriceComponent()

addPriceComponent

public MonetaryComponent addPriceComponent()

addPriceComponent

public Invoice.InvoiceLineItemComponent addPriceComponent(MonetaryComponent t)

getPriceComponentFirstRep

public MonetaryComponent getPriceComponentFirstRep()

Returns:

The first repetition of repeating field priceComponent, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Invoice.InvoiceLineItemComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Invoice.InvoiceLineItemComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)