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 Reports screen is at /rh/reports and renders the ReportsPage component. It loads all report definitions for the current organization from useReportDefinitions and provides search, type filtering, summary metrics, and actions to define new reports or run ad-hoc reports.

​
Overview

Three summary cards display aggregated metrics: Total Reports (all report definitions), Scheduled (count of is_scheduled: true records), and Active (count of is_active: true records). All counts are scoped to the current organization via useOrganization. A Filters card allows search by report_name and type filtering by report_type. The available types are: census, program_completion, outcomes, discharge, compliance, grant, alumni, and custom. The ReportDefinitionsTable renders the filtered list. Clicking a row navigates to /rh/reports/:id. Two header buttons are present:
  • Run Report — links to /rh/reports/create.
  • New Report Definition — opens ReportDefinitionDialog inline.

​
Who it’s for

The outer RHViewGuard requires RH_PERMISSIONS.DASHBOARD_VIEW (rh.dashboard.view). The /rh/reports route carries no additional permission gate beyond the guard.

​
Before you start

  • Hold the rh.dashboard.view permission to access any RH route.

​
Steps

1

Navigate to Reports

Go to /rh/reports. The page loads and displays summary metric cards and the full list of report definitions.
2

Filter the list (optional)

Enter text in the search box to filter by report name. Use the Report Type dropdown to filter by type.
3

Open a report definition

Click a row in the ReportDefinitionsTable to navigate to /rh/reports/:id and view the full definition.
4

Create a new report definition (optional)

Click “New Report Definition”. The ReportDefinitionDialog opens inline. Fill in the required fields and submit.
5

Run an ad-hoc report (optional)

Click “Run Report” to navigate to /rh/reports/create.

​
Key concepts

TermMeaning
Report definitionA saved configuration for a report, stored as a record accessible via useReportDefinitions.
report_typeCategory of the report: census, program_completion, outcomes, discharge, compliance, grant, alumni, or custom.
is_scheduledIndicates the report is configured to run automatically.
is_activeIndicates the report definition is currently active.
recipient_emailsList of email addresses that receive scheduled report output.

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/ReportsPage.tsx
  • src/cores/rh/hooks/useReportDefinitions.ts