Changelog and versioning

Versioning

The current public contract version is v1. Public REST routes live under /external/v1, and the bundled OpenAPI artifact is published at /openapi/v1/openapi.json.

ChartHero adds optional response fields only after updating the curated public schema, this changelog and compatibility guidance. The current public response schemas describe today's responses exactly: generate clients from them and validate responses against them in your tests. Build clients that ignore response fields they don't recognize, so a new optional field doesn't break them.

The current webhook API version is 2026-05-01 for recording.transcript_ready and evaluation.completed. Their payload fields are exact, do not allow additional properties, and remain a thin pointer. A new event type changes no existing payload, so it is added under the current version. Future public webhook payload additions require a new webhook API version after schema, docs, and changelog updates, and must not add embedded transcript turns, audio URLs, patient demographics, document content, or clinical payloads.

Outbound webhook sends are recorded as delivery evidence. Follow-up public API fetches are separate PHI disclosures audited as public API access.

Changelog

Date	Change
2026-10-01	Added evaluations: GET /external/v1/evaluations, GET /external/v1/evaluations/{evaluation_id}, and GET /external/v1/evaluation-definitions, the evaluations:read scope, and the evaluation_not_found and evaluation_read_unavailable reason codes.
2026-10-01	Added the evaluation.completed webhook, with GET /external/v1/evaluations/{evaluation_id} as its follow-up route. It uses the current webhook API version, 2026-05-01: a new event type changes no existing payload, so the version stays the same.
2026-10-01	Added the Evaluations, Evaluation definitions, and Fetch evaluations guides, and a Standard evaluation definitions reference generated from ChartHero's registry.
2026-06-24	Aligned public patient, encounter, actor, and provider external_ids[] with adapter identifiers: those resources now use source, type, and value.
2026-06-23	Added optional transcript_language and source_transcript fields for translated phone-call transcript documents.
2026-06-08	Added the actor list route and actor reference schemas for user and API-key actors.
2026-06-05	Marked recording.transcript_ready webhook delivery, management, and developer-docs integration as complete for activated subscriptions.
2026-06-05	Documented exact recording.transcript_ready webhook payload evolution rules, send evidence sources, and follow-up public API PHI audit separation.
2026-06-01	Polished developer docs with clearer environment guidance, request-access paths, webhook availability labels, and synthetic-only examples.
2026-06-01	Reorganized developer docs navigation around get started, core concepts, task guides, API reference, webhooks, errors, and changelog.
2026-06-01	Added initial task guides for fetching encounters, documents, transcripts, audio, receiving webhooks, and verifying webhook signatures.
2026-05-28	Initial static developer docs app for the curated public API v1 contract.
2026-05-28	Added generated OpenAPI reference and raw schema download path.
2026-05-28	Added guide pages for authentication, pagination and filters, errors, webhooks, and changelog and versioning.

Not In This Release

This release does not add SDK generation, authenticated try-it requests, partner-private docs, multiple API versions, AsyncAPI, delivery history, manual redelivery, or public API write behavior.