Adapters

What you can build

ChartHero is an AI clinical documentation platform. Adapters let an approved organization embed ChartHero into its own EHR, care management platform, or internal system. The external system creates launch links into ChartHero and exposes partner endpoints that ChartHero calls to verify context, resolve providers, and stage provider mapping data.

Use the public API when your server calls ChartHero to read ChartHero resources. Use an adapter when ChartHero needs to launch from, verify against, or request context from your system.

The core model: a launch link carries only an opaque launch_state handle that you own — never the patient ChartHero opens. ChartHero opens whatever your launch-context callback returns, not what is in the link. The payload is encrypted and launch_state can carry whatever your adapter needs, but you don't need to put patient data in the link: return encounter context with embedded patient for an encounter or appointment launch, or return top-level patient context when the launch is not tied to an encounter. Internalizing this up front avoids the most common early mistake — stuffing patient data into the URL and expecting ChartHero to open it.

The current adapter contract version is 1.0.

Getting started: after Custom Adapter access is enabled for an organization, an authorized organization admin can create the adapter installation from ChartHero organization settings. New Custom Adapter installations start suspended so setup can happen in pieces. Configure external identifiers, connection settings, credentials, launch, and any provider-linking behavior before activating the installation.

Choose the right docs path

Choose your adapter path

Start with the smallest path that matches your adapter workflow. Add conditional endpoints, settings, and response fields only when the launch model, provider-linking mode, or onboarding plan requires them.

Implementation labels:

First adapter checklist

The Adapter Quickstart is the canonical, ordered build sequence — connection setup, launch configuration, the launch round trip, errors, and conformance testing. Start there once you have picked your adapter path above, and use Launch Flow for the launch loop itself.

Adapter base URL

Each adapter installation has one configured base URL. Standard routes are relative to that URL.

https://ehr.example.com/integrations/charthero

The first public adapter docs publish launch, provider-linking, and checklist-recommendations surfaces. They do not publish scheduling, broad import, clinical data import, appointment search, or write-back contracts. Those capabilities are expected to grow later under the adapter family; until each ships, ChartHero withholds it from the published contract so partners do not design around an unavailable surface.

Vocabulary map

Your domain terms map onto ChartHero resources and external identifier subjects as follows. The source and type strings are the exact values configured for the organization; the examples below are common labels, not required enums.

Glossary

Reference

The adapter contract reference is generated from a separate OpenAPI artifact:

/openapi/organization-adapters/v1/openapi.json

The generated reference describes endpoints your system implements. It is separate from the ChartHero public API reference, which describes endpoints your system calls.

The contract artifact path (organization-adapters) and the launch JWE header typ (charthero-org-integration-launch+jwe) carry an org/organization prefix. These are stable contract identifiers — use them exactly as shown. They refer to this same adapter contract.