Package org.hl7.fhir.r5.model

Class ExplanationOfBenefit.BenefitBalanceComponent

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

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.BenefitBalanceComponent
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 CodeableConcept	category	Code to identify the general type of benefits under which products and services are provided.
protected StringType	description	A richer description of the benefit or services covered.
protected BooleanType	excluded	True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
protected List<ExplanationOfBenefit.BenefitComponent>	financial	Benefits Used to date.
protected StringType	name	A short name or tag for the benefit.
protected CodeableConcept	network	Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
protected CodeableConcept	term	The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
protected CodeableConcept	unit	Indicates if the benefits apply to an individual or to the family.

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
BenefitBalanceComponent()	Constructor
BenefitBalanceComponent(CodeableConcept category)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ExplanationOfBenefit.BenefitComponent	addFinancial()
ExplanationOfBenefit.BenefitBalanceComponent	addFinancial(ExplanationOfBenefit.BenefitComponent t)
ExplanationOfBenefit.BenefitBalanceComponent	copy()
void	copyValues(ExplanationOfBenefit.BenefitBalanceComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getCategory()
String	getDescription()
StringType	getDescriptionElement()
boolean	getExcluded()
BooleanType	getExcludedElement()
List<ExplanationOfBenefit.BenefitComponent>	getFinancial()
ExplanationOfBenefit.BenefitComponent	getFinancialFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
CodeableConcept	getNetwork()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getTerm()
String[]	getTypesForProperty(int hash, String name)
CodeableConcept	getUnit()
boolean	hasCategory()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExcluded()
boolean	hasExcludedElement()
boolean	hasFinancial()
boolean	hasName()
boolean	hasNameElement()
boolean	hasNetwork()
boolean	hasTerm()
boolean	hasUnit()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ExplanationOfBenefit.BenefitBalanceComponent	setCategory(CodeableConcept value)
ExplanationOfBenefit.BenefitBalanceComponent	setDescription(String value)
ExplanationOfBenefit.BenefitBalanceComponent	setDescriptionElement(StringType value)
ExplanationOfBenefit.BenefitBalanceComponent	setExcluded(boolean value)
ExplanationOfBenefit.BenefitBalanceComponent	setExcludedElement(BooleanType value)
ExplanationOfBenefit.BenefitBalanceComponent	setFinancial(List<ExplanationOfBenefit.BenefitComponent> theFinancial)
ExplanationOfBenefit.BenefitBalanceComponent	setName(String value)
ExplanationOfBenefit.BenefitBalanceComponent	setNameElement(StringType value)
ExplanationOfBenefit.BenefitBalanceComponent	setNetwork(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ExplanationOfBenefit.BenefitBalanceComponent	setTerm(CodeableConcept value)
ExplanationOfBenefit.BenefitBalanceComponent	setUnit(CodeableConcept 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

category

protected CodeableConcept category

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

excluded

protected BooleanType excluded

True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

name

protected StringType name

A short name or tag for the benefit.

description

protected StringType description

A richer description of the benefit or services covered.

network

protected CodeableConcept network

Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

unit

protected CodeableConcept unit

Indicates if the benefits apply to an individual or to the family.

term

protected CodeableConcept term

The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

financial

protected List<ExplanationOfBenefit.BenefitComponent> financial

Benefits Used to date.

Constructor Details

BenefitBalanceComponent

public BenefitBalanceComponent()

Constructor

BenefitBalanceComponent

public BenefitBalanceComponent(CodeableConcept category)

Constructor

Method Details

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.BenefitBalanceComponent setCategory(CodeableConcept value)

Parameters:

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

getExcludedElement

public BooleanType getExcludedElement()

Returns:

excluded (True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.). This is the underlying object with id, value and extensions. The accessor "getExcluded" gives direct access to the value

hasExcludedElement

public boolean hasExcludedElement()

hasExcluded

public boolean hasExcluded()

setExcludedElement

public ExplanationOfBenefit.BenefitBalanceComponent setExcludedElement(BooleanType value)

Parameters:

value - excluded (True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.). This is the underlying object with id, value and extensions. The accessor "getExcluded" gives direct access to the value

getExcluded

public boolean getExcluded()

Returns:

True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

setExcluded

public ExplanationOfBenefit.BenefitBalanceComponent setExcluded(boolean value)

Parameters:

value - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

getNameElement

public StringType getNameElement()

Returns:

name (A short name or tag for the benefit.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public ExplanationOfBenefit.BenefitBalanceComponent setNameElement(StringType value)

Parameters:

value - name (A short name or tag for the benefit.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

A short name or tag for the benefit.

setName

public ExplanationOfBenefit.BenefitBalanceComponent setName(String value)

Parameters:

value - A short name or tag for the benefit.

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (A richer description of the benefit or services covered.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public ExplanationOfBenefit.BenefitBalanceComponent setDescriptionElement(StringType value)

Parameters:

value - description (A richer description of the benefit or services covered.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A richer description of the benefit or services covered.

setDescription

public ExplanationOfBenefit.BenefitBalanceComponent setDescription(String value)

Parameters:

value - A richer description of the benefit or services covered.

getNetwork

public CodeableConcept getNetwork()

Returns:

network (Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.)

hasNetwork

public boolean hasNetwork()

setNetwork

public ExplanationOfBenefit.BenefitBalanceComponent setNetwork(CodeableConcept value)

Parameters:

value - network (Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.)

getUnit

public CodeableConcept getUnit()

Returns:

unit (Indicates if the benefits apply to an individual or to the family.)

hasUnit

public boolean hasUnit()

setUnit

public ExplanationOfBenefit.BenefitBalanceComponent setUnit(CodeableConcept value)

Parameters:

value - unit (Indicates if the benefits apply to an individual or to the family.)

getTerm

public CodeableConcept getTerm()

Returns:

term (The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.)

hasTerm

public boolean hasTerm()

setTerm

public ExplanationOfBenefit.BenefitBalanceComponent setTerm(CodeableConcept value)

Parameters:

value - term (The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.)

getFinancial

public List<ExplanationOfBenefit.BenefitComponent> getFinancial()

Returns:

financial (Benefits Used to date.)

setFinancial

public ExplanationOfBenefit.BenefitBalanceComponent setFinancial(List<ExplanationOfBenefit.BenefitComponent> theFinancial)

Returns:

Returns a reference to this for easy method chaining

hasFinancial

public boolean hasFinancial()

addFinancial

public ExplanationOfBenefit.BenefitComponent addFinancial()

addFinancial

public ExplanationOfBenefit.BenefitBalanceComponent addFinancial(ExplanationOfBenefit.BenefitComponent t)

getFinancialFirstRep

public ExplanationOfBenefit.BenefitComponent getFinancialFirstRep()

Returns:

The first repetition of repeating field financial, 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.BenefitBalanceComponent copy()

Specified by:

copy in class BackboneElement

copyValues

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