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 Clearance Metrics screen (/pm/financial-clearance/metrics) is a KPI and trend dashboard for financial clearance operations, aggregated from cost estimate records.

​
Overview

The Clearance Metrics screen renders a filter bar, four KPI cards, trend charts, and a summary table. Data is computed client-side from pm_patient_cost_estimates records. The four KPI cards show:
  • Completion Rate — percentage of estimates with clearance_status = 'cleared'
  • Avg Days to Clearance — average elapsed days between estimate creation and clearance completion
  • Avg Patient Responsibility — average patient_estimated_responsibility across all estimates matching the filters
  • Override Rate — percentage of estimates with clearance_status = 'override'
The summary table below the charts shows totals for estimates, cleared, and pending counts alongside the completion rate. The screen wraps its content in a RequirePermission check for pm.clearance-metrics.view.

​
Who it’s for

Requires the pm.clearance-metrics.view permission, checked both at the route level and inline within the page component.

​
Before you start

  • You must hold pm.clearance-metrics.view.
  • Metrics are computed from pm_patient_cost_estimates records. No data will display if no cost estimates have been created for the organization.

​
Steps

1

Open Clearance Metrics

Navigate to /pm/financial-clearance/metrics. The page loads and computes metrics from your organization’s cost estimate records.
2

Apply filters

Use the Clearance Metrics Filters bar to narrow by date range, payer, or service type. All KPI cards, charts, and the summary table update to reflect the filtered data.
3

Review KPI cards

Four KPI cards display completion rate, average days to clearance, average patient responsibility, and override rate. Each card includes a short description of the metric source.
4

Review trend charts

The charts section below the KPI cards visualizes clearance performance over time.
5

Review the summary table

The Summary card at the bottom of the page shows total estimates, cleared count, pending count, and completion rate as a flat grid.

​
Key concepts

— an estimate record with clearance_status = 'cleared' and a non-null clearance_completed_at. — an estimate record with clearance_status = 'override'; counted separately in the Override Rate KPI.
When total_admissions equals 0 (no records match the filters), the screen shows “No clearance data available for the selected filters.”
If the metrics fetch fails, the screen shows “Unable to load metrics — There was an error loading clearance metrics. Please try again.”
If no organization is loaded in context, the page renders a skeleton while waiting for organization data.

Practice Management

Overview of the Practice Management core.

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/pm.tsx
  • src/cores/pm/pages/ClearanceMetricsPage.tsx
  • src/cores/pm/hooks/useClearanceMetrics.ts
  • src/platform/permissions/constants.ts