Package org.hl7.fhir.r5.model

Class ExplanationOfBenefit.ItemComponent

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.ExplanationOfBenefit.ItemComponent

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:

ExplanationOfBenefit

public static class ExplanationOfBenefit.ItemComponent
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 List<ExplanationOfBenefit.AdjudicationComponent>	adjudication	If this item is a group then the values here are a summary of the adjudication of the detail items.
protected List<ExplanationOfBenefit.ItemBodySiteComponent>	bodySite	Physical location where the service is performed or applies.
protected List<PositiveIntType>	careTeamSequence	Care team members related to this service or product.
protected CodeableConcept	category	Code to identify the general type of benefits under which products and services are provided.
protected List<ExplanationOfBenefit.DetailComponent>	detail	Second-tier of goods and services.
protected List<PositiveIntType>	diagnosisSequence	Diagnoses applicable for this service or product.
protected List<Reference>	encounter	Healthcare encounters related to this claim.
protected DecimalType	factor	A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.
protected List<PositiveIntType>	informationSequence	Exceptions, special conditions and supporting information applicable for this service or product.
protected DataType	location	Where the product or service was provided.
protected List<CodeableConcept>	modifier	Item typification or modifiers codes to convey additional context for the product or service.
protected Money	net	The total amount claimed for the group (if a grouper) or the line item.
protected List<PositiveIntType>	noteNumber	The numbers associated with notes below which apply to the adjudication of this item.
protected Money	patientPaid	The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
protected List<PositiveIntType>	procedureSequence	Procedures applicable for this service or product.
protected CodeableConcept	productOrService	When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item.
protected CodeableConcept	productOrServiceEnd	This contains the end of a range of product, service, drug or other billing codes for the item.
protected List<CodeableConcept>	programCode	Identifies the program under which this may be recovered.
protected Quantity	quantity	The number of repetitions of a service or product.
protected List<Reference>	request	Request or Referral for Goods or Service to be rendered.
protected CodeableConcept	revenue	The type of revenue or cost center providing the product and/or service.
protected ExplanationOfBenefit.ItemReviewOutcomeComponent	reviewOutcome	The high-level results of the adjudication if adjudication has been performed.
protected PositiveIntType	sequence	A number to uniquely identify item entries.
protected DataType	serviced	The date or dates when the service or product was supplied, performed or completed.
protected Money	tax	The total of taxes applicable for this product or service.
protected List<Identifier>	traceNumber	Trace number for tracking purposes.
protected List<Reference>	udi	Unique Device Identifiers associated with this line item.
protected Money	unitPrice	If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

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
ItemComponent()	Constructor
ItemComponent(int sequence)	Constructor

Method Summary

Modifier and Type	Method	Description
ExplanationOfBenefit.AdjudicationComponent	addAdjudication()
ExplanationOfBenefit.ItemComponent	addAdjudication(ExplanationOfBenefit.AdjudicationComponent t)
ExplanationOfBenefit.ItemBodySiteComponent	addBodySite()
ExplanationOfBenefit.ItemComponent	addBodySite(ExplanationOfBenefit.ItemBodySiteComponent t)
ExplanationOfBenefit.ItemComponent	addCareTeamSequence(int value)
PositiveIntType	addCareTeamSequenceElement()
Base	addChild(String name)
ExplanationOfBenefit.DetailComponent	addDetail()
ExplanationOfBenefit.ItemComponent	addDetail(ExplanationOfBenefit.DetailComponent t)
ExplanationOfBenefit.ItemComponent	addDiagnosisSequence(int value)
PositiveIntType	addDiagnosisSequenceElement()
Reference	addEncounter()
ExplanationOfBenefit.ItemComponent	addEncounter(Reference t)
ExplanationOfBenefit.ItemComponent	addInformationSequence(int value)
PositiveIntType	addInformationSequenceElement()
CodeableConcept	addModifier()
ExplanationOfBenefit.ItemComponent	addModifier(CodeableConcept t)
ExplanationOfBenefit.ItemComponent	addNoteNumber(int value)
PositiveIntType	addNoteNumberElement()
ExplanationOfBenefit.ItemComponent	addProcedureSequence(int value)
PositiveIntType	addProcedureSequenceElement()
CodeableConcept	addProgramCode()
ExplanationOfBenefit.ItemComponent	addProgramCode(CodeableConcept t)
Reference	addRequest()
ExplanationOfBenefit.ItemComponent	addRequest(Reference t)
Identifier	addTraceNumber()
ExplanationOfBenefit.ItemComponent	addTraceNumber(Identifier t)
Reference	addUdi()
ExplanationOfBenefit.ItemComponent	addUdi(Reference t)
ExplanationOfBenefit.ItemComponent	copy()
void	copyValues(ExplanationOfBenefit.ItemComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ExplanationOfBenefit.AdjudicationComponent>	getAdjudication()
ExplanationOfBenefit.AdjudicationComponent	getAdjudicationFirstRep()
List<ExplanationOfBenefit.ItemBodySiteComponent>	getBodySite()
ExplanationOfBenefit.ItemBodySiteComponent	getBodySiteFirstRep()
List<PositiveIntType>	getCareTeamSequence()
CodeableConcept	getCategory()
List<ExplanationOfBenefit.DetailComponent>	getDetail()
ExplanationOfBenefit.DetailComponent	getDetailFirstRep()
List<PositiveIntType>	getDiagnosisSequence()
List<Reference>	getEncounter()
Reference	getEncounterFirstRep()
BigDecimal	getFactor()
DecimalType	getFactorElement()
List<PositiveIntType>	getInformationSequence()
DataType	getLocation()
Address	getLocationAddress()
CodeableConcept	getLocationCodeableConcept()
Reference	getLocationReference()
List<CodeableConcept>	getModifier()
CodeableConcept	getModifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Money	getNet()
List<PositiveIntType>	getNoteNumber()
Money	getPatientPaid()
List<PositiveIntType>	getProcedureSequence()
CodeableConcept	getProductOrService()
CodeableConcept	getProductOrServiceEnd()
List<CodeableConcept>	getProgramCode()
CodeableConcept	getProgramCodeFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
List<Reference>	getRequest()
Reference	getRequestFirstRep()
CodeableConcept	getRevenue()
ExplanationOfBenefit.ItemReviewOutcomeComponent	getReviewOutcome()
int	getSequence()
PositiveIntType	getSequenceElement()
DataType	getServiced()
DateType	getServicedDateType()
Period	getServicedPeriod()
Money	getTax()
List<Identifier>	getTraceNumber()
Identifier	getTraceNumberFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<Reference>	getUdi()
Reference	getUdiFirstRep()
Money	getUnitPrice()
boolean	hasAdjudication()
boolean	hasBodySite()
boolean	hasCareTeamSequence()
boolean	hasCareTeamSequence(int value)
boolean	hasCategory()
boolean	hasDetail()
boolean	hasDiagnosisSequence()
boolean	hasDiagnosisSequence(int value)
boolean	hasEncounter()
boolean	hasFactor()
boolean	hasFactorElement()
boolean	hasInformationSequence()
boolean	hasInformationSequence(int value)
boolean	hasLocation()
boolean	hasLocationAddress()
boolean	hasLocationCodeableConcept()
boolean	hasLocationReference()
boolean	hasModifier()
boolean	hasNet()
boolean	hasNoteNumber()
boolean	hasNoteNumber(int value)
boolean	hasPatientPaid()
boolean	hasProcedureSequence()
boolean	hasProcedureSequence(int value)
boolean	hasProductOrService()
boolean	hasProductOrServiceEnd()
boolean	hasProgramCode()
boolean	hasQuantity()
boolean	hasRequest()
boolean	hasRevenue()
boolean	hasReviewOutcome()
boolean	hasSequence()
boolean	hasSequenceElement()
boolean	hasServiced()
boolean	hasServicedDateType()
boolean	hasServicedPeriod()
boolean	hasTax()
boolean	hasTraceNumber()
boolean	hasUdi()
boolean	hasUnitPrice()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ExplanationOfBenefit.ItemComponent	setAdjudication(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication)
ExplanationOfBenefit.ItemComponent	setBodySite(List<ExplanationOfBenefit.ItemBodySiteComponent> theBodySite)
ExplanationOfBenefit.ItemComponent	setCareTeamSequence(List<PositiveIntType> theCareTeamSequence)
ExplanationOfBenefit.ItemComponent	setCategory(CodeableConcept value)
ExplanationOfBenefit.ItemComponent	setDetail(List<ExplanationOfBenefit.DetailComponent> theDetail)
ExplanationOfBenefit.ItemComponent	setDiagnosisSequence(List<PositiveIntType> theDiagnosisSequence)
ExplanationOfBenefit.ItemComponent	setEncounter(List<Reference> theEncounter)
ExplanationOfBenefit.ItemComponent	setFactor(double value)
ExplanationOfBenefit.ItemComponent	setFactor(long value)
ExplanationOfBenefit.ItemComponent	setFactor(BigDecimal value)
ExplanationOfBenefit.ItemComponent	setFactorElement(DecimalType value)
ExplanationOfBenefit.ItemComponent	setInformationSequence(List<PositiveIntType> theInformationSequence)
ExplanationOfBenefit.ItemComponent	setLocation(DataType value)
ExplanationOfBenefit.ItemComponent	setModifier(List<CodeableConcept> theModifier)
ExplanationOfBenefit.ItemComponent	setNet(Money value)
ExplanationOfBenefit.ItemComponent	setNoteNumber(List<PositiveIntType> theNoteNumber)
ExplanationOfBenefit.ItemComponent	setPatientPaid(Money value)
ExplanationOfBenefit.ItemComponent	setProcedureSequence(List<PositiveIntType> theProcedureSequence)
ExplanationOfBenefit.ItemComponent	setProductOrService(CodeableConcept value)
ExplanationOfBenefit.ItemComponent	setProductOrServiceEnd(CodeableConcept value)
ExplanationOfBenefit.ItemComponent	setProgramCode(List<CodeableConcept> theProgramCode)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ExplanationOfBenefit.ItemComponent	setQuantity(Quantity value)
ExplanationOfBenefit.ItemComponent	setRequest(List<Reference> theRequest)
ExplanationOfBenefit.ItemComponent	setRevenue(CodeableConcept value)
ExplanationOfBenefit.ItemComponent	setReviewOutcome(ExplanationOfBenefit.ItemReviewOutcomeComponent value)
ExplanationOfBenefit.ItemComponent	setSequence(int value)
ExplanationOfBenefit.ItemComponent	setSequenceElement(PositiveIntType value)
ExplanationOfBenefit.ItemComponent	setServiced(DataType value)
ExplanationOfBenefit.ItemComponent	setTax(Money value)
ExplanationOfBenefit.ItemComponent	setTraceNumber(List<Identifier> theTraceNumber)
ExplanationOfBenefit.ItemComponent	setUdi(List<Reference> theUdi)
ExplanationOfBenefit.ItemComponent	setUnitPrice(Money value)

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

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

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, 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, executeFunction, 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, setXhtml

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

A number to uniquely identify item entries.

careTeamSequence

protected List<PositiveIntType> careTeamSequence

Care team members related to this service or product.

diagnosisSequence

protected List<PositiveIntType> diagnosisSequence

Diagnoses applicable for this service or product.

procedureSequence

protected List<PositiveIntType> procedureSequence

Procedures applicable for this service or product.

informationSequence

protected List<PositiveIntType> informationSequence

Exceptions, special conditions and supporting information applicable for this service or product.

traceNumber

protected List<Identifier> traceNumber

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

revenue

protected CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

category

protected CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

productOrService

protected CodeableConcept productOrService

When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.

productOrServiceEnd

protected CodeableConcept productOrServiceEnd

This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.

request

protected List<Reference> request

Request or Referral for Goods or Service to be rendered.

modifier

protected List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

programCode

protected List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

serviced

protected DataType serviced

The date or dates when the service or product was supplied, performed or completed.

location

protected DataType location

Where the product or service was provided.

patientPaid

protected Money patientPaid

The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.

quantity

protected Quantity quantity

The number of repetitions of a service or product.

unitPrice

protected Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

factor

protected DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

tax

protected Money tax

The total of taxes applicable for this product or service.

net

protected Money net

The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.

udi

protected List<Reference> udi

Unique Device Identifiers associated with this line item.

bodySite

protected List<ExplanationOfBenefit.ItemBodySiteComponent> bodySite

Physical location where the service is performed or applies.

encounter

protected List<Reference> encounter

Healthcare encounters related to this claim.

noteNumber

protected List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

reviewOutcome

protected ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome

The high-level results of the adjudication if adjudication has been performed.

adjudication

protected List<ExplanationOfBenefit.AdjudicationComponent> adjudication

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

detail

protected List<ExplanationOfBenefit.DetailComponent> detail

Second-tier of goods and services.

Constructor Details

ItemComponent

public ItemComponent()

Constructor

ItemComponent

public ItemComponent(int sequence)

Constructor

Method Details

getSequenceElement

public PositiveIntType getSequenceElement()

Returns:

sequence (A number to uniquely identify item entries.). 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 ExplanationOfBenefit.ItemComponent setSequenceElement(PositiveIntType value)

Parameters:

value - sequence (A number to uniquely identify item entries.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

getSequence

public int getSequence()

Returns:

A number to uniquely identify item entries.

setSequence

public ExplanationOfBenefit.ItemComponent setSequence(int value)

Parameters:

value - A number to uniquely identify item entries.

getCareTeamSequence

public List<PositiveIntType> getCareTeamSequence()

Returns:

careTeamSequence (Care team members related to this service or product.)

setCareTeamSequence

public ExplanationOfBenefit.ItemComponent setCareTeamSequence(List<PositiveIntType> theCareTeamSequence)

Returns:

Returns a reference to this for easy method chaining

hasCareTeamSequence

public boolean hasCareTeamSequence()

addCareTeamSequenceElement

public PositiveIntType addCareTeamSequenceElement()

Returns:

careTeamSequence (Care team members related to this service or product.)

addCareTeamSequence

public ExplanationOfBenefit.ItemComponent addCareTeamSequence(int value)

Parameters:

value - careTeamSequence (Care team members related to this service or product.)

hasCareTeamSequence

public boolean hasCareTeamSequence(int value)

Parameters:

value - careTeamSequence (Care team members related to this service or product.)

getDiagnosisSequence

public List<PositiveIntType> getDiagnosisSequence()

Returns:

diagnosisSequence (Diagnoses applicable for this service or product.)

setDiagnosisSequence

public ExplanationOfBenefit.ItemComponent setDiagnosisSequence(List<PositiveIntType> theDiagnosisSequence)

Returns:

Returns a reference to this for easy method chaining

hasDiagnosisSequence

public boolean hasDiagnosisSequence()

addDiagnosisSequenceElement

public PositiveIntType addDiagnosisSequenceElement()

Returns:

diagnosisSequence (Diagnoses applicable for this service or product.)

addDiagnosisSequence

public ExplanationOfBenefit.ItemComponent addDiagnosisSequence(int value)

Parameters:

value - diagnosisSequence (Diagnoses applicable for this service or product.)

hasDiagnosisSequence

public boolean hasDiagnosisSequence(int value)

Parameters:

value - diagnosisSequence (Diagnoses applicable for this service or product.)

getProcedureSequence

public List<PositiveIntType> getProcedureSequence()

Returns:

procedureSequence (Procedures applicable for this service or product.)

setProcedureSequence

public ExplanationOfBenefit.ItemComponent setProcedureSequence(List<PositiveIntType> theProcedureSequence)

Returns:

Returns a reference to this for easy method chaining

hasProcedureSequence

public boolean hasProcedureSequence()

addProcedureSequenceElement

public PositiveIntType addProcedureSequenceElement()

Returns:

procedureSequence (Procedures applicable for this service or product.)

addProcedureSequence

public ExplanationOfBenefit.ItemComponent addProcedureSequence(int value)

Parameters:

value - procedureSequence (Procedures applicable for this service or product.)

hasProcedureSequence

public boolean hasProcedureSequence(int value)

Parameters:

value - procedureSequence (Procedures applicable for this service or product.)

getInformationSequence

public List<PositiveIntType> getInformationSequence()

Returns:

informationSequence (Exceptions, special conditions and supporting information applicable for this service or product.)

setInformationSequence

public ExplanationOfBenefit.ItemComponent setInformationSequence(List<PositiveIntType> theInformationSequence)

Returns:

Returns a reference to this for easy method chaining

hasInformationSequence

public boolean hasInformationSequence()

addInformationSequenceElement

public PositiveIntType addInformationSequenceElement()

Returns:

informationSequence (Exceptions, special conditions and supporting information applicable for this service or product.)

addInformationSequence

public ExplanationOfBenefit.ItemComponent addInformationSequence(int value)

Parameters:

value - informationSequence (Exceptions, special conditions and supporting information applicable for this service or product.)

hasInformationSequence

public boolean hasInformationSequence(int value)

Parameters:

value - informationSequence (Exceptions, special conditions and supporting information applicable for this service or product.)

getTraceNumber

public List<Identifier> getTraceNumber()

Returns:

traceNumber (Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.)

setTraceNumber

public ExplanationOfBenefit.ItemComponent setTraceNumber(List<Identifier> theTraceNumber)

Returns:

Returns a reference to this for easy method chaining

hasTraceNumber

public boolean hasTraceNumber()

addTraceNumber

public Identifier addTraceNumber()

addTraceNumber

public ExplanationOfBenefit.ItemComponent addTraceNumber(Identifier t)

getTraceNumberFirstRep

public Identifier getTraceNumberFirstRep()

Returns:

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

getRevenue

public CodeableConcept getRevenue()

Returns:

revenue (The type of revenue or cost center providing the product and/or service.)

hasRevenue

public boolean hasRevenue()

setRevenue

public ExplanationOfBenefit.ItemComponent setRevenue(CodeableConcept value)

Parameters:

value - revenue (The type of revenue or cost center providing the product and/or service.)

getCategory

public CodeableConcept getCategory()

Returns:

category (Code to identify the general type of benefits under which products and services are provided.)

hasCategory

public boolean hasCategory()

setCategory

public ExplanationOfBenefit.ItemComponent setCategory(CodeableConcept value)

Parameters:

value - category (Code to identify the general type of benefits under which products and services are provided.)

getProductOrService

public CodeableConcept getProductOrService()

Returns:

productOrService (When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.)

hasProductOrService

public boolean hasProductOrService()

setProductOrService

public ExplanationOfBenefit.ItemComponent setProductOrService(CodeableConcept value)

Parameters:

value - productOrService (When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.)

getProductOrServiceEnd

public CodeableConcept getProductOrServiceEnd()

Returns:

productOrServiceEnd (This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.)

hasProductOrServiceEnd

public boolean hasProductOrServiceEnd()

setProductOrServiceEnd

public ExplanationOfBenefit.ItemComponent setProductOrServiceEnd(CodeableConcept value)

Parameters:

value - productOrServiceEnd (This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.)

getRequest

public List<Reference> getRequest()

Returns:

request (Request or Referral for Goods or Service to be rendered.)

setRequest

public ExplanationOfBenefit.ItemComponent setRequest(List<Reference> theRequest)

Returns:

Returns a reference to this for easy method chaining

hasRequest

public boolean hasRequest()

addRequest

public Reference addRequest()

addRequest

public ExplanationOfBenefit.ItemComponent addRequest(Reference t)

getRequestFirstRep

public Reference getRequestFirstRep()

Returns:

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

getModifier

public List<CodeableConcept> getModifier()

Returns:

modifier (Item typification or modifiers codes to convey additional context for the product or service.)

setModifier

public ExplanationOfBenefit.ItemComponent setModifier(List<CodeableConcept> theModifier)

Returns:

Returns a reference to this for easy method chaining

hasModifier

public boolean hasModifier()

addModifier

public CodeableConcept addModifier()

addModifier

public ExplanationOfBenefit.ItemComponent addModifier(CodeableConcept t)

getModifierFirstRep

public CodeableConcept getModifierFirstRep()

Returns:

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

getProgramCode

public List<CodeableConcept> getProgramCode()

Returns:

programCode (Identifies the program under which this may be recovered.)

setProgramCode

public ExplanationOfBenefit.ItemComponent setProgramCode(List<CodeableConcept> theProgramCode)

Returns:

Returns a reference to this for easy method chaining

hasProgramCode

public boolean hasProgramCode()

addProgramCode

public CodeableConcept addProgramCode()

addProgramCode

public ExplanationOfBenefit.ItemComponent addProgramCode(CodeableConcept t)

getProgramCodeFirstRep

public CodeableConcept getProgramCodeFirstRep()

Returns:

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

getServiced

public DataType getServiced()

Returns:

serviced (The date or dates when the service or product was supplied, performed or completed.)

getServicedDateType

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

Returns:

serviced (The date or dates when the service or product was supplied, performed or completed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasServicedDateType

public boolean hasServicedDateType()

getServicedPeriod

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

Returns:

serviced (The date or dates when the service or product was supplied, performed or completed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasServicedPeriod

public boolean hasServicedPeriod()

hasServiced

public boolean hasServiced()

setServiced

public ExplanationOfBenefit.ItemComponent setServiced(DataType value)

Parameters:

value - serviced (The date or dates when the service or product was supplied, performed or completed.)

getLocation

public DataType getLocation()

Returns:

location (Where the product or service was provided.)

getLocationCodeableConcept

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

Returns:

location (Where the product or service was provided.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasLocationCodeableConcept

public boolean hasLocationCodeableConcept()

getLocationAddress

public Address getLocationAddress()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

location (Where the product or service was provided.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasLocationAddress

public boolean hasLocationAddress()

getLocationReference

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

Returns:

location (Where the product or service was provided.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasLocationReference

public boolean hasLocationReference()

hasLocation

public boolean hasLocation()

setLocation

public ExplanationOfBenefit.ItemComponent setLocation(DataType value)

Parameters:

value - location (Where the product or service was provided.)

getPatientPaid

public Money getPatientPaid()

Returns:

patientPaid (The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)

hasPatientPaid

public boolean hasPatientPaid()

setPatientPaid

public ExplanationOfBenefit.ItemComponent setPatientPaid(Money value)

Parameters:

value - patientPaid (The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)

getQuantity

public Quantity getQuantity()

Returns:

quantity (The number of repetitions of a service or product.)

hasQuantity

public boolean hasQuantity()

setQuantity

public ExplanationOfBenefit.ItemComponent setQuantity(Quantity value)

Parameters:

value - quantity (The number of repetitions of a service or product.)

getUnitPrice

public Money getUnitPrice()

Returns:

unitPrice (If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.)

hasUnitPrice

public boolean hasUnitPrice()

setUnitPrice

public ExplanationOfBenefit.ItemComponent setUnitPrice(Money value)

Parameters:

value - unitPrice (If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.)

getFactorElement

public DecimalType getFactorElement()

Returns:

factor (A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value

hasFactorElement

public boolean hasFactorElement()

hasFactor

public boolean hasFactor()

setFactorElement

public ExplanationOfBenefit.ItemComponent setFactorElement(DecimalType value)

Parameters:

value - factor (A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value

getFactor

public BigDecimal getFactor()

Returns:

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

setFactor

public ExplanationOfBenefit.ItemComponent setFactor(BigDecimal value)

Parameters:

value - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

setFactor

public ExplanationOfBenefit.ItemComponent setFactor(long value)

Parameters:

value - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

setFactor

public ExplanationOfBenefit.ItemComponent setFactor(double value)

Parameters:

value - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

getTax

public Money getTax()

Returns:

tax (The total of taxes applicable for this product or service.)

hasTax

public boolean hasTax()

setTax

public ExplanationOfBenefit.ItemComponent setTax(Money value)

Parameters:

value - tax (The total of taxes applicable for this product or service.)

getNet

public Money getNet()

Returns:

net (The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.)

hasNet

public boolean hasNet()

setNet

public ExplanationOfBenefit.ItemComponent setNet(Money value)

Parameters:

value - net (The total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.)

getUdi

public List<Reference> getUdi()

Returns:

udi (Unique Device Identifiers associated with this line item.)

setUdi

public ExplanationOfBenefit.ItemComponent setUdi(List<Reference> theUdi)

Returns:

Returns a reference to this for easy method chaining

hasUdi

public boolean hasUdi()

addUdi

public Reference addUdi()

addUdi

public ExplanationOfBenefit.ItemComponent addUdi(Reference t)

getUdiFirstRep

public Reference getUdiFirstRep()

Returns:

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

getBodySite

public List<ExplanationOfBenefit.ItemBodySiteComponent> getBodySite()

Returns:

bodySite (Physical location where the service is performed or applies.)

setBodySite

public ExplanationOfBenefit.ItemComponent setBodySite(List<ExplanationOfBenefit.ItemBodySiteComponent> theBodySite)

Returns:

Returns a reference to this for easy method chaining

hasBodySite

public boolean hasBodySite()

addBodySite

public ExplanationOfBenefit.ItemBodySiteComponent addBodySite()

addBodySite

public ExplanationOfBenefit.ItemComponent addBodySite(ExplanationOfBenefit.ItemBodySiteComponent t)

getBodySiteFirstRep

public ExplanationOfBenefit.ItemBodySiteComponent getBodySiteFirstRep()

Returns:

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

getEncounter

public List<Reference> getEncounter()

Returns:

encounter (Healthcare encounters related to this claim.)

setEncounter

public ExplanationOfBenefit.ItemComponent setEncounter(List<Reference> theEncounter)

Returns:

Returns a reference to this for easy method chaining

hasEncounter

public boolean hasEncounter()

addEncounter

public Reference addEncounter()

addEncounter

public ExplanationOfBenefit.ItemComponent addEncounter(Reference t)

getEncounterFirstRep

public Reference getEncounterFirstRep()

Returns:

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

getNoteNumber

public List<PositiveIntType> getNoteNumber()

Returns:

noteNumber (The numbers associated with notes below which apply to the adjudication of this item.)

setNoteNumber

public ExplanationOfBenefit.ItemComponent setNoteNumber(List<PositiveIntType> theNoteNumber)

Returns:

Returns a reference to this for easy method chaining

hasNoteNumber

public boolean hasNoteNumber()

addNoteNumberElement

public PositiveIntType addNoteNumberElement()

Returns:

noteNumber (The numbers associated with notes below which apply to the adjudication of this item.)

addNoteNumber

public ExplanationOfBenefit.ItemComponent addNoteNumber(int value)

Parameters:

value - noteNumber (The numbers associated with notes below which apply to the adjudication of this item.)

hasNoteNumber

public boolean hasNoteNumber(int value)

Parameters:

value - noteNumber (The numbers associated with notes below which apply to the adjudication of this item.)

getReviewOutcome

public ExplanationOfBenefit.ItemReviewOutcomeComponent getReviewOutcome()

Returns:

reviewOutcome (The high-level results of the adjudication if adjudication has been performed.)

hasReviewOutcome

public boolean hasReviewOutcome()

setReviewOutcome

public ExplanationOfBenefit.ItemComponent setReviewOutcome(ExplanationOfBenefit.ItemReviewOutcomeComponent value)

Parameters:

value - reviewOutcome (The high-level results of the adjudication if adjudication has been performed.)

getAdjudication

public List<ExplanationOfBenefit.AdjudicationComponent> getAdjudication()

Returns:

adjudication (If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.)

setAdjudication

public ExplanationOfBenefit.ItemComponent setAdjudication(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication)

Returns:

Returns a reference to this for easy method chaining

hasAdjudication

public boolean hasAdjudication()

addAdjudication

public ExplanationOfBenefit.AdjudicationComponent addAdjudication()

addAdjudication

public ExplanationOfBenefit.ItemComponent addAdjudication(ExplanationOfBenefit.AdjudicationComponent t)

getAdjudicationFirstRep

public ExplanationOfBenefit.AdjudicationComponent getAdjudicationFirstRep()

Returns:

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

getDetail

public List<ExplanationOfBenefit.DetailComponent> getDetail()

Returns:

detail (Second-tier of goods and services.)

setDetail

public ExplanationOfBenefit.ItemComponent setDetail(List<ExplanationOfBenefit.DetailComponent> theDetail)

Returns:

Returns a reference to this for easy method chaining

hasDetail

public boolean hasDetail()

addDetail

public ExplanationOfBenefit.DetailComponent addDetail()

addDetail

public ExplanationOfBenefit.ItemComponent addDetail(ExplanationOfBenefit.DetailComponent t)

getDetailFirstRep

public ExplanationOfBenefit.DetailComponent getDetailFirstRep()

Returns:

The first repetition of repeating field detail, 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 ExplanationOfBenefit.ItemComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(ExplanationOfBenefit.ItemComponent 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)