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 Recovery Housing Dashboard (RHOverview) is the primary landing page for the RH module, accessible at /rh/dashboard (the root /rh redirects here).

​
Overview

The dashboard loads live stats from useDashboardStats and renders a QuickActionsSection (editable, module rh, up to 6 module actions and 3 global), four summary StatCard tiles, and five widget sections. Widgets load lazily via Suspense with skeleton fallbacks. Stat cards (linked to sub-routes):
  • Total Residences — count of active residences (rh_residences)
  • Bed Capacity — occupied_beds / total_beds with occupancy rate percentage
  • Active Episodes — count of episodes with status = 'admitted'
  • Waitlist — count of episodes with status = 'waitlisted'
Widget sections (loaded lazily):
  • Census & Beds: CensusSummaryWidget, BedAvailabilityWidget, WaitlistWidget, RecentAdmissionsWidget, LicenseAlertsWidget
  • Daily Operations: AttendanceComplianceWidget, ChoreCompletionWidget, CurfewComplianceWidget
  • Discharge Planning: UpcomingDischargesWidget, DischargeReadinessWidget, FollowUpsDueWidget, ReferralSuccessWidget
  • Compliance & Staff Operations: ComplianceStatusWidget, ComplianceDeadlinesWidget, TrainingDueWidget, UpcomingAuditsWidget
  • Outcomes & Alumni: OutcomeSummaryWidget, SobrietyRateWidget, CompletionRateWidget, AlumniEngagementWidget, ReportsDueWidget

​
Who it’s for

This route is protected by RH_PERMISSIONS.DASHBOARD_VIEW (rh.dashboard.view) via RHViewGuard. No additional per-route permission gate.

​
Before you start

  • Your account must hold rh.dashboard.view.
  • An organization context must be active; all stat queries filter by organization_id.

​
Steps

1

Navigate to the dashboard

Go to /rh or /rh/dashboard. The stat cards load immediately from useDashboardStats; widget skeletons display while lazy components load.
2

Review summary stats

The four stat cards at the top show Total Residences, Bed Capacity (with occupancy rate), Active Episodes, and Waitlist count. Click a card to navigate to the corresponding sub-section.
3

Use Quick Actions

The QuickActionsSection below the header provides up to 6 module-specific quick actions and 3 global actions. Actions are editable by the current organization.
4

Review widget sections

Scroll through the five widget sections to see daily operations status, discharge planning readiness, compliance standing, and outcomes metrics. Each widget queries data scoped to the current organization.

​
Key concepts

TermSourceMeaning
Occupancy rateuseDashboardStats(occupied_beds / total_beds) * 100; 0 if no beds
Active episodesrh_episodes.status = 'admitted'Currently housed residents
Waitlistrh_episodes.status = 'waitlisted'Pending applicants
QuickActionsSectionPlatform componentConfigurable shortcut tiles per organization

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