ExplanationOfBenefit (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.ExplanationOfBenefit

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class ExplanationOfBenefit
extends BaseResource
implements IResource
```
HAPI/FHIR ExplanationOfBenefit Resource ()
Definition: This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/ExplanationOfBenefit

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

ExplanationOfBenefit()

Constructors
Constructor and Description
`ExplanationOfBenefit()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`ExplanationOfBenefit`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Date`	`getCreated()` Gets the value(s) for created ().
`DateTimeDt`	`getCreatedElement()` Gets the value(s) for created ().
`String`	`getDisposition()` Gets the value(s) for disposition ().
`StringDt`	`getDispositionElement()` Gets the value(s) for disposition ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`ResourceReferenceDt`	`getOrganization()` Gets the value(s) for organization ().
`CodingDt`	`getOriginalRuleset()` Gets the value(s) for originalRuleset ().
`String`	`getOutcome()` Gets the value(s) for outcome ().
`BoundCodeDt<RemittanceOutcomeEnum>`	`getOutcomeElement()` Gets the value(s) for outcome ().
`ResourceReferenceDt`	`getRequest()` Gets the value(s) for request ().
`ResourceReferenceDt`	`getRequestOrganization()` Gets the value(s) for requestOrganization ().
`ResourceReferenceDt`	`getRequestProvider()` Gets the value(s) for requestProvider ().
`String`	`getResourceName()`
`CodingDt`	`getRuleset()` Gets the value(s) for ruleset ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`boolean`	`isEmpty()`
`ExplanationOfBenefit`	`setCreated(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for created ()
`ExplanationOfBenefit`	`setCreated(DateTimeDt theValue)` Sets the value(s) for created ()
`ExplanationOfBenefit`	`setCreatedWithSecondsPrecision(Date theDate)` Sets the value for created ()
`ExplanationOfBenefit`	`setDisposition(String theString)` Sets the value for disposition ()
`ExplanationOfBenefit`	`setDisposition(StringDt theValue)` Sets the value(s) for disposition ()
`ExplanationOfBenefit`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`ExplanationOfBenefit`	`setOrganization(ResourceReferenceDt theValue)` Sets the value(s) for organization ()
`ExplanationOfBenefit`	`setOriginalRuleset(CodingDt theValue)` Sets the value(s) for originalRuleset ()
`ExplanationOfBenefit`	`setOutcome(BoundCodeDt<RemittanceOutcomeEnum> theValue)` Sets the value(s) for outcome ()
`ExplanationOfBenefit`	`setOutcome(RemittanceOutcomeEnum theValue)` Sets the value(s) for outcome ()
`ExplanationOfBenefit`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request ()
`ExplanationOfBenefit`	`setRequestOrganization(ResourceReferenceDt theValue)` Sets the value(s) for requestOrganization ()
`ExplanationOfBenefit`	`setRequestProvider(ResourceReferenceDt theValue)` Sets the value(s) for requestProvider ()
`ExplanationOfBenefit`	`setRuleset(CodingDt theValue)` Sets the value(s) for ruleset ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The business identifier of the Explanation of Benefit
    Type: token
    Path: ExplanationOfBenefit.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The business identifier of the Explanation of Benefit
    Type: token
    Path: ExplanationOfBenefit.identifier
- Constructor Detail
  - ExplanationOfBenefit
```
public ExplanationOfBenefit()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: The Response business identifier
  - setIdentifier
```
public ExplanationOfBenefit setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: The Response business identifier
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: The Response business identifier
  - addIdentifier
```
public ExplanationOfBenefit addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: The Response business identifier
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (), creating it if it does not already exist.
    Definition: The Response business identifier
  - getRequest
```
public ResourceReferenceDt getRequest()
```
    Gets the value(s) for request (). creating it if it does not exist. Will not return null.
    Definition: Original request resource reference
  - setRequest
```
public ExplanationOfBenefit setRequest(ResourceReferenceDt theValue)
```
    Sets the value(s) for request ()
    Definition: Original request resource reference
  - getOutcomeElement
```
public BoundCodeDt<RemittanceOutcomeEnum> getOutcomeElement()
```
    Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.
    Definition: Transaction status: error, complete
  - getOutcome
```
public String getOutcome()
```
    Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.
    Definition: Transaction status: error, complete
  - setOutcome
```
public ExplanationOfBenefit setOutcome(BoundCodeDt<RemittanceOutcomeEnum> theValue)
```
    Sets the value(s) for outcome ()
    Definition: Transaction status: error, complete
  - setOutcome
```
public ExplanationOfBenefit setOutcome(RemittanceOutcomeEnum theValue)
```
    Sets the value(s) for outcome ()
    Definition: Transaction status: error, complete
  - getDispositionElement
```
public StringDt getDispositionElement()
```
    Gets the value(s) for disposition (). creating it if it does not exist. Will not return null.
    Definition: A description of the status of the adjudication.
  - getDisposition
```
public String getDisposition()
```
    Gets the value(s) for disposition (). creating it if it does not exist. Will not return null.
    Definition: A description of the status of the adjudication.
  - setDisposition
```
public ExplanationOfBenefit setDisposition(StringDt theValue)
```
    Sets the value(s) for disposition ()
    Definition: A description of the status of the adjudication.
  - setDisposition
```
public ExplanationOfBenefit setDisposition(String theString)
```
    Sets the value for disposition ()
    Definition: A description of the status of the adjudication.
  - getRuleset
```
public CodingDt getRuleset()
```
    Gets the value(s) for ruleset (). creating it if it does not exist. Will not return null.
    Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - setRuleset
```
public ExplanationOfBenefit setRuleset(CodingDt theValue)
```
    Sets the value(s) for ruleset ()
    Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - getOriginalRuleset
```
public CodingDt getOriginalRuleset()
```
    Gets the value(s) for originalRuleset (). creating it if it does not exist. Will not return null.
    Definition: The style (standard) and version of the original material which was converted into this resource.
  - setOriginalRuleset
```
public ExplanationOfBenefit setOriginalRuleset(CodingDt theValue)
```
    Sets the value(s) for originalRuleset ()
    Definition: The style (standard) and version of the original material which was converted into this resource.
  - getCreatedElement
```
public DateTimeDt getCreatedElement()
```
    Gets the value(s) for created (). creating it if it does not exist. Will not return null.
    Definition: The date when the enclosed suite of services were performed or completed
  - getCreated
```
public Date getCreated()
```
    Gets the value(s) for created (). creating it if it does not exist. Will not return null.
    Definition: The date when the enclosed suite of services were performed or completed
  - setCreated
```
public ExplanationOfBenefit setCreated(DateTimeDt theValue)
```
    Sets the value(s) for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - setCreated
```
public ExplanationOfBenefit setCreated(Date theDate,
                                       TemporalPrecisionEnum thePrecision)
```
    Sets the value for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - setCreatedWithSecondsPrecision
```
public ExplanationOfBenefit setCreatedWithSecondsPrecision(Date theDate)
```
    Sets the value for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - getOrganization
```
public ResourceReferenceDt getOrganization()
```
    Gets the value(s) for organization (). creating it if it does not exist. Will not return null.
    Definition: The Insurer who produced this adjudicated response.
  - setOrganization
```
public ExplanationOfBenefit setOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for organization ()
    Definition: The Insurer who produced this adjudicated response.
  - getRequestProvider
```
public ResourceReferenceDt getRequestProvider()
```
    Gets the value(s) for requestProvider (). creating it if it does not exist. Will not return null.
    Definition: The practitioner who is responsible for the services rendered to the patient.
  - setRequestProvider
```
public ExplanationOfBenefit setRequestProvider(ResourceReferenceDt theValue)
```
    Sets the value(s) for requestProvider ()
    Definition: The practitioner who is responsible for the services rendered to the patient.
  - getRequestOrganization
```
public ResourceReferenceDt getRequestOrganization()
```
    Gets the value(s) for requestOrganization (). creating it if it does not exist. Will not return null.
    Definition: The organization which is responsible for the services rendered to the patient.
  - setRequestOrganization
```
public ExplanationOfBenefit setRequestOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for requestOrganization ()
    Definition: The organization which is responsible for the services rendered to the patient.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class ExplanationOfBenefit

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_IDENTIFIER

IDENTIFIER

Constructor Detail

ExplanationOfBenefit

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getRequest

setRequest

getOutcomeElement

getOutcome

setOutcome

setOutcome

getDispositionElement

getDisposition

setDisposition

setDisposition

getRuleset

setRuleset

getOriginalRuleset

setOriginalRuleset

getCreatedElement

getCreated

setCreated

setCreated

setCreatedWithSecondsPrecision

getOrganization

setOrganization

getRequestProvider

setRequestProvider

getRequestOrganization

setRequestOrganization

getResourceName

getStructureFhirVersionEnum