PaymentReconciliation (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.PaymentReconciliation

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class PaymentReconciliation
extends BaseResource
implements IResource
```
HAPI/FHIR PaymentReconciliation Resource ()
Definition: This resource provides payment details and claim references supporting a bulk payment.

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PaymentReconciliation.Detail` Block class for child element: PaymentReconciliation.detail ()
`static class`	`PaymentReconciliation.Note` Block class for child element: PaymentReconciliation.note ()

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

PaymentReconciliation()

Constructors
Constructor and Description
`PaymentReconciliation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentReconciliation.Detail`	`addDetail()` Adds and returns a new value for detail ()
`PaymentReconciliation`	`addDetail(PaymentReconciliation.Detail theValue)` Adds a given new value for detail ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`PaymentReconciliation`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`PaymentReconciliation.Note`	`addNote()` Adds and returns a new value for note ()
`PaymentReconciliation`	`addNote(PaymentReconciliation.Note theValue)` Adds a given new value for note ()
`<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 ().
`List<PaymentReconciliation.Detail>`	`getDetail()` Gets the value(s) for detail ().
`PaymentReconciliation.Detail`	`getDetailFirstRep()` Gets the first repetition for detail (), creating it if it does not already exist.
`String`	`getDisposition()` Gets the value(s) for disposition ().
`StringDt`	`getDispositionElement()` Gets the value(s) for disposition ().
`CodingDt`	`getForm()` Gets the value(s) for form ().
`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.
`List<PaymentReconciliation.Note>`	`getNote()` Gets the value(s) for note ().
`PaymentReconciliation.Note`	`getNoteFirstRep()` Gets the first repetition for note (), 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 ().
`PeriodDt`	`getPeriod()` Gets the value(s) for period ().
`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()`
`MoneyDt`	`getTotal()` Gets the value(s) for total ().
`boolean`	`isEmpty()`
`PaymentReconciliation`	`setCreated(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for created ()
`PaymentReconciliation`	`setCreated(DateTimeDt theValue)` Sets the value(s) for created ()
`PaymentReconciliation`	`setCreatedWithSecondsPrecision(Date theDate)` Sets the value for created ()
`PaymentReconciliation`	`setDetail(List<PaymentReconciliation.Detail> theValue)` Sets the value(s) for detail ()
`PaymentReconciliation`	`setDisposition(String theString)` Sets the value for disposition ()
`PaymentReconciliation`	`setDisposition(StringDt theValue)` Sets the value(s) for disposition ()
`PaymentReconciliation`	`setForm(CodingDt theValue)` Sets the value(s) for form ()
`PaymentReconciliation`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`PaymentReconciliation`	`setNote(List<PaymentReconciliation.Note> theValue)` Sets the value(s) for note ()
`PaymentReconciliation`	`setOrganization(ResourceReferenceDt theValue)` Sets the value(s) for organization ()
`PaymentReconciliation`	`setOriginalRuleset(CodingDt theValue)` Sets the value(s) for originalRuleset ()
`PaymentReconciliation`	`setOutcome(BoundCodeDt<RemittanceOutcomeEnum> theValue)` Sets the value(s) for outcome ()
`PaymentReconciliation`	`setOutcome(RemittanceOutcomeEnum theValue)` Sets the value(s) for outcome ()
`PaymentReconciliation`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period ()
`PaymentReconciliation`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request ()
`PaymentReconciliation`	`setRequestOrganization(ResourceReferenceDt theValue)` Sets the value(s) for requestOrganization ()
`PaymentReconciliation`	`setRequestProvider(ResourceReferenceDt theValue)` Sets the value(s) for requestProvider ()
`PaymentReconciliation`	`setRuleset(CodingDt theValue)` Sets the value(s) for ruleset ()
`PaymentReconciliation`	`setTotal(MoneyDt theValue)` Sets the value(s) for total ()

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: PaymentReconciliation.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: PaymentReconciliation.identifier
- Constructor Detail
  - PaymentReconciliation
```
public PaymentReconciliation()
```
- 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 PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation setOutcome(BoundCodeDt<RemittanceOutcomeEnum> theValue)
```
    Sets the value(s) for outcome ()
    Definition: Transaction status: error, complete
  - setOutcome
```
public PaymentReconciliation 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 PaymentReconciliation setDisposition(StringDt theValue)
```
    Sets the value(s) for disposition ()
    Definition: A description of the status of the adjudication.
  - setDisposition
```
public PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation setCreated(DateTimeDt theValue)
```
    Sets the value(s) for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - setCreated
```
public PaymentReconciliation 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 PaymentReconciliation setCreatedWithSecondsPrecision(Date theDate)
```
    Sets the value for created ()
    Definition: The date when the enclosed suite of services were performed or completed
  - getPeriod
```
public PeriodDt getPeriod()
```
    Gets the value(s) for period (). creating it if it does not exist. Will not return null.
    Definition: The period of time for which payments have been gathered into this bulk payment for settlement.
  - setPeriod
```
public PaymentReconciliation setPeriod(PeriodDt theValue)
```
    Sets the value(s) for period ()
    Definition: The period of time for which payments have been gathered into this bulk payment for settlement.
  - 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 PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation setRequestOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for requestOrganization ()
    Definition: The organization which is responsible for the services rendered to the patient.
  - getDetail
```
public List<PaymentReconciliation.Detail> getDetail()
```
    Gets the value(s) for detail (). creating it if it does not exist. Will not return null.
    Definition: List of individual settlement amounts and the corresponding transaction.
  - setDetail
```
public PaymentReconciliation setDetail(List<PaymentReconciliation.Detail> theValue)
```
    Sets the value(s) for detail ()
    Definition: List of individual settlement amounts and the corresponding transaction.
  - addDetail
```
public PaymentReconciliation.Detail addDetail()
```
    Adds and returns a new value for detail ()
    Definition: List of individual settlement amounts and the corresponding transaction.
  - addDetail
```
public PaymentReconciliation addDetail(PaymentReconciliation.Detail theValue)
```
    Adds a given new value for detail ()
    Definition: List of individual settlement amounts and the corresponding transaction.
    
    Parameters:
    
    theValue - The detail to add (must not be null)
  - getDetailFirstRep
```
public PaymentReconciliation.Detail getDetailFirstRep()
```
    Gets the first repetition for detail (), creating it if it does not already exist.
    Definition: List of individual settlement amounts and the corresponding transaction.
  - getForm
```
public CodingDt getForm()
```
    Gets the value(s) for form (). creating it if it does not exist. Will not return null.
    Definition: The form to be used for printing the content.
  - setForm
```
public PaymentReconciliation setForm(CodingDt theValue)
```
    Sets the value(s) for form ()
    Definition: The form to be used for printing the content.
  - getTotal
```
public MoneyDt getTotal()
```
    Gets the value(s) for total (). creating it if it does not exist. Will not return null.
    Definition: Total payment amount.
  - setTotal
```
public PaymentReconciliation setTotal(MoneyDt theValue)
```
    Sets the value(s) for total ()
    Definition: Total payment amount.
  - getNote
```
public List<PaymentReconciliation.Note> getNote()
```
    Gets the value(s) for note (). creating it if it does not exist. Will not return null.
    Definition: Suite of notes
  - setNote
```
public PaymentReconciliation setNote(List<PaymentReconciliation.Note> theValue)
```
    Sets the value(s) for note ()
    Definition: Suite of notes
  - addNote
```
public PaymentReconciliation.Note addNote()
```
    Adds and returns a new value for note ()
    Definition: Suite of notes
  - addNote
```
public PaymentReconciliation addNote(PaymentReconciliation.Note theValue)
```
    Adds a given new value for note ()
    Definition: Suite of notes
    
    Parameters:
    
    theValue - The note to add (must not be null)
  - getNoteFirstRep
```
public PaymentReconciliation.Note getNoteFirstRep()
```
    Gets the first repetition for note (), creating it if it does not already exist.
    Definition: Suite of notes
  - 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 PaymentReconciliation

Nested Class Summary

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

PaymentReconciliation

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

getPeriod

setPeriod

getOrganization

setOrganization

getRequestProvider

setRequestProvider

getRequestOrganization

setRequestOrganization

getDetail

setDetail

addDetail

addDetail

getDetailFirstRep

getForm

setForm

getTotal

setTotal

getNote

setNote

addNote

addNote

getNoteFirstRep

getResourceName

getStructureFhirVersionEnum