Package org.hl7.fhir.r5.model

Class CoverageEligibilityResponse.ItemsComponent

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.CoverageEligibilityResponse.ItemsComponent

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:

CoverageEligibilityResponse

public static class CoverageEligibilityResponse.ItemsComponent
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 BooleanType	authorizationRequired	A boolean flag indicating whether a preauthorization is required prior to actual service delivery.
protected List<CodeableConcept>	authorizationSupporting	Codes or comments regarding information or actions associated with the preauthorization.
protected UriType	authorizationUrl	A web location for obtaining requirements or descriptive information regarding the preauthorization.
protected List<CoverageEligibilityResponse.BenefitComponent>	benefit	Benefits used to date.
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<CodeableConcept>	modifier	Item typification or modifiers codes to convey additional context for the product or service.
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	productOrService	This contains the product, service, drug or other billing code for the item.
protected Reference	provider	The practitioner who is eligible for the provision of the product or service.
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
ItemsComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAuthorizationSupporting()
CoverageEligibilityResponse.ItemsComponent	addAuthorizationSupporting(CodeableConcept t)
CoverageEligibilityResponse.BenefitComponent	addBenefit()
CoverageEligibilityResponse.ItemsComponent	addBenefit(CoverageEligibilityResponse.BenefitComponent t)
Base	addChild(String name)
CodeableConcept	addModifier()
CoverageEligibilityResponse.ItemsComponent	addModifier(CodeableConcept t)
CoverageEligibilityResponse.ItemsComponent	copy()
void	copyValues(CoverageEligibilityResponse.ItemsComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAuthorizationRequired()
BooleanType	getAuthorizationRequiredElement()
List<CodeableConcept>	getAuthorizationSupporting()
CodeableConcept	getAuthorizationSupportingFirstRep()
String	getAuthorizationUrl()
UriType	getAuthorizationUrlElement()
List<CoverageEligibilityResponse.BenefitComponent>	getBenefit()
CoverageEligibilityResponse.BenefitComponent	getBenefitFirstRep()
CodeableConcept	getCategory()
String	getDescription()
StringType	getDescriptionElement()
boolean	getExcluded()
BooleanType	getExcludedElement()
List<CodeableConcept>	getModifier()
CodeableConcept	getModifierFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
CodeableConcept	getNetwork()
CodeableConcept	getProductOrService()
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getProvider()
CodeableConcept	getTerm()
String[]	getTypesForProperty(int hash, String name)
CodeableConcept	getUnit()
boolean	hasAuthorizationRequired()
boolean	hasAuthorizationRequiredElement()
boolean	hasAuthorizationSupporting()
boolean	hasAuthorizationUrl()
boolean	hasAuthorizationUrlElement()
boolean	hasBenefit()
boolean	hasCategory()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExcluded()
boolean	hasExcludedElement()
boolean	hasModifier()
boolean	hasName()
boolean	hasNameElement()
boolean	hasNetwork()
boolean	hasProductOrService()
boolean	hasProvider()
boolean	hasTerm()
boolean	hasUnit()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
CoverageEligibilityResponse.ItemsComponent	setAuthorizationRequired(boolean value)
CoverageEligibilityResponse.ItemsComponent	setAuthorizationRequiredElement(BooleanType value)
CoverageEligibilityResponse.ItemsComponent	setAuthorizationSupporting(List<CodeableConcept> theAuthorizationSupporting)
CoverageEligibilityResponse.ItemsComponent	setAuthorizationUrl(String value)
CoverageEligibilityResponse.ItemsComponent	setAuthorizationUrlElement(UriType value)
CoverageEligibilityResponse.ItemsComponent	setBenefit(List<CoverageEligibilityResponse.BenefitComponent> theBenefit)
CoverageEligibilityResponse.ItemsComponent	setCategory(CodeableConcept value)
CoverageEligibilityResponse.ItemsComponent	setDescription(String value)
CoverageEligibilityResponse.ItemsComponent	setDescriptionElement(StringType value)
CoverageEligibilityResponse.ItemsComponent	setExcluded(boolean value)
CoverageEligibilityResponse.ItemsComponent	setExcludedElement(BooleanType value)
CoverageEligibilityResponse.ItemsComponent	setModifier(List<CodeableConcept> theModifier)
CoverageEligibilityResponse.ItemsComponent	setName(String value)
CoverageEligibilityResponse.ItemsComponent	setNameElement(StringType value)
CoverageEligibilityResponse.ItemsComponent	setNetwork(CodeableConcept value)
CoverageEligibilityResponse.ItemsComponent	setProductOrService(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CoverageEligibilityResponse.ItemsComponent	setProvider(Reference value)
CoverageEligibilityResponse.ItemsComponent	setTerm(CodeableConcept value)
CoverageEligibilityResponse.ItemsComponent	setUnit(CodeableConcept 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

category

protected CodeableConcept category

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

productOrService

protected CodeableConcept productOrService

This contains the product, service, drug or other billing code for the item.

modifier

protected List<CodeableConcept> modifier

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

provider

protected Reference provider

The practitioner who is eligible for the provision of the product or service.

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

benefit

protected List<CoverageEligibilityResponse.BenefitComponent> benefit

Benefits used to date.

authorizationRequired

protected BooleanType authorizationRequired

A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

authorizationSupporting

protected List<CodeableConcept> authorizationSupporting

Codes or comments regarding information or actions associated with the preauthorization.

authorizationUrl

protected UriType authorizationUrl

A web location for obtaining requirements or descriptive information regarding the preauthorization.

Constructor Details

ItemsComponent

public ItemsComponent()

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 CoverageEligibilityResponse.ItemsComponent 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 (This contains the product, service, drug or other billing code for the item.)

hasProductOrService

public boolean hasProductOrService()

setProductOrService

public CoverageEligibilityResponse.ItemsComponent setProductOrService(CodeableConcept value)

Parameters:

value - productOrService (This contains the product, service, drug or other billing code for the item.)

getModifier

public List<CodeableConcept> getModifier()

Returns:

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

setModifier

public CoverageEligibilityResponse.ItemsComponent setModifier(List<CodeableConcept> theModifier)

Returns:

Returns a reference to this for easy method chaining

hasModifier

public boolean hasModifier()

addModifier

public CodeableConcept addModifier()

addModifier

public CoverageEligibilityResponse.ItemsComponent addModifier(CodeableConcept t)

getModifierFirstRep

public CodeableConcept getModifierFirstRep()

Returns:

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

getProvider

public Reference getProvider()

Returns:

provider (The practitioner who is eligible for the provision of the product or service.)

hasProvider

public boolean hasProvider()

setProvider

public CoverageEligibilityResponse.ItemsComponent setProvider(Reference value)

Parameters:

value - provider (The practitioner who is eligible for the provision of the product or service.)

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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent 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 CoverageEligibilityResponse.ItemsComponent setTerm(CodeableConcept value)

Parameters:

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

getBenefit

public List<CoverageEligibilityResponse.BenefitComponent> getBenefit()

Returns:

benefit (Benefits used to date.)

setBenefit

public CoverageEligibilityResponse.ItemsComponent setBenefit(List<CoverageEligibilityResponse.BenefitComponent> theBenefit)

Returns:

Returns a reference to this for easy method chaining

hasBenefit

public boolean hasBenefit()

addBenefit

public CoverageEligibilityResponse.BenefitComponent addBenefit()

addBenefit

public CoverageEligibilityResponse.ItemsComponent addBenefit(CoverageEligibilityResponse.BenefitComponent t)

getBenefitFirstRep

public CoverageEligibilityResponse.BenefitComponent getBenefitFirstRep()

Returns:

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

getAuthorizationRequiredElement

public BooleanType getAuthorizationRequiredElement()

Returns:

authorizationRequired (A boolean flag indicating whether a preauthorization is required prior to actual service delivery.). This is the underlying object with id, value and extensions. The accessor "getAuthorizationRequired" gives direct access to the value

hasAuthorizationRequiredElement

public boolean hasAuthorizationRequiredElement()

hasAuthorizationRequired

public boolean hasAuthorizationRequired()

setAuthorizationRequiredElement

public CoverageEligibilityResponse.ItemsComponent setAuthorizationRequiredElement(BooleanType value)

Parameters:

value - authorizationRequired (A boolean flag indicating whether a preauthorization is required prior to actual service delivery.). This is the underlying object with id, value and extensions. The accessor "getAuthorizationRequired" gives direct access to the value

getAuthorizationRequired

public boolean getAuthorizationRequired()

Returns:

A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

setAuthorizationRequired

public CoverageEligibilityResponse.ItemsComponent setAuthorizationRequired(boolean value)

Parameters:

value - A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

getAuthorizationSupporting

public List<CodeableConcept> getAuthorizationSupporting()

Returns:

authorizationSupporting (Codes or comments regarding information or actions associated with the preauthorization.)

setAuthorizationSupporting

public CoverageEligibilityResponse.ItemsComponent setAuthorizationSupporting(List<CodeableConcept> theAuthorizationSupporting)

Returns:

Returns a reference to this for easy method chaining

hasAuthorizationSupporting

public boolean hasAuthorizationSupporting()

addAuthorizationSupporting

public CodeableConcept addAuthorizationSupporting()

addAuthorizationSupporting

public CoverageEligibilityResponse.ItemsComponent addAuthorizationSupporting(CodeableConcept t)

getAuthorizationSupportingFirstRep

public CodeableConcept getAuthorizationSupportingFirstRep()

Returns:

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

getAuthorizationUrlElement

public UriType getAuthorizationUrlElement()

Returns:

authorizationUrl (A web location for obtaining requirements or descriptive information regarding the preauthorization.). This is the underlying object with id, value and extensions. The accessor "getAuthorizationUrl" gives direct access to the value

hasAuthorizationUrlElement

public boolean hasAuthorizationUrlElement()

hasAuthorizationUrl

public boolean hasAuthorizationUrl()

setAuthorizationUrlElement

public CoverageEligibilityResponse.ItemsComponent setAuthorizationUrlElement(UriType value)

Parameters:

value - authorizationUrl (A web location for obtaining requirements or descriptive information regarding the preauthorization.). This is the underlying object with id, value and extensions. The accessor "getAuthorizationUrl" gives direct access to the value

getAuthorizationUrl

public String getAuthorizationUrl()

Returns:

A web location for obtaining requirements or descriptive information regarding the preauthorization.

setAuthorizationUrl

public CoverageEligibilityResponse.ItemsComponent setAuthorizationUrl(String value)

Parameters:

value - A web location for obtaining requirements or descriptive information regarding the preauthorization.

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 CoverageEligibilityResponse.ItemsComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(CoverageEligibilityResponse.ItemsComponent 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)