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 Residences screen lets staff view and manage all Recovery Housing locations for their organization at /rh/residences.

​
Overview

The Residences screen fetches all rh_residences records scoped to the current organization, joined with rh_beds for capacity data. Results are displayed in a table with columns for Name, NARR Level, License Number, Capacity (total beds), Occupancy, and Status. A search field filters results by name or address. The “Add Residence” button opens an inline dialog to create a new residence. Each row has Edit and View actions; the view action navigates to the residence detail at /rh/residences/:id.

​
Who it’s for

Protected by RH_PERMISSIONS.DASHBOARD_VIEW (rh.dashboard.view) via the shared RHViewGuard on all RH routes. No additional per-route permission gate exists for /rh/residences.

​
Before you start

  • Your account must have the rh.dashboard.view permission.

​
Steps

1

Navigate to Residences

Open Recovery Housing and select Residences from the navigation, or go directly to /rh/residences.
2

Search for a residence

Use the search field to filter residences by name or address.
3

View residence details

Click the view (eye) icon on any row to open the residence detail page at /rh/residences/:id.
4

Edit a residence

Click the edit (pencil) icon on any row to open the edit dialog and update the residence record.
5

Add a new residence

Click “Add Residence” to open the creation dialog and fill in the required fields.

​
Key concepts

The narr_level field reflects the National Alliance for Recovery Residences certification level. Confirm specific level assignments and their compliance meaning with your compliance SME.
The Capacity column shows total bed count derived from joined rh_beds rows. Occupancy data on this list page reflects the count of beds associated with the residence, not live occupancy.
The Edit action opens an inline dialog on the list page. The View action navigates to the full residence detail page, which includes bed-level status and license details.

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/ResidencesPage.tsx
  • src/cores/rh/hooks/useResidences.ts
  • src/cores/rh/components/ResidencesTable.tsx
  • src/platform/permissions/constants.ts