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 Payment Plan page provides a detailed view of a patient payment plan with an installment timeline and management actions. Route: /pm/patient-payment-plans/:planId.

​
Overview

PatientPaymentPlanDetailPage45 loads the plan via usePatientPaymentPlanDetail and installments via useInstallmentsByPlan. It renders a two-column layout on large screens (plan summary + InstallmentTimeline). Actions available (subject to pm.payment-plans.edit permission via useHasPermission):
  • Record Payment — opens a dialog to record an installment payment amount
  • Pause — opens ConfirmationDialog to pause the plan
  • Cancel — opens ConfirmationDialog to cancel the plan
  • Write-off — opens WriteoffRequestSheet
Status and frequency are displayed using PLAN_45_STATUS_LABELS, PLAN_45_STATUS_VARIANT, and FREQUENCY_LABELS.

​
Who it’s for

Requires permission pm.payment-plans.view (PM_PERMISSIONS.PAYMENT_PLANS_45_VIEW). Edit actions require pm.payment-plans.edit.

​
Before you start

  • Access this page from the patient payment plans list at /pm/patient-payment-plans.
  • Management actions (pause, cancel, write-off) require the edit permission.

​
Steps

1

Open the payment plan

Navigate to Practice Management → Patient Payment Plans, select a plan, or go to /pm/patient-payment-plans/:planId.
2

Review plan summary and installment timeline

The left column shows plan summary (total amount, frequency, status). The right column shows the InstallmentTimeline with each installment’s status.
3

Record an installment payment

Click the payment action in the actions menu, enter the payment amount in the dialog, and confirm.
4

Pause, cancel, or request write-off

Use the actions dropdown to pause, cancel, or initiate a write-off request via WriteoffRequestSheet. Confirmation dialogs are shown for destructive actions.

​
Key concepts

  • Installment timeline — visual representation of each scheduled installment, with status indicators for paid, upcoming, and overdue installments.
  • Write-off request — initiates a write-off workflow; the request is subject to separate approval.

Practice Management

Practice Management core overview.

Governance & parity

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/PatientPaymentPlanDetailPage45.tsx
  • src/cores/pm/hooks/usePatientPaymentPlans45.ts
  • src/cores/pm/hooks/usePaymentPlanInstallments.ts
  • src/cores/pm/types/payment-plans-collections.ts