STANDARD DATA DICTIONARY #340.5 -- AR REPAYMENT PLAN FILE 6/27/25 PAGE 1
STORED IN ^RCRP(340.5, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 4.5)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains the data needed to create and administer Repayment Plans for Debtors.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
POINTED TO BY: REPAYMENT PLAN field (#.01) of the AR REPAYMENT PLANS sub-field (#340.09) of the AR DEBTOR File (#340)
AR REPAYMENT PLAN field (#45) of the ACCOUNTS RECEIVABLE File (#430)
CROSS
REFERENCED BY: REPAYMENT PLAN ID(B), TERM LIMIT EXCEEDED DATE(C), DEBTOR(E), PRINT DEFAULT?(PRTDEF), PRINT DELINQUENT?(PRTDEL)
INDEXED BY: STATUS & STATUS DATE (D), 36 MONTHS REVIEW (F)
LAST MODIFIED: NOV 18,2023@18:59:11
340.5,.01 REPAYMENT PLAN ID 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>17!($L(X)<17)!'(X?3N1"-"3A1"-"2N1"-"6N) X
MAXIMUM LENGTH: 17
LAST EDITED: DEC 04, 2020
HELP-PROMPT: Answer in the following format: -RPP--.
DESCRIPTION: This field contains the full ID of the Repayment Plan. The ID is in the following format:
-RPP--
Where:
Site #
------
The Institution File Station Number
RPP # for veteran
-----------------
The plan # for the veteran (i.e. if the Veteran is on their 5th plan, the plan # would be 05).
IEN
---
Internal Entry Number for the plan in this file
Example:
442-RPP-01-000322
CROSS-REFERENCE: 340.5^B
1)= S ^RCRP(340.5,"B",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,"B",$E(X,1,30),DA)
340.5,.02 DEBTOR 0;2 POINTER TO AR DEBTOR FILE (#340) (Required)
LAST EDITED: DEC 03, 2020
HELP-PROMPT: Enter the Debtor responsible for the plan.
DESCRIPTION: This field contains the Debtor who is responsible for repaying the debt contained in the Repayment
Plan.
CROSS-REFERENCE: 340.5^E
1)= S ^RCRP(340.5,"E",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,"E",$E(X,1,30),DA)
This index allows for a lookup of a repayment plan by the Debtor associated with a given plan.
340.5,.03 CREATION DATE 0;3 DATE (Required)
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: NOV 13, 2020
HELP-PROMPT: Enter the Date the Repayment Plan was created.
DESCRIPTION:
This field contains the Date the Repayment Plan was created.
340.5,.04 START DATE 0;4 DATE (Required)
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the date the plan starts.
DESCRIPTION: This field contains the date the first payment is due on the repayment plan. It will be different
than the Creation Date. The default date of the month for a Repayment Plan Start Date will be the
28th of the month.
340.5,.05 NO. OF PAYMENTS 0;5 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter a number between 0 and 999.
DESCRIPTION: This field contains the number of payments needed to pay off the Repayment Plan. The maximum
number of payments allowed is 999.
340.5,.06 AMOUNT PER MONTH 0;6 NUMBER (Required)
INPUT TRANSFORM: S:X["$" X=$P(X,"$",2) K:X'?.N.1".".2N!(X>999)!(X<0) X
LAST EDITED: NOV 13, 2020
HELP-PROMPT: Type a dollar amount between 0 and 999, 2 decimal digits.
DESCRIPTION: This field contains the monthly payment amount needed to pay off the Repayment Plan in the number
of payments listed in NO. OF PAYMENTS field.
340.5,.07 STATUS 0;7 SET (Required)
'1' FOR NEW;
'2' FOR CURRENT;
'3' FOR LATE;
'4' FOR DELINQUENT;
'5' FOR DEFAULTED;
'6' FOR TERMINATED;
'7' FOR CLOSED;
'8' FOR PAID IN FULL;
LAST EDITED: DEC 02, 2020
HELP-PROMPT: Enter the Plan's Status
DESCRIPTION: This field contains the status of the Repayment Plan. There are 8 statuses currently defined for
the plan. The statuses and their definitions are:
New
---
The time period starting at the creation of the plan until the first payment is due.
Current
-------
Payments on the plan are equal to or greater than the expected amount of payment.
Late
----
If the amount paid on the plan is less than the amount expected to be paid, but within the 30 days
of the due date.
Delinquent
----------
The amount paid on the plan is less than the amount expected to be paid and the payment is 31-90
days past due.
Defaulted
---------
A payment is greater than 90 days past due.
Terminated
----------
If a plan is greater than 91 days past due and in Defaulted status, the plan will be terminated.
Closed
------
The plan closed either by request of the Veteran or the VA and Veteran agree to close this plan and
create a new plan.
Paid in Full
------------
All bills paid under the repayment plan.
RECORD INDEXES: D (#838)
340.5,.08 STATUS DATE 0;8 DATE (Required)
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 02, 2020
HELP-PROMPT: Enter the date the status took effect.
DESCRIPTION:
This field contains the date the current status took effect.
RECORD INDEXES: D (#838)
340.5,.09 NO. OF FORBEARANCES 0;9 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: NOV 13, 2020
HELP-PROMPT: Type a number between 0 and 99, 0 decimal digits.
DESCRIPTION:
This field contains the total number of forbearances granted to the debtor for this Repayment Plan.
340.5,.11 PLAN AMOUNT OWED 0;11 NUMBER
INPUT TRANSFORM: S:X["$" X=$P(X,"$",2) K:X'?.N.1".".2N!(X>99999)!(X<0) X
LAST EDITED: NOV 23, 2020
HELP-PROMPT: Type a dollar amount between 0 and 99999, 2 decimal digits.
DESCRIPTION: This field contains the total amount owed by the debtor. This total is calculated by all debt owed
on the bills included in the plan at the time they are added to the plan.
340.5,.12 AUTO ADD 0;12 SET (BOOLEAN Data Type)
LAST EDITED: JAN 27, 2021
HELP-PROMPT: Enter Y to allow New Bills to be automatically added to this Debtor's Repayment Plan. No or
to prevent.
DESCRIPTION: This field indicates whether or not the Repayment Plan nightly process can add new bills for the
Debtor who is linked to this plan. Y indicates that the Debtor has given permission to allow new
bills to be added to the Repayment Plan. N or NULL indicates that the Debtor did not give
permission.
340.5,.13 ORIGINAL BALANCE 0;13 NUMBER
INPUT TRANSFORM: S:X["$" X=$P(X,"$",2) K:X'?.N.1".".2N!(X>999999999)!(X<0) X
LAST EDITED: FEB 04, 2021
HELP-PROMPT: Type a dollar amount between 0 and 999999999, 2 decimal digits.
DESCRIPTION: This field contains the original balance of the Repayment Plan when it was created using the Enter
a New Repayment Plan option.
340.5,.14 ORIGINAL NO. PAYMENTS 0;14 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>100)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: FEB 04, 2021
HELP-PROMPT: Enter the number of payments for the plan, between 0 and 100.
DESCRIPTION:
This field contains the Repayment Plan's originally planned number of payments.
340.5,1.01 REVIEW? 1;1 SET (BOOLEAN Data Type)
LAST EDITED: DEC 01, 2020
HELP-PROMPT: Type (Y)es to have this plan reviewed, (N)o or NULL to not have it reviewed.
DESCRIPTION: This field indicates whether a Repayment Plan needs a review. Plans with this flag set will appear
on the REPAYMENT PLAN TERMS EXCEPTION REPORT. This field will be set when a plan's # of payments
exceeds 57 months. It will be cleared when the plan is edited and the # payments remaining drops
below 57 months.
340.5,1.02 PRINT DEFAULT? 1;2 SET (BOOLEAN Data Type)
LAST EDITED: DEC 03, 2020
HELP-PROMPT: Type (Y)es to have a default letter print, (N)o or NULL to prevent it from printing.
DESCRIPTION: This field indicates whether a Repayment Plan needs to have the Repayment Plan Default printed.
Plans with this field set to yes will appear on the PRINT DEFAULT LETTER Report.
CROSS-REFERENCE: 340.5^PRTDEF
1)= S ^RCRP(340.5,"PRTDEF",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,"PRTDEF",$E(X,1,30),DA)
This index will allow the PRINT DEFAULT LETTER OPTION to quickly locate the plans which need a
Repayment Plan Default Letter printed.
340.5,1.03 PRINT DELINQUENT? 1;3 SET (BOOLEAN Data Type)
LAST EDITED: DEC 03, 2020
HELP-PROMPT: Type (Y)es to have a Delinquency Letter Printed, (N)o or NULL otherwise.
DESCRIPTION: This field indicates whether or not a Repayment Plan Delinquency Letter needs to be printed for
this plan. Plans with this field set to Yes will appear on the PRINT DELINQUENCY LETTER Report.
CROSS-REFERENCE: 340.5^PRTDEL
1)= S ^RCRP(340.5,"PRTDEL",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,"PRTDEL",$E(X,1,30),DA)
This index will allow the PRINT DELINQUENT LETTER option to quickly identify which Repayment Plans
need a Delinquency Letter printed.
340.5,1.04 AT CS? 1;4 SET (BOOLEAN Data Type)
LAST EDITED: NOV 13, 2020
HELP-PROMPT: Type (Y) to indicate if bills are at CS for the Debtor, (N)o or NULL otherwise.
DESCRIPTION: This field indicates whether or not the Debtor associated with this plan has any bills currently at
Treasury for Cross Servicing Debt Referral.
340.5,1.05 TERM LIMIT EXCEEDED DATE 1;5 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 03, 2020
HELP-PROMPT: Enter the date the number of payments exceeded 57.
DESCRIPTION: This field contains the date the number of payments exceeded 57 (term length). This field is
cleared when the plan is edited and the number of payments goes below 57.
CROSS-REFERENCE: 340.5^C
1)= S ^RCRP(340.5,"C",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,"C",$E(X,1,30),DA)
This xref is used to find entries with term limit exceeded date populated.
340.5,1.06 36 MONTHS REVIEW 1;6 SET
'0' FOR NEEDS APPROVAL;
'1' FOR APPROVED;
'2' FOR DENIED;
LAST EDITED: JUL 14, 2021
HELP-PROMPT: Please select the 36 months review status.
DESCRIPTION: This field contains the status of 36 months review for plans that have term length greater than 36
months.
FIELD INDEX: F (#1026) REGULAR IR LOOKUP & SORTING
Short Descr: This is the index on field 1.06
Description: This is the index on 36 MONTHS REVIEW field (1.06).
Set Logic: S ^RCRP(340.5,"F",X,DA)=""
Kill Logic: K ^RCRP(340.5,"F",X,DA)
Whole Kill: K ^RCRP(340.5,"F")
X(1): 36 MONTHS REVIEW (340.5,1.06) (Subscr 1) (forwards)
340.5,2 SCHEDULE 2;0 DATE Multiple #340.52 (Add New Entry without Asking)
DESCRIPTION:
This sub-file contains the payment schedule for the repayment plan.
340.52,.01 PLAN DUE DATE 0;1 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:X<1 X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the date the payment is due
DESCRIPTION:
This field contains the scheduled day a payment needs to be made on the repayment plan.
CROSS-REFERENCE: 340.52^B
1)= S ^RCRP(340.5,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,DA(1),2,"B",$E(X,1,30),DA)
340.52,1 PAYMENT MADE 0;2 SET (BOOLEAN Data Type) (Required)
LAST EDITED: NOV 13, 2020
HELP-PROMPT: Enter (Y) if payment was received, (N) if not.
DESCRIPTION:
This field indicates whether or not the expected payment was made.
340.52,2 PAYMENT FORBORNE 0;3 SET (BOOLEAN Data Type)
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter Y if this payment was skipped, N otherwise.
DESCRIPTION:
This field indicates if the payment was skipped (forborne) with the approval of the VA.
340.5,3 PAYMENT 3;0 DATE Multiple #340.53 (Add New Entry without Asking)
DESCRIPTION:
This sub-file stores information on all of the payments made against the repayment plan.
340.53,.01 DATE OF PAYMENT 0;1 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:X<1 X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the Date the payment was made.
DESCRIPTION:
This field stores the date a payment was applied to the repayment plan.
CROSS-REFERENCE: 340.53^B
1)= S ^RCRP(340.5,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,DA(1),3,"B",$E(X,1,30),DA)
340.53,1 AMOUNT 0;2 NUMBER
INPUT TRANSFORM: S:X["$" X=$P(X,"$",2) K:X'?.N.1".".2N!(X>99999)!(X<0) X
LAST EDITED: NOV 13, 2020
HELP-PROMPT: Type a dollar amount between 0 and 99999, 2 decimal digits.
DESCRIPTION:
This field stores the dollar amount of the payment made against a bill within this plan.
340.53,2 TRANSACTION 0;3 POINTER TO AR TRANSACTION FILE (#433)
LAST EDITED: DEC 01, 2020
HELP-PROMPT: Enter the Transaction Number for the payment.
DESCRIPTION: This file contains the Transaction Number from the Transaction File (#433) where the payment
information is stored.
340.5,4 AUDIT 4;0 DATE Multiple #340.54 (Add New Entry without Asking)
DESCRIPTION:
This sub-file contains a log of the edits that have occurred to the plan.
340.54,.01 DATE OF CHANGE 0;1 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the Date a change was made to the plan.
DESCRIPTION:
This field stores the date an edit occurred to the Repayment Plan.
CROSS-REFERENCE: 340.54^B
1)= S ^RCRP(340.5,DA(1),4,"B",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,DA(1),4,"B",$E(X,1,30),DA)
340.54,1 TYPE OF CHANGE 0;2 SET
'N' FOR NEW;
'E' FOR EDIT;
'C' FOR CLOSE;
'A' FOR ADD BILL;
'S' FOR STATUS;
LAST EDITED: OCT 19, 2021
HELP-PROMPT: Enter N for New Plan, E for Editing Plan, C for Closing Plan, S for Status Update, or A for
adding a new bill.
DESCRIPTION: This field indicates the type of change that occurred to the plan. The following are the types
of changes that can occur:
N - New Plan (New plan created)
E - Edit Plan (An existing Plan has it's terms changed)
C - Close Plan (An existing Plan is closed)
A - Add Bill (Add new bills to an Existing Plan)
S - Status Update
340.54,2 WHO CHANGED 0;3 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: DEC 02, 2020
HELP-PROMPT: Enter the User making the change.
DESCRIPTION:
This field identifies the technician or supervisor who made the change.
340.54,3 *COMMENT 0;4 SET
'N' FOR NEW PLAN;
'T' FOR TERMS ADJUSTMENT;
'F' FOR FORBEARANCE GRANTED;
'S' FOR SYSTEM TERMINATION;
'D' FOR DEFAULTED FOR NON-PAYMENT;
'A' FOR ADMINISTRATIVELY CLOSED;
'DL' FOR DELINQUENCY LETTER;
'DF' FOR DEFAULT LETTER;
'SA' FOR SUPV APPR <$25;
'SM' FOR SUPV APPR >36 MTHS;
'SD' FOR SUPV DENY >36 MTHS;
LAST EDITED: JUL 07, 2023
HELP-PROMPT: Enter the character which describes the reason the plan is edited
DESCRIPTION: *** This field is obsolete, field 340.54/4 should be used instead ***
This field provides a reason why the plan was changed. The reasons are listed below:
(N)ew Plan
----------
A New plan was created.
(T)erms Adjusted
----------------
The Monthly Payment Amount and/or Length of the Plan were manually changed.
(F)orbearance Granted
-------------------
A forbearance (skipping or rescheduling of a planned payment) was granted. See the Forbearance
section of the Repayment Plan file for details.
(S)ystem Termination
--------------------
VistA determined that the plan was in default and terminated the plan.
(D)efaulted for Non-Payment
---------------------------
A user closed the plan due to Non-Payment.
(A)dministratively Closed
-------------------------
A user closed the plan due to an administrative issue.
(DL) Deliquency Letter
----------------------
Plan Delinquency Letter was printed.
(DF) Default Letter
-------------------
Plan Default Letter was printed.
(SA) Supv Appr <$25
-------------------
A Supervisor has approved the monthly payment if it was < $25.
(SM) Supv Appr > 36 MTHS
------------------------
A Supervisor has approved the Plan's length to be greater than 36 months.
340.54,4 TEXT COMMENT 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
MAXIMUM LENGTH: 30
LAST EDITED: OCT 19, 2021
HELP-PROMPT: Enter a Free Text Reason for the entry between 3 and 30 characters in length.
DESCRIPTION:
This field contains a free text reason for the Audit Entry being filed.
340.54,5 COMMENT 0;6 POINTER TO AR RPP AUDIT LOG COMMENT FILE (#340.501)
LAST EDITED: MAR 16, 2022
HELP-PROMPT: Select the code that describes the reason the plan was edited.
DESCRIPTION:
This field provides a reason why the plan was changed.
340.5,5 FORBEARANCE 5;0 DATE Multiple #340.55 (Add New Entry without Asking)
DESCRIPTION:
This sub-file contains the forbearance information associated with this Repayment Plan.
340.55,.01 DATE GRANTED 0;1 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: NOV 30, 2020
HELP-PROMPT: Enter the date a forbearance was granted.
DESCRIPTION:
This field stores the date a forbearance was granted on a given Repayment Plan.
CROSS-REFERENCE: 340.55^B
1)= S ^RCRP(340.5,DA(1),5,"B",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,DA(1),5,"B",$E(X,1,30),DA)
340.55,1 MONTH/YEAR FORBORNE 0;2 DATE
INPUT TRANSFORM: S %DT="EM" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the Month and year of the payment forborne.
DESCRIPTION:
This field contains the Month and Year of the payment that was skipped (forborne).
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
340.55,2 MONTH/YEAR ADDED 0;3 DATE
INPUT TRANSFORM: S %DT="EM" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the Month and Year added to the end of the repayment plan.
DESCRIPTION: This field contains the month and year that was added to the end of the original repayment plan
to make up for the Month and Year that was forborne.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
340.55,3 GRANTED BY 0;4 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: NOV 30, 2020
HELP-PROMPT: Enter the User granting the forbearance.
DESCRIPTION:
This field stores the user who granted the forbearance on the plan.
340.55,4 REASON 0;5 SET (Required)
'H' FOR HARDSHIP;
'A' FOR ADMINISTRATIVE;
LAST EDITED: DEC 07, 2020
HELP-PROMPT: Enter the reason for forbearance
DESCRIPTION: This field contains the reason the forbearance was granted. The two reasons are:
(H)ARDSHIP
----------
The debtor is in financial stress for a short period of time (typically 1-2 months) and requested
temporary relief.
(A)DMINISTRATIVE
----------------
There was an administrative reason for granting the Forbearance.
340.5,6 AR BILL 6;0 POINTER Multiple #340.56 (Add New Entry without Asking)
DESCRIPTION:
This field contains a list of all bills associated with the Repayment Plan.
340.56,.01 AR BILL NUMBER 0;1 POINTER TO ACCOUNTS RECEIVABLE FILE (#430)
LAST EDITED: DEC 03, 2020
HELP-PROMPT: Enter the Bill to be added to the repayment plan.
DESCRIPTION: This field contains a link to a bill in the ACCOUNTS RECEIVABLE file (#430) that is included in
the repayment plan.
CROSS-REFERENCE: 340.56^B
1)= S ^RCRP(340.5,DA(1),6,"B",$E(X,1,30),DA)=""
2)= K ^RCRP(340.5,DA(1),6,"B",$E(X,1,30),DA)
FILES POINTED TO FIELDS
ACCOUNTS RECEIVABLE (#430) AR BILL:AR BILL NUMBER (#.01)
AR DEBTOR (#340) DEBTOR (#.02)
AR RPP AUDIT LOG COMMENT
(#340.501) AUDIT:COMMENT (#5)
AR TRANSACTION (#433) PAYMENT:TRANSACTION (#2)
NEW PERSON (#200) AUDIT:WHO CHANGED (#2)
FORBEARANCE:GRANTED BY (#3)
File #340.5
Record Indexes:
D (#838) RECORD REGULAR IR LOOKUP & SORTING
Short Descr: Index by status and status date
Description: Index by field .07 (STATUS) and field .08 (STATUS DATE).
Set Logic: S ^RCRP(340.5,"D",X(1),X(2),DA)=""
Kill Logic: K ^RCRP(340.5,"D",X(1),X(2),DA)
Whole Kill: K ^RCRP(340.5,"D")
X(1): STATUS (340.5,.07) (Subscr 1) (forwards)
X(2): STATUS DATE (340.5,.08) (Subscr 2) (forwards)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):