Package com.ibm.fhir.model.resource

Class CoverageEligibilityResponse.Insurance.Item.Builder

java.lang.Object

com.ibm.fhir.model.builder.AbstractBuilder<Element>

com.ibm.fhir.model.type.Element.Builder

com.ibm.fhir.model.type.BackboneElement.Builder

com.ibm.fhir.model.resource.CoverageEligibilityResponse.Insurance.Item.Builder

All Implemented Interfaces:

Builder<Element>

Enclosing class:

CoverageEligibilityResponse.Insurance.Item

public static class CoverageEligibilityResponse.Insurance.Item.Builder
extends BackboneElement.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.BackboneElement.Builder

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element.Builder

extension, id

Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder

validating

Method Summary

Modifier and Type	Method	Description
CoverageEligibilityResponse.Insurance.Item.Builder	authorizationRequired(Boolean authorizationRequired)	A boolean flag indicating whether a preauthorization is required prior to actual service delivery.
CoverageEligibilityResponse.Insurance.Item.Builder	authorizationRequired(Boolean authorizationRequired)	Convenience method for setting authorizationRequired.
CoverageEligibilityResponse.Insurance.Item.Builder	authorizationSupporting(CodeableConcept... authorizationSupporting)	Codes or comments regarding information or actions associated with the preauthorization.
CoverageEligibilityResponse.Insurance.Item.Builder	authorizationSupporting(Collection<CodeableConcept> authorizationSupporting)	Codes or comments regarding information or actions associated with the preauthorization.
CoverageEligibilityResponse.Insurance.Item.Builder	authorizationUrl(Uri authorizationUrl)	A web location for obtaining requirements or descriptive information regarding the preauthorization.
CoverageEligibilityResponse.Insurance.Item.Builder	benefit(CoverageEligibilityResponse.Insurance.Item.Benefit... benefit)	Benefits used to date.
CoverageEligibilityResponse.Insurance.Item.Builder	benefit(Collection<CoverageEligibilityResponse.Insurance.Item.Benefit> benefit)	Benefits used to date.
CoverageEligibilityResponse.Insurance.Item	build()	Build the CoverageEligibilityResponse.Insurance.Item
CoverageEligibilityResponse.Insurance.Item.Builder	category(CodeableConcept category)	Code to identify the general type of benefits under which products and services are provided.
CoverageEligibilityResponse.Insurance.Item.Builder	description(String description)	A richer description of the benefit or services covered.
CoverageEligibilityResponse.Insurance.Item.Builder	description(String description)	Convenience method for setting description.
CoverageEligibilityResponse.Insurance.Item.Builder	excluded(Boolean 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.
CoverageEligibilityResponse.Insurance.Item.Builder	excluded(Boolean excluded)	Convenience method for setting excluded.
CoverageEligibilityResponse.Insurance.Item.Builder	extension(Extension... extension)	May be used to represent additional information that is not part of the basic definition of the element.
CoverageEligibilityResponse.Insurance.Item.Builder	extension(Collection<Extension> extension)	May be used to represent additional information that is not part of the basic definition of the element.
protected CoverageEligibilityResponse.Insurance.Item.Builder	from(CoverageEligibilityResponse.Insurance.Item item)
CoverageEligibilityResponse.Insurance.Item.Builder	id(String id)	Unique id for the element within a resource (for internal references).
CoverageEligibilityResponse.Insurance.Item.Builder	modifier(CodeableConcept... modifier)	Item typification or modifiers codes to convey additional context for the product or service.
CoverageEligibilityResponse.Insurance.Item.Builder	modifier(Collection<CodeableConcept> modifier)	Item typification or modifiers codes to convey additional context for the product or service.
CoverageEligibilityResponse.Insurance.Item.Builder	modifierExtension(Extension... modifierExtension)	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.
CoverageEligibilityResponse.Insurance.Item.Builder	modifierExtension(Collection<Extension> modifierExtension)	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.
CoverageEligibilityResponse.Insurance.Item.Builder	name(String name)	A short name or tag for the benefit.
CoverageEligibilityResponse.Insurance.Item.Builder	name(String name)	Convenience method for setting name.
CoverageEligibilityResponse.Insurance.Item.Builder	network(CodeableConcept network)	Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
CoverageEligibilityResponse.Insurance.Item.Builder	productOrService(CodeableConcept productOrService)	This contains the product, service, drug or other billing code for the item.
CoverageEligibilityResponse.Insurance.Item.Builder	provider(Reference provider)	The practitioner who is eligible for the provision of the product or service.
CoverageEligibilityResponse.Insurance.Item.Builder	term(CodeableConcept term)	The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
CoverageEligibilityResponse.Insurance.Item.Builder	unit(CodeableConcept unit)	Indicates if the benefits apply to an individual or to the family.
protected void	validate(CoverageEligibilityResponse.Insurance.Item item)

Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builder

from, validate

Methods inherited from class com.ibm.fhir.model.type.Element.Builder

from, validate

Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder

isValidating, setValidating

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public CoverageEligibilityResponse.Insurance.Item.Builder id(String id)

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Overrides:

id in class BackboneElement.Builder

Parameters:

id - Unique id for inter-element referencing

Returns:

A reference to this Builder instance

extension

public CoverageEligibilityResponse.Insurance.Item.Builder extension(Extension... extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Overrides:

extension in class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

extension

public CoverageEligibilityResponse.Insurance.Item.Builder extension(Collection<Extension> extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

Overrides:

extension in class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

Throws:

NullPointerException - If the passed collection is null

modifierExtension

public CoverageEligibilityResponse.Insurance.Item.Builder modifierExtension(Extension... modifierExtension)

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Overrides:

modifierExtension in class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

modifierExtension

public CoverageEligibilityResponse.Insurance.Item.Builder modifierExtension(Collection<Extension> modifierExtension)

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

Overrides:

modifierExtension in class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

Throws:

NullPointerException - If the passed collection is null

category

public CoverageEligibilityResponse.Insurance.Item.Builder category(CodeableConcept category)

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

Parameters:

category - Benefit classification

Returns:

A reference to this Builder instance

productOrService

public CoverageEligibilityResponse.Insurance.Item.Builder productOrService(CodeableConcept productOrService)

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

Parameters:

productOrService - Billing, service, product, or drug code

Returns:

A reference to this Builder instance

modifier

public CoverageEligibilityResponse.Insurance.Item.Builder modifier(CodeableConcept... modifier)

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

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Parameters:

modifier - Product or service billing modifiers

Returns:

A reference to this Builder instance

modifier

public CoverageEligibilityResponse.Insurance.Item.Builder modifier(Collection<CodeableConcept> modifier)

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

Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

Parameters:

modifier - Product or service billing modifiers

Returns:

A reference to this Builder instance

Throws:

NullPointerException - If the passed collection is null

provider

public CoverageEligibilityResponse.Insurance.Item.Builder provider(Reference provider)

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

Allowed resource types for this reference:

• Practitioner
• PractitionerRole

Parameters:

provider - Performing practitioner

Returns:

A reference to this Builder instance

excluded

public CoverageEligibilityResponse.Insurance.Item.Builder excluded(Boolean excluded)

Convenience method for setting excluded.

Parameters:

excluded - Excluded from the plan

Returns:

A reference to this Builder instance

See Also:

excluded(com.ibm.fhir.model.type.Boolean)

excluded

public CoverageEligibilityResponse.Insurance.Item.Builder excluded(Boolean 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.

Parameters:

excluded - Excluded from the plan

Returns:

A reference to this Builder instance

name

public CoverageEligibilityResponse.Insurance.Item.Builder name(String name)

Convenience method for setting name.

Parameters:

name - Short name for the benefit

Returns:

A reference to this Builder instance

See Also:

name(com.ibm.fhir.model.type.String)

name

public CoverageEligibilityResponse.Insurance.Item.Builder name(String name)

A short name or tag for the benefit.

Parameters:

name - Short name for the benefit

Returns:

A reference to this Builder instance

description

public CoverageEligibilityResponse.Insurance.Item.Builder description(String description)

Convenience method for setting description.

Parameters:

description - Description of the benefit or services covered

Returns:

A reference to this Builder instance

See Also:

description(com.ibm.fhir.model.type.String)

description

public CoverageEligibilityResponse.Insurance.Item.Builder description(String description)

A richer description of the benefit or services covered.

Parameters:

description - Description of the benefit or services covered

Returns:

A reference to this Builder instance

network

public CoverageEligibilityResponse.Insurance.Item.Builder network(CodeableConcept network)

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

Parameters:

network - In or out of network

Returns:

A reference to this Builder instance

unit

public CoverageEligibilityResponse.Insurance.Item.Builder unit(CodeableConcept unit)

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

Parameters:

unit - Individual or family

Returns:

A reference to this Builder instance

term

public CoverageEligibilityResponse.Insurance.Item.Builder term(CodeableConcept term)

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

Parameters:

term - Annual or lifetime

Returns:

A reference to this Builder instance

benefit

public CoverageEligibilityResponse.Insurance.Item.Builder benefit(CoverageEligibilityResponse.Insurance.Item.Benefit... benefit)

Benefits used to date.

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Parameters:

benefit - Benefit Summary

Returns:

A reference to this Builder instance

benefit

public CoverageEligibilityResponse.Insurance.Item.Builder benefit(Collection<CoverageEligibilityResponse.Insurance.Item.Benefit> benefit)

Benefits used to date.

Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

Parameters:

benefit - Benefit Summary

Returns:

A reference to this Builder instance

Throws:

NullPointerException - If the passed collection is null

authorizationRequired

public CoverageEligibilityResponse.Insurance.Item.Builder authorizationRequired(Boolean authorizationRequired)

Convenience method for setting authorizationRequired.

Parameters:

authorizationRequired - Authorization required flag

Returns:

A reference to this Builder instance

See Also:

authorizationRequired(com.ibm.fhir.model.type.Boolean)

authorizationRequired

public CoverageEligibilityResponse.Insurance.Item.Builder authorizationRequired(Boolean authorizationRequired)

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

Parameters:

authorizationRequired - Authorization required flag

Returns:

A reference to this Builder instance

authorizationSupporting

public CoverageEligibilityResponse.Insurance.Item.Builder authorizationSupporting(CodeableConcept... authorizationSupporting)

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

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Parameters:

authorizationSupporting - Type of required supporting materials

Returns:

A reference to this Builder instance

authorizationSupporting

public CoverageEligibilityResponse.Insurance.Item.Builder authorizationSupporting(Collection<CodeableConcept> authorizationSupporting)

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

Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

Parameters:

authorizationSupporting - Type of required supporting materials

Returns:

A reference to this Builder instance

Throws:

NullPointerException - If the passed collection is null

authorizationUrl

public CoverageEligibilityResponse.Insurance.Item.Builder authorizationUrl(Uri authorizationUrl)

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

Parameters:

authorizationUrl - Preauthorization requirements endpoint

Returns:

A reference to this Builder instance

build

public CoverageEligibilityResponse.Insurance.Item build()

Build the CoverageEligibilityResponse.Insurance.Item

Specified by:

build in interface Builder<Element>

Specified by:

build in class BackboneElement.Builder

Returns:

An immutable object of type CoverageEligibilityResponse.Insurance.Item

Throws:

IllegalStateException - if the current state cannot be built into a valid Item per the base specification

validate

protected void validate(CoverageEligibilityResponse.Insurance.Item item)

from

protected CoverageEligibilityResponse.Insurance.Item.Builder from(CoverageEligibilityResponse.Insurance.Item item)