Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The New Report screen provides a form to create a new report definition for Recovery Housing, accessible at /rh/reports/new.

​
Overview

The New Report screen renders a single Card containing ReportDefinitionForm, a tabbed form with Basic Info and Schedule tabs. After clicking Create Report, the form calls createReport and navigates to /rh/reports. On error, the mutation is expected to handle error display. No wizard shell is used; this is a flat form.

​
Who it’s for

No explicit permission gate is defined on this route beyond the outer RH_PERMISSIONS.DASHBOARD_VIEW (rh.dashboard.view) guard applied to all RH routes. No additional permission is required.

​
Before you start

  • Your account must hold rh.dashboard.view permission.
  • An organization context must be active.
  • Identify the report type and whether you want the report to run on a schedule before opening the form.

​
Steps

1

Fill in Basic Info

On the Basic Info tab, enter the Report Name (required) and select a Report Type: Census, Program Completion, Outcomes, Discharge, Compliance, Grant, Alumni, or Custom. Optionally add Notes. The Active toggle (default: on) controls whether the report is available for use.
2

Configure Schedule (optional)

Switch to the Schedule tab. Toggle Enable Scheduling to reveal scheduling options. Select a Frequency: Daily, Weekly, Monthly, Quarterly, or Annual. For weekly schedules, select a Day of Week. For monthly, quarterly, or annual schedules, enter a Day of Month (1–31). Enter comma-separated Recipient email addresses to receive the scheduled report.
3

Submit

Click Create Report. On success the page navigates to /rh/reports. On error, the mutation handles the error response.

​
Key concepts

TermCode identifierNotes
Report Namereport_nameRequired; free-text identifier
Report Typereport_typeEnumerated category
Activeis_activeControls report availability
Schedulingis_scheduledEnables automatic report generation
Frequencyschedule_frequencyRecurrence cadence when scheduling is enabled
Recipientsrecipient_emailsComma-separated email list for scheduled delivery

Recovery Housing

Recovery Housing references and overview.

Governance & parity

Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/rh.tsx
  • src/cores/rh/pages/ReportCreatePage.tsx
  • src/cores/rh/components/forms/ReportDefinitionForm.tsx