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 provides a form to create a new clearinghouse configuration. It is also used to view and edit existing clearinghouse configurations at /pm/clearinghouse/:id. Route: /pm/clearinghouse/new.

​
Overview

ClearinghouseConfigDetailPage presents a react-hook-form with zod validation. Fields include clearinghouse_name, clearinghouse_provider, sender_id, receiver_id, connection_type (sftp | api | web_portal), and is_active. Connection-type-specific fields (host, port, paths for SFTP; API endpoint for API) appear based on selection. Credential references (username_vault_ref, credentials_vault_ref) point to a secrets vault rather than storing credentials directly. The page also renders FailoverSettingsCard and PayerRoutesTable for existing records.

​
Who it’s for

Requires permission pm.admin (PM_PERMISSIONS.ADMIN).

​
Before you start

  • Obtain the sender ID and receiver ID from your clearinghouse vendor.
  • Have vault secret reference paths ready for credentials — raw credentials are not stored in this form.
  • Confirm the connection type (SFTP, API, or web portal) with your clearinghouse vendor.

​
Steps

1

Open the new clearinghouse form

Navigate to Practice Management → Clearinghouse → New, or go to /pm/clearinghouse/new.
2

Enter identification details

Fill in Clearinghouse Name, Clearinghouse Provider, Sender ID, and Receiver ID.
3

Select connection type

Choose API, SFTP, or Web Portal. Additional fields appear based on your selection (host/port/paths for SFTP; API endpoint for API).
4

Enter credential vault references

Provide vault reference paths for username_vault_ref and credentials_vault_ref. Do not enter raw credentials.
5

Save the configuration

Click Save. The adapter is created via useClearinghouseConfigMutation. A connection test option may be available via the test action.

​
Key concepts

  • Sender ID / Receiver ID — EDI interchange identifiers required for transaction routing.
  • Vault references — pointers to a secrets management system; raw credentials are not stored in the database.
  • Connection type — determines the transport protocol used for EDI file exchange (SFTP, REST API, or web portal upload).

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