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 Report Details screen is at /rh/reports/:id and renders the ReportDetailPage component. It displays a single report definition record from the data returned by useReportDefinitionDetail and exposes Edit, Export, and Run Now actions.

​
Overview

The page resolves the report by :id via useReportDefinitionDetail. The breadcrumb label is set dynamically from report_name. Three action buttons are shown in the header:
  • Edit — navigates to /rh/reports/:id/edit.
  • Export — stub (see SME note above).
  • Run Now — stub (see SME note above).
The main layout uses two sections:
  • Report Configuration card (2/3 width on md+) — displays report_type, active/inactive status badge, created_by_profile.full_name, notes, and report_config as formatted JSON.
  • Schedule and Recipients cards (1/3 width on md+) — Schedule shows schedule_frequency when is_scheduled is true; Recipients lists each email in recipient_emails.
A Report Preview card at the bottom displays a placeholder prompting the user to run the report.

​
Who it’s for

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

​
Before you start

  • Hold the rh.dashboard.view permission to access any RH route.
  • A report definition with the target ID must exist and belong to the current organization.

​
Steps

1

Navigate to Reports

Go to /rh/reports. The Reports Hub lists all report definitions for the current organization.
2

Open a report definition

Click a row in the ReportDefinitionsTable. The browser navigates to /rh/reports/:id.
3

Review report configuration

The Report Configuration card shows the report type, active status, creator, notes, and raw report_config JSON.
4

Review schedule and recipients

The Schedule card shows the frequency if is_scheduled is true. The Recipients card lists configured email addresses.
5

Edit the report definition (optional)

Click “Edit” to navigate to /rh/reports/:id/edit.
6

Export or run the report (pending)

The Export and Run Now buttons are present in the UI but their actions are not yet fully wired (see SME note above).

​
Key concepts

TermMeaning
report_nameDisplay name of the report definition.
report_typeCategory of the report (e.g., census, outcomes, compliance, grant).
is_activeWhether the report definition is active.
is_scheduledWhether the report runs on an automatic schedule.
schedule_frequencyFrequency of automatic runs when is_scheduled is true (SME: confirm allowed values).
recipient_emailsList of email addresses that receive scheduled report outputs.
report_configJSON configuration object for the report (SME: confirm structure).

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