Print Page as PDF
DBIA4553 ICR (4553)

DBIA4553    ICR (4553)

Name Value
NUMBER 4553
IA # 4553
DATE CREATED 2006/03/10
CUSTODIAL PACKAGE ACCOUNTS RECEIVABLE
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE RCKATP
NAME DBIA4553
GENERAL DESCRIPTION
Accounts Receivable will release the routine RCKATP
with patch PRCA*4.5*241.  The patch post initialization process will queue a
task that invokes this routine to make adjustments to the financial accounts
of veterans affected by Hurricane Katrina.  DBIA4552 has been developed to
allow this routine to invoke the Integrated Billing routine IBAKAT to identify
co-payment charges that should be cancelled.  IBAKAT, in turn, will invoke
several APIs in routine RCKATP to adjust the veteran's account in Accounts
Receivable.  This DBIA defines the APIs that IBAKAT may call back into to
credit the veteran's account.
STATUS Active
DURATION Till Otherwise Agreed
ID RCKATP
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$CHK(DFN)
This entry point allows Integrated Billing to
determine if it should attempt to cancel charges for a specific veteran.  This
extrinsic function will determine if a veteran has been flagged as a veteran
affected by Hurricane Katrina, and if the veteran had previously been flagged
in the AR DEBTOR (#340) file as having had co-payment charges cancelled.  This
function will return a flag to whether co-payment charges may be cancelled for
a specific veteran.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
This input variable contains a pointer to the veteran
in the PATIENT (#2) file.
RES Output
This return value from the $$CHK(DFN) function call
returns a zero if charges cannot be cancelled for the veteran, or a one if
charges can be cancelled for the veteran.  The function will return a one if
the veteran has been flagged as affected by Hurricane Katrina, but has not yet
been flagged in the AR DEBTOR (#340) file as having had co-payment charges
cancelled.
$$DEC(BILL,AMOUNT)
This entry point allows Integrated Billing to request
that Accounts Receivable reduce the balance of a specific bill by a specified
amount.  This extrinsic function will return to Integrated Billing the dollar
amount that was NOT reduced from the bill.
VARIABLES TYPE VARIABLES DESCRIPTION
BILL Input
This is the bill number of the receivable that should
be reduced.  The bill number is the name (.01 field value) of an entry in the
ACCOUNTS RECEIVABLE (#430) file.
AMOUNT Input
This is a positive dollar amount by which the balance
of the requested receivable should be reduced.
RES Output
This variable contains the portion of the requested
dollar amount that the receivable was NOT reduced.  For example, if the
receivable to be reduced had a large outstanding balance, and was reduced by
the input dollar amount, the value returned by this extrinsic function is
zero.  If the receivable was closed and had a zero balance (and thus could not
be further reduced), the value returned by this extrinsic function would be
equal to the input dollar amount.  If the balance of the receivable to be
reduced was positive, but less than the input dollar amount, then the value
returned by this extrinsic function would be the difference between the input
dollar amount and the previous positive balance of the receivable.
FLAG(DFN)
This entry point is invoked by Integrated Billing to
request that Accounts Receivable flag a specific veteran in the AR DEBTOR
(#340) file as having had co-payment charges cancelled.  This call does not
provide output to the calling application.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
This input variable contains a pointer to the veteran
in the PATIENT (#2) file.  Accounts Receivable will find this patient's
associated entry in the AR DEBTOR (#340) file, and set field .09 (COPAY
CHARGES CANCELLED?) for that entry equal to one.
ADJ(DFN,AMOUNT)
This entry point allows Integrated Billing to request
that Accounts Receivable reduce the total account balance of a specific
veteran by a specific amount.  Accounts Receivable will accomplish this task
by reducing any active bills of that veteran, or establishing a pre-payment
for the veteran if necessary.  This call does not provide output to the
calling application.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
This input variable contains a pointer to the veteran
in the PATIENT (#2) file.
AMOUNT Input
This is a positive dollar amount by which the
specified veteran's account should be reduced.
$$TPP(TRAN,ARR)
This entry point allows Integrated Billing to request
that Accounts Receivable calculate the total dollar amount of all decrease
adjustments that have been applied to a specific bill, after the application
of a specific increase adjustment.  In this context, the decrease adjustments
represent credits that have been applied to the veteran's account due to the
receipt of a payment from an insurance company for the same episode of care
for which the veteran was billed a co-payment.  This credit amount should not
be applied a second time to the veteran's account.
VARIABLES TYPE VARIABLES DESCRIPTION
TRAN Input
This variable is a pointer to a transaction in the AR
TRANSACTION (#433) file.  This transaction represents the increase adjustment
used to debit the veteran's account when the veteran was billed a co-payment,
and the pointer to this transaction is stored with the co-payment charge in
the INTEGRATED BILLING ACTION (#350) file.  The pointer to this transaction is
provided to specify that AR look for decrease adjustments that were filed
after this transaction.
ARR Both
This variable is an array that is passed to this
extrinsic function by reference.  The array may or may not be defined when it
is passed to AR.  The array actually has the form ARR(BILL,TRAN), where BILL
is the pointer to the receivable in the ACCOUNTS RECEIVABLE (#430) file, and
TRAN is the pointer to one of the receivable's transactions in the AR
TRANSACTION (#433) file.  When AR is invoked through this API to examine the
decrease adjustments for a specific receivable, all the transactions that are
included in the calculation are captured in the array and passed back to
Integrated Billing.  Integrated Billing may encounter a subsequent transaction
for the same receivable, in which case it would invoke this API with defined
array elements in ARR.  In this latter case, when AR is examining decrease
adjustments to include in its total, it would exclude those decrease
adjustments stored in ARR since they were previously included in the
calculation.
RES Output
This variable represents the output from the
extrinsic function.  This value will be null if the input variable TRAN is not
a positive value, or if this value could not be used to find a valid pointer
to a receivable in the ACCOUNTS RECEIVABLE (#430) file.  Otherwise, the value
of this variable is "AMT^BILL", where:

AMT = The total transaction amount of all decrease adjustments filed
for the receivable after the filing of the input transaction
TRAN, excluding those adjustments stored in the input
array ARR.

BILL = The pointer to the receivable in the ACCOUNTS RECEIVABLE (#430)
with which the input transaction TRAN is associated.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
INTEGRATED BILLING
The Integrated Billing routine IBAKAT is invoked during
the patch PRCA*4.5*241 post initialization process, as allowed by DBIA4552.
During this process only, Integrated Billing may make calls back to the
calling Accounts Receivable routine (RCKATP) in order to credit a veteran's
account.