org.hl7.rim
public interface Account extends RimObject, 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
| Method Summary | |
|---|---|
| IVL<MO> | getAllowedBalanceQuantity()
Gets attribute allowedBalanceQuantity of type IVL |
| MO | getBalanceAmt()
Gets attribute balanceAmt of type MO and cardinality 0..1.
|
| CE | getCurrencyCode()
Gets attribute currencyCode of type CE and cardinality 0..1.
|
| RTO | getInterestRateQuantity()
Gets attribute interestRateQuantity of type RTO and cardinality 0..1.
|
| void | setAllowedBalanceQuantity(IVL<MO> value)
Sets attribute allowedBalanceQuantity of type IVL |
| void | setBalanceAmt(MO value)
Sets attribute balanceAmt of type MO and cardinality 0..1.
|
| void | setCurrencyCode(CE value)
Sets attribute currencyCode of type CE and cardinality 0..1.
|
| void | setInterestRateQuantity(RTO value)
Sets attribute interestRateQuantity of type RTO and cardinality 0..1.
|
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
Returns: the attribute value
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.
Returns: the attribute value
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.
Returns: the attribute value
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 (e.g. 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.)
Returns: the attribute value
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
Parameters: value the new attribute value
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.
Parameters: value the new attribute value
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.
Parameters: value the new attribute value
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 (e.g. 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.)
Parameters: value the new attribute value