oracle.hsgbu.hdr.hl7.rim

Interface Account

All Superinterfaces:

Act, InfrastructureRoot, Serializable, Versioned

public interface Account
extends Act

An Act representing a category of financial transactions that are tracked and reported together with a single balance.

Discussion: This can be used to represent the accumulated total of billable amounts for goods or services received, payments made for goods or services, and debit and credit accounts between which financial transactions flow.

Examples: Patient accounts; Encounter accounts; Cost centers; Accounts receivable

See Also:

Act, FinancialTransaction

Summary

Method Summary

Modifier and Type	Method and Description
IVL<MO>	getAllowedBalanceQuantity() An interval describing the minimum and maximum allowed balances for an account.
MO	getBalanceAmt() The total of the debit and credit transactions that have occurred against the account over its lifetime.
CE	getCurrencyCode() Indicates the currency that the account is managed in.
RTO<MO,PQ>	getInterestRateQuantity() A ratio that indicates the rate of interest that the account balance is subject to, and the term over which the interest rate compounds.
ST	getName() The descriptive name of the account as carried in the ledger of which the account is a part.
void	setAllowedBalanceQuantity(IVL<MO> allowedBalanceQuantity)
void	setBalanceAmt(MO balanceAmt)
void	setCurrencyCode(CE currencyCode)
void	setInterestRateQuantity(RTO<MO,PQ> interestRateQuantity)
void	setName(ST name)

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.Act

addConfidentialityCode, addIBActRelationship, addId, addOBActRelationship, addParticipation, addPriorityCode, addReasonCode, getActivityTime, getAvailabilityTime, getClassCode, getCode, getConfidentialityCode, getDerivationExpr, getEffectiveTime, getIBActRelationships, getIBActRelationships, getId, getIndependentInd, getInterruptibleInd, getLanguageCode, getLevelCode, getMoodCode, getNegationInd, getOBActRelationships, getOBActRelationships, getParticipations, getParticipations, getPriorityCode, getReasonCode, getRepeatNumber, getStatusCode, getText, getTitle, getUncertaintyCode, setActivityTime, setAvailabilityTime, setConfidentialityCode, setDerivationExpr, setEffectiveTime, setIndependentInd, setInterruptibleInd, setLanguageCode, setLevelCode, setNegationInd, setPriorityCode, setReasonCode, setRepeatNumber, setStatusCode, setText, setTitle, setUncertaintyCode

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.InfrastructureRoot

getControlAct, getToken, setToken

Methods inherited from interface oracle.hsgbu.hdr.hl7.fwk.Versioned

createNewVersion, getVersionNum, isCurrentVersion

Method Detail

getName

ST getName()

The descriptive name of the account as carried in the ledger of which the account is a part.

Discussion: This is *not* the identifier for the account. (Use "id" for account identifiers, name for descriptive/meaningful labels.)

Examples: "June 2002 Costs"; "John Smith Receivables"

setName

void setName(ST name)
      throws HDRRimException

Throws:

HDRRimException

getBalanceAmt

MO getBalanceAmt()

The total of the debit and credit transactions that have occurred against the account over its lifetime. Discussion: The balance of an account will generally be communicated in the currency identified as the account"s currencyCode. However, it is allowed to communicate the balance in alternative currencies.

setBalanceAmt

void setBalanceAmt(MO balanceAmt)
            throws HDRRimException

Throws:

HDRRimException

getCurrencyCode

CE getCurrencyCode()

Indicates the currency that the account is managed in.

Discussion: Specific amounts might be reported in another currency however this represents the default currency for activity in this account.

Membership code to be used:

CL_ACCT_CURRENCY_CODE

setCurrencyCode

void setCurrencyCode(CE currencyCode)
              throws HDRRimException

Throws:

HDRRimException

getInterestRateQuantity

RTO<MO,PQ> getInterestRateQuantity()

A ratio that indicates the rate of interest that the account balance is subject to, and the term over which the interest rate compounds.

Discussion: This may represent interest charged (example, for loans, overdue accounts, etc.) or credited (investments, etc.) depending on the type of account.

Examples: 0.10/1a (10%/year); 0.0005895/1d (.05895%/day)

Constraints: Unit of the denominator PQ data type must be comparable to seconds. (I.e. the denominator must be measured in time.)

setInterestRateQuantity

void setInterestRateQuantity(RTO<MO,PQ> interestRateQuantity)
                      throws HDRRimException

Throws:

HDRRimException

getAllowedBalanceQuantity

IVL<MO> getAllowedBalanceQuantity()

An interval describing the minimum and maximum allowed balances for an account.

Discussion: These are not necessarily "hard" limits (i.e. the account may go above or below the specified amounts), however, they represent the "target" range for the account, and there may be consequences for going outside the specified boundaries. It is not necessary to specify both upper and lower limits (or either) for an account.

Examples: "stop loss" limits; credit limits

setAllowedBalanceQuantity

void setAllowedBalanceQuantity(IVL<MO> allowedBalanceQuantity)
                        throws HDRRimException

Throws:

HDRRimException