Ambient transcript document detail metadata without transcript turns.

Audio Duration Seconds

Created At

Document Id

Encounter Id

Discriminator for ambient transcript metadata responses.

Schema Type

Ambient transcript lifecycle status when available.

Status

Title

Updated At

Workflow Variant

PublicAmbientTranscriptDocumentDetail

PublicApiErrorResponse

Clinical document detail with public markdown content.

Discriminator for clinical document detail responses.

Clinical document status is not exposed on this detail variant.

Workflow variant is not exposed on clinical document detail responses.

PublicClinicalDocumentDetail

Short-lived signed URL for document audio.

Audio Url

Expires At

PublicDocumentAudioResponse

#/components/schemas/PublicAmbientTranscriptDocumentDetail

Document

PublicDocumentDetailResponse

Markdown content returned for supported clinical documents.

Content format. Public clinical document content is markdown.

Format

Text

PublicDocumentMarkdownContent

PublicDocumentTranscriptResponse

Encounter summary and related document summaries.

PublicEncounterDetailResponse

Document summary embedded in public encounter list and detail responses.

Audio duration in seconds when known for transcript documents.

Public document summary type. Billing and checklist values are summary-only and are not supported document-detail targets.

Document lifecycle status when available.

Ambient workflow variant when applicable.

PublicEncounterDocumentSummary

Offset-paginated public encounter list response.

Encounter summaries in the requested page.

Items

Limit

Offset

Total matching encounters at the time the query was evaluated.

Total

PublicEncounterListResponse

Public encounter summary with patient and document summary data.

Encounter date of service when available.

Date Of Service

Public document summaries associated with the encounter.

Documents

Derived public encounter type. Null means no approved summary type could be derived from the encounter documents.

Encounter Type

Opaque organization identifier that owns the encounter.

Organization Id

Patient summary when available for the encounter.

Encounter lifecycle status when available.

PublicEncounterSummary

Finalized transcript content for an ambient transcript document.

Transcript audio duration in seconds when known.

Provider

Final transcript turns in chronological order.

Turns

PublicFinalTranscript

Patient summary fields returned in public encounter responses.

Patient date of birth when available to the public contract.

Date Of Birth

Patient first name when available to the public contract.

First Name

Patient last name when available to the public contract.

Last Name

Patient Id

PublicPatientSummary

Speaker

Start

PublicTranscriptTurn

RecordingTranscriptReadyResources

Api Version

Occurred At

Type

RecordingTranscriptReadyWebhookEvent

Send Authorization: Bearer <api_key> from server-side code.

Curated public REST API for ChartHero API-key integrations, plus planned / not generally available public webhook reference material. Internal application and management surfaces are intentionally excluded.

ChartHero Public API

List encounters available to the caller organization.

Required scopes: `encounters:read`, `patients:read`, `documents:read`.

The route is read-only and available only for approved organizations using organization-scoped API keys. Authorization, route availability, organization approval, and required scopes are checked before query parsing, unsupported-filter handling, or resource lookup.

Pagination is offset-based with limit default 50, limit range 1..100, offset default 0, and offset range 0..10000. Integers must be canonical decimal text. Results are ordered by created_at with encounter_id as a deterministic tie-breaker; sort_order defaults to desc. start_at is an inclusive timezone-aware ISO datetime lower bound on created_at; end_at is an exclusive timezone-aware ISO datetime upper bound. Offset pages are not snapshot-consistent across repeated calls.

Example request: GET /external/v1/encounters?limit=50&offset=0&sort_order=desc.

Repeated reads may record repeated disclosure events.

Maximum number of encounters to return. Defaults to 50; allowed range is 1..100. Use canonical decimal integer text.

limit

Zero-based offset into the encounter list. Defaults to 0; allowed range is 0..10000. Use canonical decimal integer text. Offset pagination is not snapshot-consistent across repeated calls.

offset

Sort direction for created_at, with encounter_id as a deterministic tie-breaker. Defaults to desc.

sort_order

Inclusive created_at lower bound. Use a timezone-aware ISO datetime.

start_at

Exclusive created_at upper bound. Use a timezone-aware ISO datetime.

end_at

Read one encounter available to the caller organization.

Required scopes: `encounters:read`, `patients:read`, `documents:read`.

The route is read-only and available only for approved organizations using organization-scoped API keys. Authorization, route availability, organization approval, and required scopes are checked before unsupported query parameters or resource lookup. Demo/training and cross-organization encounters are not returned through this route.

Example request: GET /external/v1/encounters/enc_synthetic_001.

Path IDs are opaque ChartHero IDs. Treat the example values as illustrative strings only; no prefix or format semantics are guaranteed.

Opaque encounter identifier returned by public encounter routes. Example values are illustrative only and do not define an ID format.

encounter_id

One public encounter with patient and document summaries.

Read one supported document that belongs to an available encounter.

Required scopes: `encounters:read`, `documents:read`.

The route is read-only and available only for approved organizations using organization-scoped API keys. Authorization, route availability, organization approval, and required scopes are checked before unsupported query parameters or resource lookup.

A document with schema_type=document returns clinical markdown content. A document with schema_type=ambient_transcript returns transcript metadata only; use the transcript route for transcript turns and the audio route for audio URL access. Billing and checklist summaries are not supported document-detail targets.

Example request: GET /external/v1/encounters/enc_synthetic_001/documents/doc_synthetic_note_001.

Path IDs are opaque ChartHero IDs. Treat the example values as illustrative strings only; no prefix or format semantics are guaranteed.

Opaque document identifier returned in public encounter document summaries. Example values are illustrative only and do not define an ID format.

document_id

One supported public document: clinical content or ambient transcript metadata.

Request a short-lived signed URL for audio associated with an ambient transcript document.

Required scopes: `encounters:read`, `documents:read`, `recordings:read`.

The route is read-only and available only for approved organizations using organization-scoped API keys. Authorization, route availability, organization approval, and required scopes are checked before unsupported query parameters or resource lookup.

The document must be an ambient transcript with completed transcript content and recording-backed audio. Each successful call can issue a new URL, and expires_at can differ across retries. Use the document route for metadata and the transcript route for transcript turns.

Example request: GET /external/v1/encounters/enc_synthetic_001/documents/doc_synthetic_transcript_001/audio.

Path IDs are opaque ChartHero IDs. Treat the example values as illustrative strings only; no prefix or format semantics are guaranteed.

A short-lived signed URL for document audio.

Read finalized transcript turns for an ambient transcript document.

Required scopes: `encounters:read`, `documents:read`.

The route is read-only and available only for approved organizations using organization-scoped API keys. Authorization, route availability, organization approval, and required scopes are checked before unsupported query parameters or resource lookup.

The document must be an ambient transcript with a completed, finalized transcript. The document-detail route returns only ambient transcript metadata; this route returns speaker turns and timing.

Example request: GET /external/v1/encounters/enc_synthetic_001/documents/doc_synthetic_transcript_001/transcript.

Path IDs are opaque ChartHero IDs. Treat the example values as illustrative strings only; no prefix or format semantics are guaranteed.

Finalized transcript turns for an ambient transcript document.

Public API origin; deployment hostname intentionally not fixed by DOCS-FR-002

Planned and not generally available. Receivers should dedupe business work by body id or ChartHero-Event-Id. Current receiver correlation status is not_confirmed_runtime_blocked. Launch requires subscription activation provenance for approved follow-up routes, least-privilege receiver API-key scopes, receiver correlation, signing setup, and outbound PHI audit readiness.

ChartHero-Event-Id

Stable for one event/endpoint delivery and reused across retries.

ChartHero-Delivery-Id

Decimal Unix epoch seconds. Receivers should reject values outside a 300 second local-clock tolerance.

ChartHero-Timestamp

HMAC-SHA256 signature over {timestamp}.{raw_request_body}, formatted with the v1= prefix.

ChartHero-Signature

ChartHero-Webhook-Version

Any 2xx response is treated as receiver success; no response body is required.

Receive recording transcript-ready notifications

Surface	Summary
`GET /external/v1/encounters`	List public encounters
`GET /external/v1/encounters/{encounter_id}`	Get a public encounter
`GET /external/v1/encounters/{encounter_id}/documents/{document_id}`	Get a public document
`GET /external/v1/encounters/{encounter_id}/documents/{document_id}/audio`	Get a public document audio URL
`GET /external/v1/encounters/{encounter_id}/documents/{document_id}/transcript`	Get a public document transcript
`recording.transcript_ready`	Planned / not generally available webhook contract (planned_not_generally_available): Receive recording transcript-ready notifications

API Reference

Base URL

Authentication

OpenAPI JSON

Resources

Encounters

Documents

Transcripts

Audio

Webhooks

ChartHero Public API