> ## 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.

# Module Permissions

> View and search all permissions defined for a specific platform module, with role usage information and categorized permission listing.

Module Permissions is the page at `/settings/permissions/:module` that displays all defined permissions for a specific platform module (e.g., `hr`, `fa`, `rh`, `fw`, `lo`, `fm`, `cl`, `system`), organized by category, with role usage details.

## Overview

The page reads the `:module` param and looks up the corresponding permission set from `MODULE_CONFIG` (which maps module slugs to their name and permission constant map). Permissions are parsed by `parsePermission` to extract category, entity, and action. The page renders a filterable permission list with search and a tabbed view by category. Role usage data shows which roles include each permission. The user context is loaded via `useCurrentUser`.

Navigate here from `/settings/permissions` (Permissions Overview).

## Who it's for

Access follows your organization's role and module configuration. SME should confirm intended access.

## Supported modules

| Slug     | Module Name              |
| -------- | ------------------------ |
| `hr`     | Workforce & HR           |
| `fa`     | Finance & Revenue        |
| `rh`     | Recovery Housing         |
| `fw`     | Forms & Workflow         |
| `lo`     | Leadership OS            |
| `fm`     | Facilities & Maintenance |
| `cl`     | Clinical                 |
| `system` | System                   |

## Before you start

* Navigate from `/settings/permissions` and select the module of interest.
* This page is informational — confirm with an SME whether permission assignments are managed here or in the Roles pages.

## Steps

1. Navigate to `/settings/permissions/:module` (e.g., `/settings/permissions/hr`).
2. Use the search input to filter permissions by name or key.
3. Select a category tab to narrow the view.
4. Review each permission's key, label, entity, and action components.
5. Expand role usage details to see which roles include each permission.

## Key concepts

**Permission key** — the dot-notation string (e.g., `hr.employees.view`) used in `RequirePermission` gates throughout the platform.

**Category** — a grouping derived from the permission key structure (e.g., entity type or functional area).

## Related

<Columns cols={2}>
  <Card title="Platform Foundation" icon="layer-group" href="/pf/overview">
    Platform Foundation overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index" />
</Columns>

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

<Accordion title="Documentation sources">
  * src/routes/platform.tsx
  * src/platform/permissions/pages/ModulePermissionsPage.tsx
  * src/platform/permissions/constants.ts
</Accordion>