Skip to main content
The Requirements screen lets staff view, filter, and manage compliance requirements for Recovery Housing at /rh/compliance/requirements.

​
Overview

The Requirements screen displays a filterable, searchable table of compliance requirement records scoped to the current organization. Staff with the rh.compliance.create permission see an “Add Requirement” button that opens an inline dialog to create a new record. The list can be narrowed by category, frequency, and active status.

​
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 RequirePermission gate exists for /rh/compliance/requirements. The “Add Requirement” button is additionally gated by rh.compliance.create via an inline PermissionGate.

​
Before you start

  • Your account must have the rh.dashboard.view permission to access this screen.
  • Creating or editing requirements additionally requires rh.compliance.create.

​
Steps

1

Navigate to Requirements

Open Recovery Housing and go to Compliance, then select Requirements, or navigate directly to /rh/compliance/requirements.
2

Search and filter

Use the search field to filter by requirement name. Use the Category selector to narrow by: Staffing, Documentation, Safety, Outcomes, SLH Rights, Postings, or Other. Use the Frequency selector to filter by: Daily, Weekly, Monthly, Quarterly, Annual, or One Time. Use the Status selector to show Active, Inactive, or all requirements.
3

View a requirement

Click the view icon on any row to navigate to the requirement detail at /rh/compliance/requirements/:id.
4

Add a requirement (admin only)

If you have rh.compliance.create, click “Add Requirement” to open the creation dialog and fill in the required fields.

​
Key concepts

Each requirement belongs to one of seven categories: staffing, documentation, safety, outcomes, slh_rights, postings, or other. The compliance meaning of each category should be confirmed with your compliance SME.
Frequency values are: daily, weekly, monthly, quarterly, annual, and one_time. Frequency governs how often the requirement must be satisfied or documented.
Requirements have an is_active flag. Inactive requirements remain in the database but are hidden from the default “Active” filter view.

​
Viewing a requirement

The Requirement Details screen is at /rh/compliance/requirements/:id and renders the ComplianceRequirementDetailPage component. It displays a single compliance requirement record from useComplianceRequirementDetail and allows editing and checklist management. The page resolves the requirement by :id via useComplianceRequirementDetail. The breadcrumb label is set dynamically from requirement_name. The header shows the requirement name, category, frequency, active/inactive status badge, and an Edit button that opens ComplianceRequirementDialog. Two detail cards are displayed:
  • Requirement Details — category, frequency, regulatory source (if present), applies-to scope (if present), evidence required, and verification required flags.
  • Assignment — shows the linked residence name, or a note indicating organization-wide scope when residence is null.
A Description card appears when description is populated. A Compliance Checklists card renders ComplianceChecklistsTable filtered to the current requirement. The “Add Checklist Item” button opens ComplianceChecklistDialog. The outer RHViewGuard requires rh.dashboard.view; no additional gate exists on this route. A compliance requirement with the target ID must exist and belong to the current organization.
1

Navigate to Compliance Requirements

Go to /rh/compliance/requirements. The requirements list is displayed.
2

Open a requirement record

Click a row. The browser navigates to /rh/compliance/requirements/:id.
3

Review requirement details

Inspect the Requirement Details card for category, frequency, regulatory source, applies-to scope, and evidence/verification flags.
4

Review assignment

The Assignment card shows which residence this requirement applies to, or confirms organization-wide scope.
5

Review description (if present)

If description is populated, a Description card shows the full text.
6

Manage compliance checklists

The Compliance Checklists card shows all checklist items scoped to this requirement. Click “Add Checklist Item” to open ComplianceChecklistDialog and add a new item.
7

Edit the requirement (optional)

Click “Edit” to open ComplianceRequirementDialog pre-populated with the current values. Submit to save changes.
8

Return to requirements list

Click “Back to Requirements” to navigate to /rh/compliance/requirements.

​
Key concepts

​
Creating a requirement

The compliance requirement creation wizard lives at /rh/compliance/requirements/wizard (not /rh/compliance/requirements/new). It uses a three-step timeline layout (WizardShell with layout="timeline"). After clicking Activate requirement, the wizard calls createRequirement and navigates to the new requirement detail page. Exiting at any step navigates to /rh/compliance/requirements without saving. This route requires RH_PERMISSIONS.COMPLIANCE_CREATE (rh.compliance.create) in addition to the outer rh.dashboard.view guard. Before you start: hold both rh.dashboard.view and rh.compliance.create. The wizard cannot be bookmarked to bypass the permission gate. If the route /rh/compliance/requirements/new is used, it will render a 404 — use /rh/compliance/requirements/wizard instead.
1

Step 1 — Requirement Definition

Fill in the required fields: Title, Description, Category (e.g., Fire Safety, Medication Management, State Licensing), and Requirement Type (Inspection, Staff Training, Documentation Review, Internal Audit, or Other). Optionally provide a Regulatory Reference. All four required fields must be non-empty before proceeding; a validation toast appears if any are missing.
2

Step 2 — Schedule & Scope

Set the recurrence Frequency (Daily, Weekly, Monthly, Quarterly, Annually, or As needed; default: monthly), Lead Time Days (days before due date to send a reminder; default: 7, minimum: 0). For monthly/quarterly/annual frequencies, optionally set a Due Day of Month (1–28). Set Scope: All residences (applies organization-wide) or Specific residences (assigned post-activation from the detail page). All required fields are validated on Next.
3

Step 3 — Review & Activate

Review a summary of definition and schedule data on the ComplianceReviewActivateStep screen. Click Activate requirement to submit. On success a toast confirms activation and the page navigates to the new requirement’s detail page. On error a sanitized error message appears in a toast.

​
Key concepts

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/ComplianceRequirementsPage.tsx
  • src/cores/rh/pages/ComplianceRequirementDetailPage.tsx
  • src/cores/rh/pages/ComplianceSetupWizardPage.tsx
  • src/cores/rh/hooks/useComplianceRequirements.ts
  • src/cores/rh/components/ComplianceRequirementsTable.tsx
  • src/cores/rh/components/wizards/compliance-setup/ComplianceSetupWizard.tsx
  • src/cores/rh/components/wizards/compliance-setup/steps/RequirementDefinitionStep.tsx
  • src/cores/rh/components/wizards/compliance-setup/steps/ScheduleScopeStep.tsx
  • src/platform/permissions/constants.ts