Skip to main content
The Clearinghouse File screen (Clearinghouse Configuration Detail) displays and edits a single clearinghouse connection record at route /pm/clearinghouse/:id. Creating a new configuration is served by /pm/clearinghouse/new using the same component.

​
Overview

The page uses a react-hook-form / Zod form to manage clearinghouse connection settings. Fields include: Name, Provider (Waystar / Availity / Change Healthcare / Trizetto / Other), Sender ID, Receiver ID, Connection Type (SFTP / REST API / Web Portal), and Active toggle. Additional fields appear conditionally: SFTP settings (Host, Port, Retrieval Path /inbound, Submission Path /outbound) or API settings (API Endpoint URL). Credentials are entered as vault reference strings (vault://...), not raw secrets. On existing configurations, a Test Connection button calls the clearinghouse adapter’s validateCredentials method. A Save / Create button (gated by pm.clearinghouse.create or pm.clearinghouse.edit) submits the form. Below the form, existing configs also show FailoverSettingsCard and PayerRoutesTable.

​
Who it’s for

Viewing an existing configuration requires PM_PERMISSIONS.CLAIMS_VIEW. Creating a new configuration requires PM_PERMISSIONS.ADMIN. Saving changes requires pm.clearinghouse.edit; creating requires pm.clearinghouse.create.

​
Before you start

  • You need pm.admin to create new configurations.
  • You need pm.claims.view to view an existing configuration.
  • Vault reference strings for credentials must be provisioned outside this UI.

​
Steps

1

Open a clearinghouse configuration

Navigate from the Clearinghouse list (/pm/clearinghouse) and click a configuration row, or go to /pm/clearinghouse/new to create.
2

Fill in general settings

Enter the configuration name, select the provider, and enter Sender ID and Receiver ID. Choose SFTP, REST API, or Web Portal as the connection type.
3

Enter connection-specific settings

For SFTP: enter Host, Port, Retrieval Path, and Submission Path. For API: enter the API Endpoint URL.
4

Enter vault references for credentials

Enter the username_vault_ref and credentials_vault_ref as vault path strings. Do not paste raw credentials.
5

Test the connection (existing configs only)

Click Test Connection to validate the stored credentials against the clearinghouse provider.
6

Save or create

Click Save Changes or Create to persist the configuration.

​
Key concepts

Practice Management

Practice Management core 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/pm.tsx
  • src/cores/pm/pages/ClearinghouseConfigDetailPage.tsx
  • src/cores/pm/hooks/useClearinghouseConfig.ts
  • src/cores/pm/services/clearinghouse.ts