Package org.hl7.fhir.r5.model

Class PaymentReconciliation

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.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 the details including amount of a payment and allocates the payment items being paid.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentReconciliation.NotesComponent
static enum	PaymentReconciliation.NoteType
static class	PaymentReconciliation.NoteTypeEnumFactory
static enum	PaymentReconciliation.PaymentOutcome
static class	PaymentReconciliation.PaymentOutcomeEnumFactory
static class	PaymentReconciliation.PaymentReconciliationAllocationComponent

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 StringType	accountNumber	A portion of the account number, often the last 4 digits, used for verification not charging purposes.
protected List<PaymentReconciliation.PaymentReconciliationAllocationComponent>	allocation	Distribution of the payment amount for a previously acknowledged payable.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ALLOCATION_ACCOUNT	Fluent Client search parameter constant for allocation-account
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ALLOCATION_ENCOUNTER	Fluent Client search parameter constant for allocation-encounter
protected Money	amount	Total payment amount as indicated on the financial instrument.
protected StringType	authorization	An alphanumeric issued by the processor to confirm the successful issuance of payment.
protected StringType	cardBrand	The card brand such as debit, Visa, Amex etc.
protected DateTimeType	created	The date when the resource was created.
static final ca.uhn.fhir.rest.gclient.DateClientParam	CREATED	Fluent Client search parameter constant for created
protected DateType	date	The date of payment as indicated on the financial instrument.
protected StringType	disposition	A human readable description of the status of the request for the reconciliation.
static final ca.uhn.fhir.rest.gclient.StringClientParam	DISPOSITION	Fluent Client search parameter constant for disposition
protected Reference	enterer	Payment enterer if not the actual payment issuer.
protected DateType	expirationDate	The year and month (YYYY-MM) when the instrument, typically card, expires.
protected CodeableConcept	formCode	A code for the form to be used for printing the content.
protected List<Identifier>	identifier	A unique identifier assigned to this payment reconciliation.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ALLOCATION_ACCOUNT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ALLOCATION_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PAYMENT_ISSUER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUEST	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUESTOR	Constant for fluent queries to be used to add include statements.
protected CodeableConcept	issuerType	The type of the source such as patient or insurance.
protected CodeableConcept	kind	The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc.
protected Reference	location	The location of the site or device for electronic transfers or physical location for cash payments.
protected CodeableConcept	method	The means of payment such as check, card cash, or electronic funds transfer.
protected Enumeration<PaymentReconciliation.PaymentOutcome>	outcome	The outcome of a request for a reconciliation.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	OUTCOME	Fluent Client search parameter constant for outcome
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PAYMENT_ISSUER	Fluent Client search parameter constant for payment-issuer
protected Identifier	paymentIdentifier	Issuer's unique identifier for the payment instrument.
protected Reference	paymentIssuer	The party who generated the payment.
protected Period	period	The period of time for which payments have been gathered into this bulk payment for settlement.
protected List<PaymentReconciliation.NotesComponent>	processNote	A note that describes or explains the processing in a human readable form.
protected StringType	processor	The name of the card processor, etf processor, bank for checks.
protected StringType	referenceNumber	The check number, eft reference, car processor reference.
protected Reference	request	Original request resource reference.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUEST	Fluent Client search parameter constant for request
protected Reference	requestor	The practitioner who is responsible for the services rendered to the patient.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTOR	Fluent Client search parameter constant for requestor
protected Money	returnedAmount	The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'.
static final String	SP_ALLOCATION_ACCOUNT	Search parameter: allocation-account
static final String	SP_ALLOCATION_ENCOUNTER	Search parameter: allocation-encounter
static final String	SP_CREATED	Search parameter: created
static final String	SP_DISPOSITION	Search parameter: disposition
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_OUTCOME	Search parameter: outcome
static final String	SP_PAYMENT_ISSUER	Search parameter: payment-issuer
static final String	SP_REQUEST	Search parameter: request
static final String	SP_REQUESTOR	Search parameter: requestor
static final String	SP_STATUS	Search parameter: status
protected Enumeration<Enumerations.FinancialResourceStatusCodes>	status	The status of the resource instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Money	tenderedAmount	The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.
protected CodeableConcept	type	Code to indicate the nature of the payment such as payment, adjustment.

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.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()	Constructor
PaymentReconciliation(CodeableConcept type, Enumerations.FinancialResourceStatusCodes status, Date created, Date date, Money amount)	Constructor

Method Summary

Modifier and Type	Method	Description
PaymentReconciliation.PaymentReconciliationAllocationComponent	addAllocation()
PaymentReconciliation	addAllocation(PaymentReconciliation.PaymentReconciliationAllocationComponent t)
Base	addChild(String name)
Identifier	addIdentifier()
PaymentReconciliation	addIdentifier(Identifier t)
PaymentReconciliation.NotesComponent	addProcessNote()
PaymentReconciliation	addProcessNote(PaymentReconciliation.NotesComponent t)
PaymentReconciliation	copy()
void	copyValues(PaymentReconciliation dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getAccountNumber()
StringType	getAccountNumberElement()
List<PaymentReconciliation.PaymentReconciliationAllocationComponent>	getAllocation()
PaymentReconciliation.PaymentReconciliationAllocationComponent	getAllocationFirstRep()
Money	getAmount()
String	getAuthorization()
StringType	getAuthorizationElement()
String	getCardBrand()
StringType	getCardBrandElement()
Date	getCreated()
DateTimeType	getCreatedElement()
Date	getDate()
DateType	getDateElement()
String	getDisposition()
StringType	getDispositionElement()
Reference	getEnterer()
Date	getExpirationDate()
DateType	getExpirationDateElement()
CodeableConcept	getFormCode()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
CodeableConcept	getIssuerType()
CodeableConcept	getKind()
Reference	getLocation()
CodeableConcept	getMethod()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
PaymentReconciliation.PaymentOutcome	getOutcome()
Enumeration<PaymentReconciliation.PaymentOutcome>	getOutcomeElement()
Identifier	getPaymentIdentifier()
Reference	getPaymentIssuer()
Period	getPeriod()
List<PaymentReconciliation.NotesComponent>	getProcessNote()
PaymentReconciliation.NotesComponent	getProcessNoteFirstRep()
String	getProcessor()
StringType	getProcessorElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getReferenceNumber()
StringType	getReferenceNumberElement()
Reference	getRequest()
Reference	getRequestor()
ResourceType	getResourceType()
Money	getReturnedAmount()
Enumerations.FinancialResourceStatusCodes	getStatus()
Enumeration<Enumerations.FinancialResourceStatusCodes>	getStatusElement()
Money	getTenderedAmount()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAccountNumber()
boolean	hasAccountNumberElement()
boolean	hasAllocation()
boolean	hasAmount()
boolean	hasAuthorization()
boolean	hasAuthorizationElement()
boolean	hasCardBrand()
boolean	hasCardBrandElement()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDisposition()
boolean	hasDispositionElement()
boolean	hasEnterer()
boolean	hasExpirationDate()
boolean	hasExpirationDateElement()
boolean	hasFormCode()
boolean	hasIdentifier()
boolean	hasIssuerType()
boolean	hasKind()
boolean	hasLocation()
boolean	hasMethod()
boolean	hasOutcome()
boolean	hasOutcomeElement()
boolean	hasPaymentIdentifier()
boolean	hasPaymentIssuer()
boolean	hasPeriod()
boolean	hasProcessNote()
boolean	hasProcessor()
boolean	hasProcessorElement()
boolean	hasReferenceNumber()
boolean	hasReferenceNumberElement()
boolean	hasRequest()
boolean	hasRequestor()
boolean	hasReturnedAmount()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTenderedAmount()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
PaymentReconciliation	setAccountNumber(String value)
PaymentReconciliation	setAccountNumberElement(StringType value)
PaymentReconciliation	setAllocation(List<PaymentReconciliation.PaymentReconciliationAllocationComponent> theAllocation)
PaymentReconciliation	setAmount(Money value)
PaymentReconciliation	setAuthorization(String value)
PaymentReconciliation	setAuthorizationElement(StringType value)
PaymentReconciliation	setCardBrand(String value)
PaymentReconciliation	setCardBrandElement(StringType value)
PaymentReconciliation	setCreated(Date value)
PaymentReconciliation	setCreatedElement(DateTimeType value)
PaymentReconciliation	setDate(Date value)
PaymentReconciliation	setDateElement(DateType value)
PaymentReconciliation	setDisposition(String value)
PaymentReconciliation	setDispositionElement(StringType value)
PaymentReconciliation	setEnterer(Reference value)
PaymentReconciliation	setExpirationDate(Date value)
PaymentReconciliation	setExpirationDateElement(DateType value)
PaymentReconciliation	setFormCode(CodeableConcept value)
PaymentReconciliation	setIdentifier(List<Identifier> theIdentifier)
PaymentReconciliation	setIssuerType(CodeableConcept value)
PaymentReconciliation	setKind(CodeableConcept value)
PaymentReconciliation	setLocation(Reference value)
PaymentReconciliation	setMethod(CodeableConcept value)
PaymentReconciliation	setOutcome(PaymentReconciliation.PaymentOutcome value)
PaymentReconciliation	setOutcomeElement(Enumeration<PaymentReconciliation.PaymentOutcome> value)
PaymentReconciliation	setPaymentIdentifier(Identifier value)
PaymentReconciliation	setPaymentIssuer(Reference value)
PaymentReconciliation	setPeriod(Period value)
PaymentReconciliation	setProcessNote(List<PaymentReconciliation.NotesComponent> theProcessNote)
PaymentReconciliation	setProcessor(String value)
PaymentReconciliation	setProcessorElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
PaymentReconciliation	setReferenceNumber(String value)
PaymentReconciliation	setReferenceNumberElement(StringType value)
PaymentReconciliation	setRequest(Reference value)
PaymentReconciliation	setRequestor(Reference value)
PaymentReconciliation	setReturnedAmount(Money value)
PaymentReconciliation	setStatus(Enumerations.FinancialResourceStatusCodes value)
PaymentReconciliation	setStatusElement(Enumeration<Enumerations.FinancialResourceStatusCodes> value)
PaymentReconciliation	setTenderedAmount(Money value)
PaymentReconciliation	setType(CodeableConcept value)
protected PaymentReconciliation	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

A unique identifier assigned to this payment reconciliation.

type

protected CodeableConcept type

Code to indicate the nature of the payment such as payment, adjustment.

status

protected Enumeration<Enumerations.FinancialResourceStatusCodes> status

The status of the resource instance.

kind

protected CodeableConcept kind

The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc.

period

protected Period period

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

created

protected DateTimeType created

The date when the resource was created.

enterer

protected Reference enterer

Payment enterer if not the actual payment issuer.

issuerType

protected CodeableConcept issuerType

The type of the source such as patient or insurance.

paymentIssuer

protected Reference paymentIssuer

The party who generated the payment.

request

protected Reference request

Original request resource reference.

requestor

protected Reference requestor

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

outcome

protected Enumeration<PaymentReconciliation.PaymentOutcome> outcome

The outcome of a request for a reconciliation.

disposition

protected StringType disposition

A human readable description of the status of the request for the reconciliation.

date

protected DateType date

The date of payment as indicated on the financial instrument.

location

protected Reference location

The location of the site or device for electronic transfers or physical location for cash payments.

method

protected CodeableConcept method

The means of payment such as check, card cash, or electronic funds transfer.

cardBrand

protected StringType cardBrand

The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.

accountNumber

protected StringType accountNumber

A portion of the account number, often the last 4 digits, used for verification not charging purposes.

expirationDate

protected DateType expirationDate

The year and month (YYYY-MM) when the instrument, typically card, expires.

processor

protected StringType processor

The name of the card processor, etf processor, bank for checks.

referenceNumber

protected StringType referenceNumber

The check number, eft reference, car processor reference.

authorization

protected StringType authorization

An alphanumeric issued by the processor to confirm the successful issuance of payment.

tenderedAmount

protected Money tenderedAmount

The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.

returnedAmount

protected Money returnedAmount

The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'.

amount

protected Money amount

Total payment amount as indicated on the financial instrument.

paymentIdentifier

protected Identifier paymentIdentifier

Issuer's unique identifier for the payment instrument.

allocation

protected List<PaymentReconciliation.PaymentReconciliationAllocationComponent> allocation

Distribution of the payment amount for a previously acknowledged payable.

formCode

protected CodeableConcept formCode

A code for the form to be used for printing the content.

processNote

protected List<PaymentReconciliation.NotesComponent> processNote

A note that describes or explains the processing in a human readable form.

SP_ALLOCATION_ACCOUNT

public static final String SP_ALLOCATION_ACCOUNT

Search parameter: allocation-account

Description: The account to which payment or adjustment was applied.
Type: reference
Path: PaymentReconciliation.allocation.account

See Also:

• Constant Field Values

ALLOCATION_ACCOUNT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ALLOCATION_ACCOUNT

Fluent Client search parameter constant for allocation-account

Description: The account to which payment or adjustment was applied.
Type: reference
Path: PaymentReconciliation.allocation.account

INCLUDE_ALLOCATION_ACCOUNT

public static final ca.uhn.fhir.model.api.Include INCLUDE_ALLOCATION_ACCOUNT

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentReconciliation:allocation-account".

SP_ALLOCATION_ENCOUNTER

public static final String SP_ALLOCATION_ENCOUNTER

Search parameter: allocation-encounter

Description: The encounter to which payment or adjustment was applied.
Type: reference
Path: PaymentReconciliation.allocation.encounter

See Also:

• Constant Field Values

ALLOCATION_ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ALLOCATION_ENCOUNTER

Fluent Client search parameter constant for allocation-encounter

Description: The encounter to which payment or adjustment was applied.
Type: reference
Path: PaymentReconciliation.allocation.encounter

INCLUDE_ALLOCATION_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ALLOCATION_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentReconciliation:allocation-encounter".

SP_CREATED

public static final String SP_CREATED

Search parameter: created

Description: The creation date
Type: date
Path: PaymentReconciliation.created

See Also:

• Constant Field Values

CREATED

public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED

Fluent Client search parameter constant for created

Description: The creation date
Type: date
Path: PaymentReconciliation.created

SP_DISPOSITION

public static final String SP_DISPOSITION

Search parameter: disposition

Description: The contents of the disposition message
Type: string
Path: PaymentReconciliation.disposition

See Also:

• Constant Field Values

DISPOSITION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DISPOSITION

Fluent Client search parameter constant for disposition

Description: The contents of the disposition message
Type: string
Path: PaymentReconciliation.disposition

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The business identifier of the ExplanationOfBenefit
Type: token
Path: PaymentReconciliation.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: The business identifier of the ExplanationOfBenefit
Type: token
Path: PaymentReconciliation.identifier

SP_OUTCOME

public static final String SP_OUTCOME

Search parameter: outcome

Description: The processing outcome
Type: token
Path: PaymentReconciliation.outcome

See Also:

• Constant Field Values

OUTCOME

public static final ca.uhn.fhir.rest.gclient.TokenClientParam OUTCOME

Fluent Client search parameter constant for outcome

Description: The processing outcome
Type: token
Path: PaymentReconciliation.outcome

SP_PAYMENT_ISSUER

public static final String SP_PAYMENT_ISSUER

Search parameter: payment-issuer

Description: The organization which generated this resource
Type: reference
Path: PaymentReconciliation.paymentIssuer

See Also:

• Constant Field Values

PAYMENT_ISSUER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PAYMENT_ISSUER

Fluent Client search parameter constant for payment-issuer

Description: The organization which generated this resource
Type: reference
Path: PaymentReconciliation.paymentIssuer

INCLUDE_PAYMENT_ISSUER

public static final ca.uhn.fhir.model.api.Include INCLUDE_PAYMENT_ISSUER

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentReconciliation:payment-issuer".

SP_REQUEST

public static final String SP_REQUEST

Search parameter: request

Description: The reference to the claim
Type: reference
Path: PaymentReconciliation.request

See Also:

• Constant Field Values

REQUEST

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUEST

Fluent Client search parameter constant for request

Description: The reference to the claim
Type: reference
Path: PaymentReconciliation.request

INCLUDE_REQUEST

public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentReconciliation:request".

SP_REQUESTOR

public static final String SP_REQUESTOR

Search parameter: requestor

Description: The reference to the provider who submitted the claim
Type: reference
Path: PaymentReconciliation.requestor

See Also:

• Constant Field Values

REQUESTOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTOR

Fluent Client search parameter constant for requestor

Description: The reference to the provider who submitted the claim
Type: reference
Path: PaymentReconciliation.requestor

INCLUDE_REQUESTOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "PaymentReconciliation:requestor".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the payment reconciliation
Type: token
Path: PaymentReconciliation.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The status of the payment reconciliation
Type: token
Path: PaymentReconciliation.status

Constructor Details

PaymentReconciliation

public PaymentReconciliation()

Constructor

PaymentReconciliation

public PaymentReconciliation(CodeableConcept type,
 Enumerations.FinancialResourceStatusCodes status,
 Date created,
 Date date,
 Money amount)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A unique identifier assigned to this payment reconciliation.)

setIdentifier

public PaymentReconciliation setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public PaymentReconciliation addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getType

public CodeableConcept getType()

Returns:

type (Code to indicate the nature of the payment such as payment, adjustment.)

hasType

public boolean hasType()

setType

public PaymentReconciliation setType(CodeableConcept value)

Parameters:

value - type (Code to indicate the nature of the payment such as payment, adjustment.)

getStatusElement

public Enumeration<Enumerations.FinancialResourceStatusCodes> getStatusElement()

Returns:

status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public PaymentReconciliation setStatusElement(Enumeration<Enumerations.FinancialResourceStatusCodes> value)

Parameters:

value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.FinancialResourceStatusCodes getStatus()

Returns:

The status of the resource instance.

setStatus

public PaymentReconciliation setStatus(Enumerations.FinancialResourceStatusCodes value)

Parameters:

value - The status of the resource instance.

getKind

public CodeableConcept getKind()

Returns:

kind (The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc.)

hasKind

public boolean hasKind()

setKind

public PaymentReconciliation setKind(CodeableConcept value)

Parameters:

value - kind (The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc.)

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

getCreatedElement

public DateTimeType getCreatedElement()

Returns:

created (The date when the resource was created.). 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 resource was created.). 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 resource was created.

setCreated

public PaymentReconciliation setCreated(Date value)

Parameters:

value - The date when the resource was created.

getEnterer

public Reference getEnterer()

Returns:

enterer (Payment enterer if not the actual payment issuer.)

hasEnterer

public boolean hasEnterer()

setEnterer

public PaymentReconciliation setEnterer(Reference value)

Parameters:

value - enterer (Payment enterer if not the actual payment issuer.)

getIssuerType

public CodeableConcept getIssuerType()

Returns:

issuerType (The type of the source such as patient or insurance.)

hasIssuerType

public boolean hasIssuerType()

setIssuerType

public PaymentReconciliation setIssuerType(CodeableConcept value)

Parameters:

value - issuerType (The type of the source such as patient or insurance.)

getPaymentIssuer

public Reference getPaymentIssuer()

Returns:

paymentIssuer (The party who generated the payment.)

hasPaymentIssuer

public boolean hasPaymentIssuer()

setPaymentIssuer

public PaymentReconciliation setPaymentIssuer(Reference value)

Parameters:

value - paymentIssuer (The party who generated the payment.)

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

getRequestor

public Reference getRequestor()

Returns:

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

hasRequestor

public boolean hasRequestor()

setRequestor

public PaymentReconciliation setRequestor(Reference value)

Parameters:

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

getOutcomeElement

public Enumeration<PaymentReconciliation.PaymentOutcome> getOutcomeElement()

Returns:

outcome (The outcome of a request for a reconciliation.). 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<PaymentReconciliation.PaymentOutcome> value)

Parameters:

value - outcome (The outcome of a request for a reconciliation.). This is the underlying object with id, value and extensions. The accessor "getOutcome" gives direct access to the value

getOutcome

public PaymentReconciliation.PaymentOutcome getOutcome()

Returns:

The outcome of a request for a reconciliation.

setOutcome

public PaymentReconciliation setOutcome(PaymentReconciliation.PaymentOutcome value)

Parameters:

value - The outcome of a request for a reconciliation.

getDispositionElement

public StringType getDispositionElement()

Returns:

disposition (A human readable description of the status of the request for the reconciliation.). 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 human readable description of the status of the request for the reconciliation.). 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 human readable description of the status of the request for the reconciliation.

setDisposition

public PaymentReconciliation setDisposition(String value)

Parameters:

value - A human readable description of the status of the request for the reconciliation.

getDateElement

public DateType getDateElement()

Returns:

date (The date of payment as indicated on the financial instrument.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

hasDate

public boolean hasDate()

setDateElement

public PaymentReconciliation setDateElement(DateType value)

Parameters:

value - date (The date of payment as indicated on the financial instrument.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Returns:

The date of payment as indicated on the financial instrument.

setDate

public PaymentReconciliation setDate(Date value)

Parameters:

value - The date of payment as indicated on the financial instrument.

getLocation

public Reference getLocation()

Returns:

location (The location of the site or device for electronic transfers or physical location for cash payments.)

hasLocation

public boolean hasLocation()

setLocation

public PaymentReconciliation setLocation(Reference value)

Parameters:

value - location (The location of the site or device for electronic transfers or physical location for cash payments.)

getMethod

public CodeableConcept getMethod()

Returns:

method (The means of payment such as check, card cash, or electronic funds transfer.)

hasMethod

public boolean hasMethod()

setMethod

public PaymentReconciliation setMethod(CodeableConcept value)

Parameters:

value - method (The means of payment such as check, card cash, or electronic funds transfer.)

getCardBrandElement

public StringType getCardBrandElement()

Returns:

cardBrand (The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.). This is the underlying object with id, value and extensions. The accessor "getCardBrand" gives direct access to the value

hasCardBrandElement

public boolean hasCardBrandElement()

hasCardBrand

public boolean hasCardBrand()

setCardBrandElement

public PaymentReconciliation setCardBrandElement(StringType value)

Parameters:

value - cardBrand (The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.). This is the underlying object with id, value and extensions. The accessor "getCardBrand" gives direct access to the value

getCardBrand

public String getCardBrand()

Returns:

The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.

setCardBrand

public PaymentReconciliation setCardBrand(String value)

Parameters:

value - The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.

getAccountNumberElement

public StringType getAccountNumberElement()

Returns:

accountNumber (A portion of the account number, often the last 4 digits, used for verification not charging purposes.). This is the underlying object with id, value and extensions. The accessor "getAccountNumber" gives direct access to the value

hasAccountNumberElement

public boolean hasAccountNumberElement()

hasAccountNumber

public boolean hasAccountNumber()

setAccountNumberElement

public PaymentReconciliation setAccountNumberElement(StringType value)

Parameters:

value - accountNumber (A portion of the account number, often the last 4 digits, used for verification not charging purposes.). This is the underlying object with id, value and extensions. The accessor "getAccountNumber" gives direct access to the value

getAccountNumber

public String getAccountNumber()

Returns:

A portion of the account number, often the last 4 digits, used for verification not charging purposes.

setAccountNumber

public PaymentReconciliation setAccountNumber(String value)

Parameters:

value - A portion of the account number, often the last 4 digits, used for verification not charging purposes.

getExpirationDateElement

public DateType getExpirationDateElement()

Returns:

expirationDate (The year and month (YYYY-MM) when the instrument, typically card, expires.). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value

hasExpirationDateElement

public boolean hasExpirationDateElement()

hasExpirationDate

public boolean hasExpirationDate()

setExpirationDateElement

public PaymentReconciliation setExpirationDateElement(DateType value)

Parameters:

value - expirationDate (The year and month (YYYY-MM) when the instrument, typically card, expires.). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value

getExpirationDate

public Date getExpirationDate()

Returns:

The year and month (YYYY-MM) when the instrument, typically card, expires.

setExpirationDate

public PaymentReconciliation setExpirationDate(Date value)

Parameters:

value - The year and month (YYYY-MM) when the instrument, typically card, expires.

getProcessorElement

public StringType getProcessorElement()

Returns:

processor (The name of the card processor, etf processor, bank for checks.). This is the underlying object with id, value and extensions. The accessor "getProcessor" gives direct access to the value

hasProcessorElement

public boolean hasProcessorElement()

hasProcessor

public boolean hasProcessor()

setProcessorElement

public PaymentReconciliation setProcessorElement(StringType value)

Parameters:

value - processor (The name of the card processor, etf processor, bank for checks.). This is the underlying object with id, value and extensions. The accessor "getProcessor" gives direct access to the value

getProcessor

public String getProcessor()

Returns:

The name of the card processor, etf processor, bank for checks.

setProcessor

public PaymentReconciliation setProcessor(String value)

Parameters:

value - The name of the card processor, etf processor, bank for checks.

getReferenceNumberElement

public StringType getReferenceNumberElement()

Returns:

referenceNumber (The check number, eft reference, car processor reference.). This is the underlying object with id, value and extensions. The accessor "getReferenceNumber" gives direct access to the value

hasReferenceNumberElement

public boolean hasReferenceNumberElement()

hasReferenceNumber

public boolean hasReferenceNumber()

setReferenceNumberElement

public PaymentReconciliation setReferenceNumberElement(StringType value)

Parameters:

value - referenceNumber (The check number, eft reference, car processor reference.). This is the underlying object with id, value and extensions. The accessor "getReferenceNumber" gives direct access to the value

getReferenceNumber

public String getReferenceNumber()

Returns:

The check number, eft reference, car processor reference.

setReferenceNumber

public PaymentReconciliation setReferenceNumber(String value)

Parameters:

value - The check number, eft reference, car processor reference.

getAuthorizationElement

public StringType getAuthorizationElement()

Returns:

authorization (An alphanumeric issued by the processor to confirm the successful issuance of payment.). This is the underlying object with id, value and extensions. The accessor "getAuthorization" gives direct access to the value

hasAuthorizationElement

public boolean hasAuthorizationElement()

hasAuthorization

public boolean hasAuthorization()

setAuthorizationElement

public PaymentReconciliation setAuthorizationElement(StringType value)

Parameters:

value - authorization (An alphanumeric issued by the processor to confirm the successful issuance of payment.). This is the underlying object with id, value and extensions. The accessor "getAuthorization" gives direct access to the value

getAuthorization

public String getAuthorization()

Returns:

An alphanumeric issued by the processor to confirm the successful issuance of payment.

setAuthorization

public PaymentReconciliation setAuthorization(String value)

Parameters:

value - An alphanumeric issued by the processor to confirm the successful issuance of payment.

getTenderedAmount

public Money getTenderedAmount()

Returns:

tenderedAmount (The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.)

hasTenderedAmount

public boolean hasTenderedAmount()

setTenderedAmount

public PaymentReconciliation setTenderedAmount(Money value)

Parameters:

value - tenderedAmount (The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.)

getReturnedAmount

public Money getReturnedAmount()

Returns:

returnedAmount (The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'.)

hasReturnedAmount

public boolean hasReturnedAmount()

setReturnedAmount

public PaymentReconciliation setReturnedAmount(Money value)

Parameters:

value - returnedAmount (The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'.)

getAmount

public Money getAmount()

Returns:

amount (Total payment amount as indicated on the financial instrument.)

hasAmount

public boolean hasAmount()

setAmount

public PaymentReconciliation setAmount(Money value)

Parameters:

value - amount (Total payment amount as indicated on the financial instrument.)

getPaymentIdentifier

public Identifier getPaymentIdentifier()

Returns:

paymentIdentifier (Issuer's unique identifier for the payment instrument.)

hasPaymentIdentifier

public boolean hasPaymentIdentifier()

setPaymentIdentifier

public PaymentReconciliation setPaymentIdentifier(Identifier value)

Parameters:

value - paymentIdentifier (Issuer's unique identifier for the payment instrument.)

getAllocation

public List<PaymentReconciliation.PaymentReconciliationAllocationComponent> getAllocation()

Returns:

allocation (Distribution of the payment amount for a previously acknowledged payable.)

setAllocation

public PaymentReconciliation setAllocation(List<PaymentReconciliation.PaymentReconciliationAllocationComponent> theAllocation)

Returns:

Returns a reference to this for easy method chaining

hasAllocation

public boolean hasAllocation()

addAllocation

public PaymentReconciliation.PaymentReconciliationAllocationComponent addAllocation()

addAllocation

public PaymentReconciliation addAllocation(PaymentReconciliation.PaymentReconciliationAllocationComponent t)

getAllocationFirstRep

public PaymentReconciliation.PaymentReconciliationAllocationComponent getAllocationFirstRep()

Returns:

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

getFormCode

public CodeableConcept getFormCode()

Returns:

formCode (A code for the form to be used for printing the content.)

hasFormCode

public boolean hasFormCode()

setFormCode

public PaymentReconciliation setFormCode(CodeableConcept value)

Parameters:

value - formCode (A code for the form to be used for printing the content.)

getProcessNote

public List<PaymentReconciliation.NotesComponent> getProcessNote()

Returns:

processNote (A note that describes or explains the processing in a human readable form.)

setProcessNote

public PaymentReconciliation setProcessNote(List<PaymentReconciliation.NotesComponent> theProcessNote)

Returns:

Returns a reference to this for easy method chaining

hasProcessNote

public boolean hasProcessNote()

addProcessNote

public PaymentReconciliation.NotesComponent addProcessNote()

addProcessNote

public PaymentReconciliation addProcessNote(PaymentReconciliation.NotesComponent t)

getProcessNoteFirstRep

public PaymentReconciliation.NotesComponent getProcessNoteFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public PaymentReconciliation copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(PaymentReconciliation dst)

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