Consumer Direction Module   Reports Documentation    

advertisement
 National Program Office Consumer Direction Module Reports Documentation Anexinet, Inc.
1040 First Avenue
King of Prussia, PA 19406
Author: Dennis Horan
Date Created: October 20, 2008
Date Last Modified: November 11, 2008
Consumer Direction Module – Reports Documentation
Statement of Confidentiality
This document contains confidential and proprietary
information belonging exclusively to Anexinet Corp. The
distribution of this document shall be limited to authorized
National Program Office employees, and authorized state level
employees involved with implementation of the Consumer
Direction Module.
Said employees may not knowingly publicize, permit,
authorize or instigate disclosure of terms, strategies, or other
contents of this document to any person, firm, organization or
entity of any type outside the scope of this application.
No part of this document may be reproduced or copied without
prior written permission from an authorized Anexinet
employee.
Anexinet shall not be liable to anyone for special, incidental,
collateral or consequential damages that may arise out of the
use of this information.
Anexinet
1040 First Ave, Suite 108
King of Prussia, PA 19406
610.755.3400
Page 2 of 57
Consumer Direction Module – Reports Documentation
Table of Contents
1
Revision History ...................................................................................................................... 7
2
Overview ................................................................................................................................. 8
3
Amount of Monthly Budget Report.......................................................................................... 9
4
5
6
7
8
9
10
3.1
Report Description.......................................................................................................... 9
3.2
Parameter Input Screen ................................................................................................. 9
3.3
Sample Output ............................................................................................................. 10
Appeal Tracking Report ........................................................................................................ 11
4.1
Report Description........................................................................................................ 11
4.2
Parameter Input Screen ............................................................................................... 11
4.3
Sample Output ............................................................................................................. 12
Assessments by Due Date.................................................................................................... 13
5.1
Report Description........................................................................................................ 13
5.2
Parameter Input Screen ............................................................................................... 14
5.3
Sample Output ............................................................................................................. 14
Assessments Past Due By 30 or More Days........................................................................ 15
6.1
Report Description........................................................................................................ 15
6.2
Parameter Input Screen ............................................................................................... 16
6.3
Sample Output ............................................................................................................. 16
Batch Monthly Statement Report.......................................................................................... 17
7.1
Report Description........................................................................................................ 17
7.2
Parameter Input Screen ............................................................................................... 17
7.3
Sample Output ............................................................................................................. 17
Demographic Characteristics of Participants........................................................................ 18
8.1
Report Description........................................................................................................ 18
8.2
Parameter Input Screen ............................................................................................... 18
8.3
Sample Output ............................................................................................................. 19
Detail on Reasons for Disenrollment .................................................................................... 20
9.1
Report Description........................................................................................................ 20
9.2
Parameter Input Screen ............................................................................................... 20
9.3
Sample Output ............................................................................................................. 21
Enrollment by Referral Program ........................................................................................... 22
10.1
Report Description........................................................................................................ 22
10.2
Parameter Input Screen ............................................................................................... 22
10.3
Sample Output ............................................................................................................. 23
Page 3 of 57
Consumer Direction Module – Reports Documentation
11
12
13
14
15
16
17
18
19
Enrollment to First Services .................................................................................................. 24
11.1
Report Description........................................................................................................ 24
11.2
Parameter Input Screen ............................................................................................... 24
11.3
Sample Output ............................................................................................................. 25
Enrollment/Disenrollment - Cumulative through Current Month ........................................... 26
12.1
Report Description........................................................................................................ 26
12.2
Parameter Input Screen ............................................................................................... 26
12.3
Sample Output ............................................................................................................. 27
Enrollment/Disenrollment in Each of the Last 12 Months..................................................... 28
13.1
Report Description........................................................................................................ 28
13.2
Parameter Input Screen ............................................................................................... 28
13.3
Sample Output ............................................................................................................. 29
Grievance Tracking Report ................................................................................................... 30
14.1
Report Description........................................................................................................ 30
14.2
Parameter Input Screen ............................................................................................... 30
14.3
Sample Output ............................................................................................................. 30
In Home Monitoring - By Due Date Report ........................................................................... 31
15.1
Report Description........................................................................................................ 31
15.2
Parameter Input Screen ............................................................................................... 31
15.3
Sample Output ............................................................................................................. 32
In Home Monitoring - Past Due Report................................................................................. 33
16.1
Report Description........................................................................................................ 33
16.2
Parameter Input Screen ............................................................................................... 33
16.3
Sample Output ............................................................................................................. 34
Incident Tracking Report....................................................................................................... 35
17.1
Report Description........................................................................................................ 35
17.2
Parameter Input Screen ............................................................................................... 35
17.3
Sample Output ............................................................................................................. 35
Monthly Spending - Greater than % ..................................................................................... 36
18.1
Report Description........................................................................................................ 36
18.2
Parameter Input Screen ............................................................................................... 36
18.3
Sample Output ............................................................................................................. 37
Monthly Spending - Less than % .......................................................................................... 38
19.1
Report Description........................................................................................................ 38
19.2
Parameter Input Screen ............................................................................................... 38
19.3
Sample Output ............................................................................................................. 39
Page 4 of 57
Consumer Direction Module – Reports Documentation
20
21
22
23
24
25
26
27
28
Monthly Spending Report ..................................................................................................... 40
20.1
Report Description........................................................................................................ 40
20.2
Parameter Input Screen ............................................................................................... 40
20.3
Sample Output ............................................................................................................. 41
Monthly Statement Summary Report.................................................................................... 42
21.1
Report Description........................................................................................................ 42
21.2
Parameter Input Screen ............................................................................................... 42
21.3
Sample Output ............................................................................................................. 43
Participants by % of Budget in Savings Plan........................................................................ 44
22.1
Report Description........................................................................................................ 44
22.2
Parameter Input Screen ............................................................................................... 44
22.3
Sample Output ............................................................................................................. 45
Participants by % of Savings Goal Accumulated.................................................................. 46
23.1
Report Description........................................................................................................ 46
23.2
Parameter Input Screen ............................................................................................... 46
23.3
Sample Output ............................................................................................................. 47
Participants by Dollar Amount of Savings Plan Goal............................................................ 48
24.1
Report Description........................................................................................................ 48
24.2
Parameter Input Screen ............................................................................................... 48
24.3
Sample Output ............................................................................................................. 49
Participants by Dollar Amount Saved in Savings ................................................................. 50
25.1
Report Description........................................................................................................ 50
25.2
Parameter Input Screen ............................................................................................... 50
25.3
Sample Output ............................................................................................................. 51
Participants with More than 100% of Savings Goal Accumulated But No Purchase Made . 52
26.1
Report Description........................................................................................................ 52
26.2
Parameter Input Screen ............................................................................................... 52
26.3
Sample Output ............................................................................................................. 53
Percent of Enrollees Who Had Not Received Services........................................................ 54
27.1
Report Description........................................................................................................ 54
27.2
Parameter Input Screen ............................................................................................... 54
27.3
Sample Output ............................................................................................................. 55
Recipients of Services Under a Cash & Counseling Budget and Dropouts ......................... 56
28.1
Report Description........................................................................................................ 56
28.2
Parameter Input Screen ............................................................................................... 56
28.3
Sample Output ............................................................................................................. 57
Page 5 of 57
Consumer Direction Module – Reports Documentation
Page 6 of 57
Consumer Direction Module – Reports Documentation
1
Revision History
Date
Name
Description
Revision #
October 20, 2008
Dennis Horan
Draft
1.0
November 6, 2008
Dennis Horan
Description of parameters;
addition of descriptions
1.1
November 11, 2008
Dennis Horan
Completion of descriptions;
addition of special rules and
notes
1.2
Page 7 of 57
Consumer Direction Module – Reports Documentation
2
Overview
This document lists all the reports available in the Consumer Direction Module (CDM) application.
For each report within the program, this document will list:
•
The file name of the report
•
The Display Name of the Report, as displayed within the CDM
•
A longer description of the report, and the information it returns
•
A list of input parameters, with descriptions that each report requires.
•
The default list of user roles that can see a report. (Admin users of the CDM application
have the capability to modify which user roles see a report. This default list is the list of
roles that are initially assigned permission within the CDM Document.
•
A screen shot of the input parameter screen that a user sees when first running the
report.
•
A sample output of a report.
An additional note: Almost every report has a parameter called @userid. It is the id of the
currently logged in user. The application passes this id to the report, and the user does not enter
it.
Note that all the reports with a userid parameter filter the results to the list of participants
associated with that user. A couple examples:
A state user, or a state admin user will see all participants in the state.
A FMSA or FMSA Admin user will see all participants associated with my fiscal agency.
If I am a support broker user, I only see those participants who are directly assigned to
me.
If I am a support broker admin user, I see those participants that are assigned to my
support broker agency.
Page 8 of 57
Consumer Direction Module – Reports Documentation
3
Amount of Monthly Budget Report
3.1 Report Description
File Name:
BudgetAmount.rpt
Lists dollar amount ranges, and the number/percent of
participants whose budgets fall within each range. The bottom
summary section shows the statistical mean, median, and
percentiles.
Special Notes:
•
Report list notes for all participants associated with the
current user.
•
This report converts all budget periods to a monthly
budget. For example, if a budget is entered as $24,000
yearly, this report will list it as $1200 monthly.
Description:
Default Roles Who May Run
FMSA
Local Program Office
State Admin
State Office
Parameters
@AsOfDate – Date for which report is run. Records will be counted only
for participant budgets that are active on the date entered.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
3.2 Parameter Input Screen
Page 9 of 57
Consumer Direction Module – Reports Documentation
3.3 Sample Output
Page 10 of 57
Consumer Direction Module – Reports Documentation
4
Appeal Tracking Report
4.1 Report Description
File Name:
NoteTracking.rpt
Shows the File notes of Type “Appeal”, and their responses,
during the input time period.
Special Notes:
•
Report list notes for all participants associated with the
current user.
•
Report returns data only for participants whose status is
listed as ‘active’ as of the Begin date entered.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
State Office
@NoteType – note type. The NoteTracking report is used to show a
couple different types of reports. For this case, the application
automatically assigns the note type to ‘Appeal.’
Sys Admin
@BeginDate – Date to start showing participant Appeals notes.
@EndDate – Date to end showing participant Appeals notes.
4.2 Parameter Input Screen
Page 11 of 57
Consumer Direction Module – Reports Documentation
4.3 Sample Output
Page 12 of 57
Consumer Direction Module – Reports Documentation
5
Assessments by Due Date
5.1 Report Description
File Name:
Assessments_ByDueDate.rpt
Shows a statistical summary of Assessments, broken down into
Assessments not yet due, and those that are overdue. Report
shows categories by # of days until due, or # days overdue. The
bottom has a summary section showing mean, median, 25th and
75th percentile.
The time period for an assessment to be due is a configuration for
each state. In the admin section of the application, Application
Settings, there is a setting called “Assessment Frequency.”
Shows the File notes of Type “Appeal”, and their responses,
during the input time period.
Description:
Special Notes:
•
Report list notes for all participants associated with the
current user.
•
Report returns data only for participants whose status is
listed as ‘active’ as of the Begin date entered.
•
If a participant does not have any assessments (last
assessment date in the file is blank), this report does not
count that participant. This is because there is not a
method to count the actual due date of the assessment.
Default Roles Who May Run
FMSA
FMSA Agent
Guest
State Admin
State Office
Parameters
@Month – the month(1-12) that the assessment is due
@Year – the year that the assessment is due.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Sys Admin
Page 13 of 57
Consumer Direction Module – Reports Documentation
5.2 Parameter Input Screen
5.3 Sample Output
Page 14 of 57
Consumer Direction Module – Reports Documentation
6
Assessments Past Due By 30 or More Days
6.1 Report Description
File Name:
Assessments_PastDue.rpt
Lists the participants whose assessments are past due by at least
30 days, as of the input date. Report returns only participants
associated with the current user. The results are grouped by
participants’ support broker.
The time period for an assessment to be due is a configuration for
each state. In the admin section of the application, Application
Settings, there is a setting called “Assessment Frequency.”
Special Notes:
•
Report list notes for all participants associated with the
current user.
•
Report returns data only for participants whose status is
listed as ‘active’ as of the Begin date entered.
•
If a participant does not have any assessments (last
assessment date in the file is blank), this report will
return that participant, and show N/A in the days past due
column. This is because there is no way to calculate the
next due date, if there is no previous one.
Description:
Default Roles Who May Run
FMSA
FMSA Agent
Guest
State Admin
State Office
Support Broker Admin
Parameters
@Month – the Month (1-12) of the Participant Date to compare
@Year – the year of the Assessment due date to compare
@NumDays – number of days past due to check for. For this report, the
number is set by the application to 30
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Sys Admin
Page 15 of 57
Consumer Direction Module – Reports Documentation
6.2 Parameter Input Screen
6.3 Sample Output
Page 16 of 57
Consumer Direction Module – Reports Documentation
7
Batch Monthly Statement Report
7.1 Report Description
File Name:
BatchMonthlyStatement.rpt
A list of all payment activity for all participants associated with
the current user.
Special Notes
•
The report lists all payments for the current spending
plan of each participant.
•
A participant with no spending activity does not get listed
on the report.
Description:
Default Roles Who May Run
FMSA
Parameters
FMSA Agent
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
State Admin
State Office
7.2 Parameter Input Screen
There is no parameter input screen. The only parameter, @UserId, is passed automatically from
the application
7.3 Sample Output
Page 17 of 57
Consumer Direction Module – Reports Documentation
8
Demographic Characteristics of Participants
8.1 Report Description
File Name:
DemographicCharacteristics.rpt
Breaks down the Active list of participants in the system by age
group and gender.
Special Notes:
•
Report includes only participants who are active on the
Report Date entered.
•
Report includes only participants who are associated
with the current user.
•
In some states, date of birth and gender are not required
fields. Participants where gender or date of birth is not
entered will not be counted on this report.
Description:
Default Roles Who May Run
Parameters
Local Program Office
@AsOfDate – The date to check for active participants
State Admin
State Office
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Support Broker Admin
8.2 Parameter Input Screen
Page 18 of 57
Consumer Direction Module – Reports Documentation
8.3 Sample Output
Page 19 of 57
Consumer Direction Module – Reports Documentation
9
Detail on Reasons for Disenrollment
9.1 Report Description
File Name:
Disenrollment_DetailReasons.rpt
Description:
Returns a list of disenrollment reasons in the system, and a count
of participants who have disenrolled for that reason. The report
shows each reason, and the total disenrolled for the current
month; in addition, it shows the total cumulative who have
disenrolled for that reason.
Special Notes:
•
Lists only those participants associated with the current
user.
Default Roles Who May Run
Local Program Office
State Admin
State Office
Support Broker
Support Broker Admin
Parameters
@Month – the month (1-12) for which we are requesting disenrollment
data.
@Year – the 4 digit year for which we are requesting disenrollment data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
9.2 Parameter Input Screen
Page 20 of 57
Consumer Direction Module – Reports Documentation
9.3 Sample Output
Page 21 of 57
Consumer Direction Module – Reports Documentation
10 Enrollment by Referral Program
10.1 Report Description
File Name:
Enrollment_ByReferralProgram.rpt
A breakdown of the number of enrollees in the Cash and
Counseling Program, by Referral Program. For each referral
program, the numbers are shown for Children, elderly adults, and
non-elderly adults.
Special Notes:
•
This report will only count participants who have an
assigned date of birth, and an assigned referral program.
•
It also only counts participants who are active as of the
date entered.
•
This report only counts participants who are associated
with the current user.
Description:
Default Roles Who May Run
Parameters
FMSA
Local Program Office
State Admin
@Quarter – the number of the quarter that enrollment is looking at. The
report will use the date that is the last day of the quarter.
@Year – the year of the date for which we are requesting enrollment
numbers.
State Office
Support Broker
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Support Broker Admin
10.2 Parameter Input Screen
Page 22 of 57
Consumer Direction Module – Reports Documentation
10.3 Sample Output
Page 23 of 57
Consumer Direction Module – Reports Documentation
11 Enrollment to First Services
11.1 Report Description
File Name:
Enrollment_ToFirstServices.rpt
Shows a list of active participants have not received services. A
participant has received services if he has at least one spending
plan in the system.
Special Notes:
•
The report returns data on participants who are active on
the last day of the month/year entered.
•
The report lists only participants associated with the
current user.
•
Report groups data by referral program and age group.
As a result, report only counts data where birth date and
referral program are both entered.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
@Month – the month (1-12) for which we are requesting enrollment to
first services data.
@Year – the 4 digit year for which we are requesting enrollment to first
services data.
State Office
Support Broker Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
11.2 Parameter Input Screen
Page 24 of 57
Consumer Direction Module – Reports Documentation
11.3 Sample Output
Page 25 of 57
Consumer Direction Module – Reports Documentation
12 Enrollment/Disenrollment - Cumulative through
Current Month
12.1 Report Description
File Name:
Enrollment_Disenrollment_Cumulative.rpt
Enrollment/Disenrollment – Shows a cumulative list of Cash and
counseling enrollees; breaks down into list of:
•
Total Count of Active Enrollees
•
Total Count of Disenrolled participants who have
received services
•
Total count of disenrolled participants who have not
received services
•
Total count of participants who have statuses other than
active or disenrolled
Description:
Special Notes:
•
Results are grouped by referral program and age group.
Records are not counted for participants who do not
have a date of birth entered, or a referral program
selected.
•
Results are counted only for participants associated with
the current logged in user.
Parameters
Default Roles Who May Run
@Month – the month (1-12) for which we are requesting enrollment to
first services data.
Local Program Office
State Admin
State Office
@Year – the 4 digit year for which we are requesting enrollment to first
services data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
12.2 Parameter Input Screen
Page 26 of 57
Consumer Direction Module – Reports Documentation
12.3 Sample Output
Page 27 of 57
Consumer Direction Module – Reports Documentation
13 Enrollment/Disenrollment in Each of the Last 12
Months
13.1 Report Description
File Name:
Enrollment_Disenrollment_Monthly.rpt
A count, month by month, of all the enrollments and
disenrollments of each month in the past 12 months. The report
is broken out by referral program and by age group.
Special Notes:
•
Note that this report would only count participants who
are assigned both a referral program and a date of birth.
•
This report counts only participants associated with the
current logged in user.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
@Month – the last month (1-12) of the 12 months for which we are
requesting enrollment and disenrollment data data.
@Year – the 4 digit year of the date of the last month for which we are
requesting enrollment and disenrollment data data.
State Office
Support Broker Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
13.2 Parameter Input Screen
Page 28 of 57
Consumer Direction Module – Reports Documentation
13.3 Sample Output
Page 29 of 57
Consumer Direction Module – Reports Documentation
14
Grievance Tracking Report
14.1 Report Description
File Name:
NoteTracking.rpt
A detail of the file notes of type ‘Grievance’ that have been
entered during the input time period.
Special Notes:
•
Report list notes for all participants associated with the
current user.
•
Report returns data only for participants whose status is
listed as ‘active’ as of the Begin date entered.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
State Office
@NoteType – note type. The NoteTracking report is used to show a
couple different types of reports. For this case, the application
automatically assigns the note type to ‘Grievance.’
Sys Admin
@BeginDate – Date to start showing participant Grievance notes.
@EndDate – Date to end showing participant Grievance notes.
14.2 Parameter Input Screen
14.3 Sample Output
Page 30 of 57
Consumer Direction Module – Reports Documentation
15
In Home Monitoring - By Due Date Report
15.1 Report Description
File Name:
InHomeMonitoring_ByDueDate.rpt
A breakdown of the count of participants who are past due on
in-home monitoring, not yet due for in-home monitoring, and
those that do not yet have a spending plan. The past due
category and not yet due category have further sub-categories of
days ranges.
The due date is calculated by looking at the last in-home
monitoring date, and looking at the application setting in the
admin section of the application called “In-Person monitoring
frequency.”
Description:
Special Notes:
•
This report does not request a date range, but takes the
end of the current month as the point.
•
The report also only counts participants who are
associated with the current logged in user.
•
The report does not include participants who have not
had any in home monitoring. This is because the last
date is needed to calculate the next date.
Default Roles Who May Run
Local Program Office
Parameters
State Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
State Office
Support Broker Admin
15.2 Parameter Input Screen
There is no Parameter Input screen. The only parameter @UserId, is automatically passed into
the report, and the report is displayed without prompting the user for any parameters.
Page 31 of 57
Consumer Direction Module – Reports Documentation
15.3 Sample Output
Page 32 of 57
Consumer Direction Module – Reports Documentation
16
In Home Monitoring - Past Due Report
16.1 Report Description
File Name:
InHomeMonitoring_BySupportBroker.rpt
Lists the participants whose in-home monitoring is at least 30
days past due. Results are grouped by support broker.
Special Notes:
•
The report only counts participants who are associated
with the current logged in user.
•
The report only shows participants who are active on the
day that the report is run.
•
The report does not include participants who have not
had any in home monitoring. This is because the last
date is needed to calculate the next date.
Description:
Default Roles Who May Run
Local Program Office
State Admin
State Office
Support Broker Admin
Parameters
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
@DaysPastDue – number of days past due to check. The application
assigns a value of 30 to this parameter automatically.
16.2 Parameter Input Screen
There is no parameter input screen. Each of the two parameters for this report are automatically
assigned by the application.
Page 33 of 57
Consumer Direction Module – Reports Documentation
16.3 Sample Output
Page 34 of 57
Consumer Direction Module – Reports Documentation
17
Incident Tracking Report
17.1 Report Description
File Name:
NoteTracking.rpt
A detail of the file notes of type ‘Incident’ that have been entered
during the input time period.
Special Notes:
•
Report list notes for all participants associated with the
current user.
•
Report returns data only for participants whose status is
listed as ‘active’ as of the Begin date entered.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
State Office
@NoteType – note type. The Note Tracking report is used to show a
couple different types of reports. For this case, the application
automatically assigns the note type to ‘Incident.’
Sys Admin
@BeginDate – Date to start showing participant Incidents notes.
@EndDate – Date to end showing participant Incidents notes.
17.2 Parameter Input Screen
17.3 Sample Output
Page 35 of 57
Consumer Direction Module – Reports Documentation
18
Monthly Spending - Greater than %
18.1 Report Description
File Name:
MonthlySpending_ByPercentSpent.rpt
Returns a summary of the spending amounts/percentage of plan
that are greater than the input percent.
Special Notes:
•
Records are returned for participants associated with the
current logged in user
•
There are inputs for date range within which the results
are set.
Description:
Parameters
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Default Roles Who May Run
FMSA
Local Program Office
State Admin
State Office
@percentage – the percentage of spending above which records are to be
displayed. A value of 100 means to show all items where the spending is
above plan. A value of 105 means to show all values where spending is at
least 5% greater than plan.
@isGreaterThan – Boolean field; automatically set to true for this report.
@beginMonth – the month corresponding to the beginning of the date
range being displayed.
@beginYear – the year corresponding to the beginning of the date range
being displayed.
@endMonth – the month corresponding to the end of the date range being
displayed.
@endYear - – the year corresponding to the end of the date range being
displayed.
18.2 Parameter Input Screen
Page 36 of 57
Consumer Direction Module – Reports Documentation
18.3 Sample Output
Page 37 of 57
Consumer Direction Module – Reports Documentation
19
Monthly Spending - Less than %
19.1 Report Description
File Name:
MonthlySpending_ByPercentSpent.rpt
Returns a summary of the spending amounts/percentage of plan
that are less than the input percent.
Special Notes:
•
Records are returned for participants associated with the
current logged in user.
•
There are inputs for date range within which the results are
set.
Description:
Parameters
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Default Roles Who May Run
FMSA
Local Program Office
State Admin
State Office
@percentage – the percentage of spending below which records are to be
displayed. A value of 100 means to show all items where the spending is
equal to or below plan. A value of 90 means to show all values where
spending is at least 10% less than plan.
@isGreaterThan – Boolean field; automatically set to false for this report.
@beginMonth – the month corresponding to the beginning of the date
range being displayed.
@beginYear – the year corresponding to the beginning of the date range
being displayed.
@endMonth – the month corresponding to the end of the date range being
displayed.
@endYear - – the year corresponding to the end of the date range being
displayed.
19.2 Parameter Input Screen
Page 38 of 57
Consumer Direction Module – Reports Documentation
19.3 Sample Output
Page 39 of 57
Consumer Direction Module – Reports Documentation
20
Monthly Spending Report
20.1 Report Description
File Name:
MonthlySpending.rpt
The Monthly Spending Report shows a list of ranges. For each
range, the report shows the number of participants whose
spending falls within that range.
Description:
Special Notes
•
Data is returned only for participants associated with the
current logged in user.
Parameters
Default Roles Who May Run
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
FMSA
FMSA Agent
Local Program Office
@beginMonth – the month corresponding to the beginning of the date
range being displayed.
@beginYear – the year corresponding to the beginning of the date range
being displayed.
State Admin
State Office
@endMonth – the month corresponding to the end of the date range being
displayed.
@endYear - – the year corresponding to the end of the date range being
displayed.
20.2 Parameter Input Screen
Page 40 of 57
Consumer Direction Module – Reports Documentation
20.3 Sample Output
Page 41 of 57
Consumer Direction Module – Reports Documentation
21
Monthly Statement Summary Report
21.1 Report Description
File Name:
BatchMonthlyStatementSummary.rpt
The Monthly Statement Summary Report shows the spending, by
category, of all participants.
Special Notes:
•
Description:
•
•
Report returns spending activity for participants
associated with the current logged in user only.
Report returns all spending activity during the current
spending plan.
Report only includes participants who are active as of the
input date.
Parameters
Default Roles Who May Run
FMSA
State Admin
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
@AsOfDate – the date to retrieve current spending plan and payment
activity data.
21.2 Parameter Input Screen
Page 42 of 57
Consumer Direction Module – Reports Documentation
21.3 Sample Output
Page 43 of 57
Consumer Direction Module – Reports Documentation
22
Participants by % of Budget in Savings Plan
22.1 Report Description
File Name:
SavingsPlan_ByPercent.rpt
Shows a statistical summary of the spending plan amounts as a
percent of the total budget. The bottom section shows statistical
information on the data, including mean, median, 25th percentile,
and 75th percentile.
Special Notes:
Description:
•
•
The report takes all active budgets as of the last day of
the input month.
The report includes all participants associated with the
current logged in user.
Parameters
Default Roles Who May Run
Local Program Office
State Admin
State Office
@Month – Month whose budget amounts are being compared. Report will
take the active budget as of the last day of the month.
@Year – Year whose budget amounts are being compared.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
22.2 Parameter Input Screen
Page 44 of 57
Consumer Direction Module – Reports Documentation
22.3 Sample Output
Page 45 of 57
Consumer Direction Module – Reports Documentation
23
Participants by % of Savings Goal Accumulated
23.1 Report Description
File Name:
SavingsPlan_PercentAccumulated.rpt
Shows ranges of percent of accumulated savings goals, and the
number of participants whose percent of goal is within that range.
The bottom of the report shows some statistical averages, like
the mean, the median, the 25th percentile, and the 75th percentile.
Special Notes:
•
Amount of Savings is calculated this way: the excess
money in any spending plan is assumed to be part of
savings.
•
For states that wish to set the amount earmarked for
savings, then this report would not be valid.
•
If state users change the Savings Category to another
name, this report will not be valid.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
State Office
@Month – the month whose last day is the last day to count cumulative
savings data
@Year – the year of the last day to count cumulative savings data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
23.2 Parameter Input Screen
Page 46 of 57
Consumer Direction Module – Reports Documentation
23.3 Sample Output
Page 47 of 57
Consumer Direction Module – Reports Documentation
24
Participants by Dollar Amount of Savings Plan Goal
24.1 Report Description
File Name:
SavingsPlan.rpt
Shows ranges of dollar amounts of accumulated savings goals,
and the number of participants whose total dollar amount of
savings is within that range.
The bottom of the report shows
some statistical averages, like the mean, the median, the 25th
percentile, and the 75th percentile.
Special Notes:
Description:
•
•
Parameters
Default Roles Who May Run
FMSA
Local Program Office
State Admin
State Office
Amount of Savings is calculated this way: the excess
money in any spending plan is assumed to be part of
savings.
For states that wish to set the amount earmarked for
savings, then this report would not be valid.
@Month – the month whose last day is the last day to count cumulative
savings data
@Year – the year of the last day to count cumulative savings data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
24.2 Parameter Input Screen
Page 48 of 57
Consumer Direction Module – Reports Documentation
24.3 Sample Output
Page 49 of 57
Consumer Direction Module – Reports Documentation
25
Participants by Dollar Amount Saved in Savings
25.1 Report Description
File Name:
SavingsPlan_DollarAmount.rpt
A statistical summary of the participants in the state, and the
amount of money that each has currently in savings. The bottom
section has statistical average data, including mean, median, 25th
percentile, and 75th percentile.
Special Notes:
Description:
•
•
Amount of Savings is calculated this way: the excess
money in any spending plan is assumed to be part of
savings.
For states that wish to set the amount earmarked for
savings, then this report would not be valid.
Parameters
Default Roles Who May Run
Local Program Office
State Admin
State Office
@Month – the month whose last day is the last day to count cumulative
savings data
@Year – the year of the last day to count cumulative savings data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
25.2 Parameter Input Screen
Page 50 of 57
Consumer Direction Module – Reports Documentation
25.3 Sample Output
Page 51 of 57
Consumer Direction Module – Reports Documentation
26 Participants with More than 100% of Savings Goal
Accumulated But No Purchase Made
26.1 Report Description
File Name:
SavingsPlan_NoPurchaseMade.rpt
This report lists participants who have saved more than the price
of an item, but have not yet purchased the item.
Special Notes
•
Amount of Savings is calculated this way: the excess
money in any spending plan is assumed to be part of
savings.
•
For states that wish to set the amount earmarked for
savings, then this report would not be valid.
Description:
Parameters
Default Roles Who May Run
Local Program Office
State Admin
State Office
Support Broker
@Month – the month whose last day is the last day to count cumulative
savings data
@Year – the year of the last day to count cumulative savings data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
26.2 Parameter Input Screen
Page 52 of 57
Consumer Direction Module – Reports Documentation
26.3 Sample Output
Page 53 of 57
Consumer Direction Module – Reports Documentation
27 Percent of Enrollees Who Had Not Received
Services
27.1 Report Description
File Name:
Enrollment_NoServices.rpt
A statistical view of the count of enrollees, by referral program
and age group, who have not received services. A Participant has
received services if he has at least one spending plan in the
system.
A Statistical summary on the bottom shows mean, median, 25th
percentile, and 75th percentile.
Special Notes:
Description:
•
•
•
Because of the groupings, report will not count
participants with a blank birth date or referral program.
Report only counts participants who are active on the
date entered
Report only counts participants if they are associated
with the current logged in user.
Default Roles Who May Run
Parameters
FMSA
Local Program Office
State Admin
State Office
Support Broker
@Month – the month whose last day is the last day to count cumulative
savings data
@Year – the year of the last day to count cumulative savings data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Support Broker Admin
27.2 Parameter Input Screen
Page 54 of 57
Consumer Direction Module – Reports Documentation
27.3 Sample Output
Page 55 of 57
Consumer Direction Module – Reports Documentation
28 Recipients of Services Under a Cash & Counseling
Budget and Dropouts
28.1 Report Description
File Name:
RecipientsOfService_ByReferralProgram.rpt
Description:
Shows a count of participants, by referral program and age group,
who are one of the following:
•
Current enrolled participant.
•
current participants that have not received services
•
participants that have disenrolled without receiving
services.
•
Participants that have disenrolled after receiving
services
•
Participants that have other statuses (not enrolled or
disenrolled)
Special Notes:
•
A participant has received services if he has at least one
spending plan in the system
•
Due to the grouping, participants that do not have an
assigned date of birth or referral program are not
counted in the report.
•
Report counts only participants who are associated with
the current logged in user.
Default Roles Who May Run
Parameters
FMSA
Local Program Office
State Admin
State Office
Support Broker
@Quarter – the quarter that we are looking at enrollment/disenrollment
data.
@Year – the year that we are looking at enrollment/disenrollment data.
@UserId - The Id of the current logged in user. This is not entered by
users, but automatically assigned by the application. Records will only be
pulled for participants that the current user may view.
Support Broker Admin
28.2 Parameter Input Screen
Page 56 of 57
Consumer Direction Module – Reports Documentation
28.3 Sample Output
Page 57 of 57
Download