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 Residence Details screen shows capacity, occupancy, and configuration data for a single residence at /rh/residences/:id.

​
Overview

The Residence Details screen fetches a single residence record from rh_residences together with its associated rh_beds rows. Three summary cards show total beds, occupied/total occupancy ratio with percentage, and available beds count. Two tabs are present: Beds (a table of individual bed records for the residence) and Details (a card showing NARR Level, Gender Model, License Number, and License Expiry). An “Edit Residence” button opens an inline edit dialog.

​
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/:id.

​
Before you start

  • Your account must have the rh.dashboard.view permission.
  • The residence must exist; navigating to an invalid :id renders a “Residence not found” message.

​
Steps

1

Open a residence

From the Residences list at /rh/residences, click the view icon on any row, or navigate directly to /rh/residences/:id.
2

Review occupancy summary

The three cards at the top show Total Beds, current Occupancy (occupied / total and percentage), and Available Beds.
3

Review the Beds tab

The Beds tab lists all rh_beds records associated with this residence. Each bed row reflects its current status (e.g., available, occupied).
4

Review the Details tab

Switch to the Details tab to see NARR Level, Gender Model, License Number, and License Expiry for the residence.
5

Edit the residence

Click “Edit Residence” to open the edit dialog and update residence information.

​
Key concepts

Total beds, available beds, and occupied beds are computed from the rh_beds rows joined to this residence. A bed with status = 'available' is counted as available; status = 'occupied' is counted as occupied.
The narr_level field stores the National Alliance for Recovery Residences certification level assigned to this residence. Confirm specific level definitions and certification requirements with your compliance SME.
license_number and license_expiry are stored on the residence record. The platform displays these fields but does not currently surface an automated expiry alert on this screen.

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/ResidenceDetailPage.tsx
  • src/cores/rh/hooks/useResidenceDetail.ts
  • src/cores/rh/components/BedsTable.tsx
  • src/platform/permissions/constants.ts