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.

This page corresponds to the intended route /rh/compliance/requirements/new for creating a new compliance requirement.

Overview

The compliance requirement creation wizard lives at /rh/compliance/requirements/wizard. 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.

Who it’s for

The /rh/compliance/requirements/wizard route requires RH_PERMISSIONS.COMPLIANCE_CREATE (rh.compliance.create) in addition to the outer RH_PERMISSIONS.DASHBOARD_VIEW (rh.dashboard.view) guard.

Before you start

  • Your account must hold both rh.dashboard.view and rh.compliance.create permissions.
  • An organization context must be active.
  • Navigate from the Compliance dashboard or Requirements list; 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.

Steps

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

TermCode identifierNotes
Requirement DefinitionRequirementDefinitionStepTitle, description, category, type, regulatory reference
Schedule & ScopeScheduleScopeStepFrequency, lead time, scope, optional due day
Review & ActivateComplianceReviewActivateStepRead-only summary before final submission
frequencyschedule.frequencyRecurrence cadence stored on the requirement record
scopecustom_fields.scopeall_residences or specific_residences; stored in custom_fields
lead_time_dayscustom_fields.lead_time_daysReminder advance notice in days

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/ComplianceSetupWizardPage.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