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 is the Clearinghouse Integration configuration list, accessible at /pm/clearinghouse.

​
Overview

The Clearinghouse page lists all clearinghouse connection configurations for the organization. Each configuration record stores a clearinghouse name, provider, connection type (SFTP, REST API, or Web Portal), sender and receiver IDs, and an active/inactive flag. A health badge on each card reflects the last reported connection health status (healthy, degraded, unhealthy, or unknown). Configurations are soft-deleted — removing a record does not affect existing transaction batches or logs. Users with pm.clearinghouse.edit permission see Edit and Remove controls on each card; users without that permission see the list in read-only mode. The “Add Configuration” button is gated separately on pm.clearinghouse.create.

​
Who it’s for

Requires permission pm.claims.view (route guard: PM_PERMISSIONS.CLAIMS_VIEW). Creating or editing configurations additionally requires pm.clearinghouse.create / pm.clearinghouse.edit.

​
Before you start

  • You must hold the pm.claims.view permission to access this page.
  • At least one clearinghouse account must be provisioned with the vendor before adding a configuration.

​
Steps

1

Open Clearinghouse Integration

Navigate to /pm/clearinghouse. The page loads all active configurations for your organization, sorted alphabetically by clearinghouse name.
2

Filter the list

Use the search box to filter by configuration name. Use the connection type dropdown to filter by SFTP, REST API, or Web Portal. Toggle “Show inactive” to include soft-deleted or deactivated records.
3

View or edit a configuration

Click any configuration card to open the detail page at /pm/clearinghouse/:id. (Requires pm.clearinghouse.edit to make changes.)
4

Add a new configuration

Click “Add Configuration” (requires pm.clearinghouse.create). This navigates to /pm/clearinghouse/new.
5

Remove a configuration

Click the trash icon on a card and confirm the “Remove Configuration” dialog. The record is soft-deleted; existing batches and transaction logs are unaffected.

​
Key concepts

The three supported connection types are SFTP, REST API, and Web Portal, corresponding to the sftp, api, and web_portal values stored in pm_clearinghouse_config.connection_type.
Each card displays a with values healthy, degraded, unhealthy, or unknown. The last_health_check_at timestamp is also shown.
The card subtitle shows sender_id and receiver_id from the configuration record. These are the interchange identifiers required for claim submission.
When no configurations exist, an empty state prompts “Add your first clearinghouse connection to begin submitting claims electronically.” When filters are active and no results match, the message reads “No configurations match the current filters.”

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/ClearinghouseConfigListPage.tsx
  • src/cores/pm/hooks/useClearinghouseConfig.ts
  • src/cores/pm/types/clearinghouse.ts
  • src/platform/permissions/constants.ts