Package org.hl7.fhir.dstu2.model

Class PaymentReconciliation

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.model.PaymentReconciliation

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class PaymentReconciliation
extends DomainResource

This resource provides payment details and claim references supporting a bulk payment.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentReconciliation.DetailsComponent
static class	PaymentReconciliation.NotesComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected DateTimeType	created	The date when the enclosed suite of services were performed or completed.
protected List<PaymentReconciliation.DetailsComponent>	detail	List of individual settlement amounts and the corresponding transaction.
protected StringType	disposition	A description of the status of the adjudication.
protected Coding	form	The form to be used for printing the content.
protected List<Identifier>	identifier	The Response business identifier.
protected List<PaymentReconciliation.NotesComponent>	note	Suite of notes.
protected Reference	organization	The Insurer who produced this adjudicated response.
protected Organization	organizationTarget	The actual object that is the target of the reference (The Insurer who produced this adjudicated response.)
protected Coding	originalRuleset	The style (standard) and version of the original material which was converted into this resource.
protected Enumeration<Enumerations.RemittanceOutcome>	outcome	Transaction status: error, complete.
protected Period	period	The period of time for which payments have been gathered into this bulk payment for settlement.
protected Reference	request	Original request resource reference.
protected Reference	requestOrganization	The organization which is responsible for the services rendered to the patient.
protected Organization	requestOrganizationTarget	The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)
protected Reference	requestProvider	The practitioner who is responsible for the services rendered to the patient.
protected Practitioner	requestProviderTarget	The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
protected ProcessRequest	requestTarget	The actual object that is the target of the reference (Original request resource reference.)
protected Coding	ruleset	The version of the style of resource contents.
static final String	SP_IDENTIFIER
protected Money	total	Total payment amount.

Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2.model.Resource

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
PaymentReconciliation()
PaymentReconciliation(Money total)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
PaymentReconciliation.DetailsComponent	addDetail()
PaymentReconciliation	addDetail(PaymentReconciliation.DetailsComponent t)
Identifier	addIdentifier()
PaymentReconciliation	addIdentifier(Identifier t)
PaymentReconciliation.NotesComponent	addNote()
PaymentReconciliation	addNote(PaymentReconciliation.NotesComponent t)
PaymentReconciliation	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Date	getCreated()
DateTimeType	getCreatedElement()
List<PaymentReconciliation.DetailsComponent>	getDetail()
String	getDisposition()
StringType	getDispositionElement()
Coding	getForm()
List<Identifier>	getIdentifier()
List<PaymentReconciliation.NotesComponent>	getNote()
Reference	getOrganization()
Organization	getOrganizationTarget()
Coding	getOriginalRuleset()
Enumerations.RemittanceOutcome	getOutcome()
Enumeration<Enumerations.RemittanceOutcome>	getOutcomeElement()
Period	getPeriod()
Reference	getRequest()
Reference	getRequestOrganization()
Organization	getRequestOrganizationTarget()
Reference	getRequestProvider()
Practitioner	getRequestProviderTarget()
ProcessRequest	getRequestTarget()
ResourceType	getResourceType()
Coding	getRuleset()
Money	getTotal()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasDetail()
boolean	hasDisposition()
boolean	hasDispositionElement()
boolean	hasForm()
boolean	hasIdentifier()
boolean	hasNote()
boolean	hasOrganization()
boolean	hasOriginalRuleset()
boolean	hasOutcome()
boolean	hasOutcomeElement()
boolean	hasPeriod()
boolean	hasRequest()
boolean	hasRequestOrganization()
boolean	hasRequestProvider()
boolean	hasRuleset()
boolean	hasTotal()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
PaymentReconciliation	setCreated(Date value)
PaymentReconciliation	setCreatedElement(DateTimeType value)
PaymentReconciliation	setDisposition(String value)
PaymentReconciliation	setDispositionElement(StringType value)
PaymentReconciliation	setForm(Coding value)
PaymentReconciliation	setOrganization(Reference value)
PaymentReconciliation	setOrganizationTarget(Organization value)
PaymentReconciliation	setOriginalRuleset(Coding value)
PaymentReconciliation	setOutcome(Enumerations.RemittanceOutcome value)
PaymentReconciliation	setOutcomeElement(Enumeration<Enumerations.RemittanceOutcome> value)
PaymentReconciliation	setPeriod(Period value)
void	setProperty(String name, Base value)
PaymentReconciliation	setRequest(Reference value)
PaymentReconciliation	setRequestOrganization(Reference value)
PaymentReconciliation	setRequestOrganizationTarget(Organization value)
PaymentReconciliation	setRequestProvider(Reference value)
PaymentReconciliation	setRequestProviderTarget(Practitioner value)
PaymentReconciliation	setRequestTarget(ProcessRequest value)
PaymentReconciliation	setRuleset(Coding value)
PaymentReconciliation	setTotal(Money value)
protected PaymentReconciliation	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, 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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

The Response business identifier.

request

protected Reference request

Original request resource reference.

requestTarget

protected ProcessRequest requestTarget

The actual object that is the target of the reference (Original request resource reference.)

outcome

protected Enumeration<Enumerations.RemittanceOutcome> outcome

Transaction status: error, complete.

disposition

protected StringType disposition

A description of the status of the adjudication.

ruleset

protected Coding ruleset

The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.

originalRuleset

protected Coding originalRuleset

The style (standard) and version of the original material which was converted into this resource.

created

protected DateTimeType created

The date when the enclosed suite of services were performed or completed.

period

protected Period period

The period of time for which payments have been gathered into this bulk payment for settlement.

organization

protected Reference organization

The Insurer who produced this adjudicated response.

organizationTarget

protected Organization organizationTarget

The actual object that is the target of the reference (The Insurer who produced this adjudicated response.)

requestProvider

protected Reference requestProvider

The practitioner who is responsible for the services rendered to the patient.

requestProviderTarget

protected Practitioner requestProviderTarget

The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)

requestOrganization

protected Reference requestOrganization

The organization which is responsible for the services rendered to the patient.

requestOrganizationTarget

protected Organization requestOrganizationTarget

The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)

detail

protected List<PaymentReconciliation.DetailsComponent> detail

List of individual settlement amounts and the corresponding transaction.

form

protected Coding form

The form to be used for printing the content.

total

protected Money total

Total payment amount.

note

protected List<PaymentReconciliation.NotesComponent> note

Suite of notes.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

See Also:

• Constant Field Values

Constructor Details

PaymentReconciliation

public PaymentReconciliation()

PaymentReconciliation

public PaymentReconciliation(Money total)

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (The Response business identifier.)

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

identifier (The Response business identifier.)

addIdentifier

public PaymentReconciliation addIdentifier(Identifier t)

getRequest

public Reference getRequest()

Returns:

request (Original request resource reference.)

hasRequest

public boolean hasRequest()

setRequest

public PaymentReconciliation setRequest(Reference value)

Parameters:

value - request (Original request resource reference.)

getRequestTarget

public ProcessRequest getRequestTarget()

Returns:

request The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Original request resource reference.)

setRequestTarget

public PaymentReconciliation setRequestTarget(ProcessRequest value)

Parameters:

value - request The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Original request resource reference.)

getOutcomeElement

public Enumeration<Enumerations.RemittanceOutcome> getOutcomeElement()

Returns:

outcome (Transaction status: error, complete.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value

hasOutcomeElement

public boolean hasOutcomeElement()

hasOutcome

public boolean hasOutcome()

setOutcomeElement

public PaymentReconciliation setOutcomeElement(Enumeration<Enumerations.RemittanceOutcome> value)

Parameters:

value - outcome (Transaction status: error, complete.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value

getOutcome

public Enumerations.RemittanceOutcome getOutcome()

Returns:

Transaction status: error, complete.

setOutcome

public PaymentReconciliation setOutcome(Enumerations.RemittanceOutcome value)

Parameters:

value - Transaction status: error, complete.

getDispositionElement

public StringType getDispositionElement()

Returns:

disposition (A description of the status of the adjudication.). This is the underlying object with id, value and extensions. The accessor "getDisposition" gives direct access to the value

hasDispositionElement

public boolean hasDispositionElement()

hasDisposition

public boolean hasDisposition()

setDispositionElement

public PaymentReconciliation setDispositionElement(StringType value)

Parameters:

value - disposition (A description of the status of the adjudication.). This is the underlying object with id, value and extensions. The accessor "getDisposition" gives direct access to the value

getDisposition

public String getDisposition()

Returns:

A description of the status of the adjudication.

setDisposition

public PaymentReconciliation setDisposition(String value)

Parameters:

value - A description of the status of the adjudication.

getRuleset

public Coding getRuleset()

Returns:

ruleset (The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)

hasRuleset

public boolean hasRuleset()

setRuleset

public PaymentReconciliation setRuleset(Coding value)

Parameters:

value - ruleset (The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)

getOriginalRuleset

public Coding getOriginalRuleset()

Returns:

originalRuleset (The style (standard) and version of the original material which was converted into this resource.)

hasOriginalRuleset

public boolean hasOriginalRuleset()

setOriginalRuleset

public PaymentReconciliation setOriginalRuleset(Coding value)

Parameters:

value - originalRuleset (The style (standard) and version of the original material which was converted into this resource.)

getCreatedElement

public DateTimeType getCreatedElement()

Returns:

created (The date when the enclosed suite of services were performed or completed.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public PaymentReconciliation setCreatedElement(DateTimeType value)

Parameters:

value - created (The date when the enclosed suite of services were performed or completed.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

getCreated

public Date getCreated()

Returns:

The date when the enclosed suite of services were performed or completed.

setCreated

public PaymentReconciliation setCreated(Date value)

Parameters:

value - The date when the enclosed suite of services were performed or completed.

getPeriod

public Period getPeriod()

Returns:

period (The period of time for which payments have been gathered into this bulk payment for settlement.)

hasPeriod

public boolean hasPeriod()

setPeriod

public PaymentReconciliation setPeriod(Period value)

Parameters:

value - period (The period of time for which payments have been gathered into this bulk payment for settlement.)

getOrganization

public Reference getOrganization()

Returns:

organization (The Insurer who produced this adjudicated response.)

hasOrganization

public boolean hasOrganization()

setOrganization

public PaymentReconciliation setOrganization(Reference value)

Parameters:

value - organization (The Insurer who produced this adjudicated response.)

getOrganizationTarget

public Organization getOrganizationTarget()

Returns:

organization The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The Insurer who produced this adjudicated response.)

setOrganizationTarget

public PaymentReconciliation setOrganizationTarget(Organization value)

Parameters:

value - organization The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The Insurer who produced this adjudicated response.)

getRequestProvider

public Reference getRequestProvider()

Returns:

requestProvider (The practitioner who is responsible for the services rendered to the patient.)

hasRequestProvider

public boolean hasRequestProvider()

setRequestProvider

public PaymentReconciliation setRequestProvider(Reference value)

Parameters:

value - requestProvider (The practitioner who is responsible for the services rendered to the patient.)

getRequestProviderTarget

public Practitioner getRequestProviderTarget()

Returns:

requestProvider The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The practitioner who is responsible for the services rendered to the patient.)

setRequestProviderTarget

public PaymentReconciliation setRequestProviderTarget(Practitioner value)

Parameters:

value - requestProvider The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The practitioner who is responsible for the services rendered to the patient.)

getRequestOrganization

public Reference getRequestOrganization()

Returns:

requestOrganization (The organization which is responsible for the services rendered to the patient.)

hasRequestOrganization

public boolean hasRequestOrganization()

setRequestOrganization

public PaymentReconciliation setRequestOrganization(Reference value)

Parameters:

value - requestOrganization (The organization which is responsible for the services rendered to the patient.)

getRequestOrganizationTarget

public Organization getRequestOrganizationTarget()

Returns:

requestOrganization The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization which is responsible for the services rendered to the patient.)

setRequestOrganizationTarget

public PaymentReconciliation setRequestOrganizationTarget(Organization value)

Parameters:

value - requestOrganization The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization which is responsible for the services rendered to the patient.)

getDetail

public List<PaymentReconciliation.DetailsComponent> getDetail()

Returns:

detail (List of individual settlement amounts and the corresponding transaction.)

hasDetail

public boolean hasDetail()

addDetail

public PaymentReconciliation.DetailsComponent addDetail()

Returns:

detail (List of individual settlement amounts and the corresponding transaction.)

addDetail

public PaymentReconciliation addDetail(PaymentReconciliation.DetailsComponent t)

getForm

public Coding getForm()

Returns:

form (The form to be used for printing the content.)

hasForm

public boolean hasForm()

setForm

public PaymentReconciliation setForm(Coding value)

Parameters:

value - form (The form to be used for printing the content.)

getTotal

public Money getTotal()

Returns:

total (Total payment amount.)

hasTotal

public boolean hasTotal()

setTotal

public PaymentReconciliation setTotal(Money value)

Parameters:

value - total (Total payment amount.)

getNote

public List<PaymentReconciliation.NotesComponent> getNote()

Returns:

note (Suite of notes.)

hasNote

public boolean hasNote()

addNote

public PaymentReconciliation.NotesComponent addNote()

Returns:

note (Suite of notes.)

addNote

public PaymentReconciliation addNote(PaymentReconciliation.NotesComponent t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public PaymentReconciliation copy()

Specified by:

copy in class DomainResource

typedCopy

protected PaymentReconciliation typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource