Skip to content

API changelog

Changes to the EDFlow Integration API and event contract: dated API versions, additive releases, announced enum values and event types, deprecations and sunsets.

Entries are drafted in CI from the differences between OpenAPI documents and the event contract's history, then edited by the integration team. Follow them with the RSS feed or the developer portal's notifications.

How to read an entry

  • Added: new endpoints, fields or event types. Safe to ignore until you need them.
  • Announced: new enum values, webhook event types or error codes that will reach customer test and live on the date shown (at least 60 days later). Update your lookup tables before then.
  • Deprecated: with the sunset date (at least 12 months later).
  • Changed: only behind a new dated Api-Version.

API version 2026-10-01 · event specVersion 1.0

The first dated version of the Integration API.

Added

  • OAuth 2.0 client credentials (private_key_jwt, client secret, mTLS) with 5-minute JWT access tokens; discovery documents; token revocation.
  • Ingest: POST /v1/events, POST /v1/events/batch, POST /v1/events/validate, POST /v1/fhir, POST /v1/fhir/$ingest, POST /v1/fhir/$process-message, POST /v1/hl7v2 (raw HL7 over HTTPS and JSON-wrapped).
  • Reads: encounters, care team, requests, tasks, codes, sites, the ingest ledger.
  • Write-back: acknowledge and resolve patient requests.
  • Webhooks: Standard Webhooks delivery with 18 event types, endpoint management, deliveries, redelivery and recovery.
  • Sandbox: scenarios, fault injection, conformance runs, synthetic requests, reset.
  • The signed ingest profile (/ehr/v1/*) with v2 signatures binding the method, path, site code and input kind.

Deprecated

  • v1 signatures on /ehr/v1/events, accepted only for sources in a migration window of at most 90 days.

Last updated on

Was this page helpful?

On this page

How to read an entryAPI version 2026-10-01 · event specVersion 1.0Related