DevelopersReturn to site

Changelog

Latest updates and changes to the Jump EHR API. Track new features and breaking changes.

All notable changes to the Jump EHR API will be documented here.

Subscribe to API updates by following our blog or contacting hello@usejump.co.uk.

This changelog tracks the public REST API surface (the api-v1 service). It is derived from the openapi.yaml contract — every endpoint listed here has a matching entry in the API Reference.

2026-04-03 — Booking & Scheduling

Added the read endpoints partners need to drive online booking, plus webhook subscriptions.

  • Availability — GET /availability, GET /availability/next, and POST /availability/verify to find bookable slots and validate one before booking.
  • Locations — GET /locations, GET /locations/{id}.
  • Clinician Profiles — GET /clinician-profiles, GET /clinician-profiles/{id}.
  • Webhooks — GET, POST /webhooks, GET, PATCH, DELETE /webhooks/{id}, and POST /webhooks/{id}/test. HMAC-SHA256 signature verification with automatic retry and exponential backoff.

2026-03-26 — Clinical records, episodes & questionnaires

  • Consultations — GET /consultations, GET /consultations/{id}, and per-section reads exposed as sub-resources: problems, medications, prescriptions, observations, procedures, referrals, lab-orders, allergies, immunisations, documents, family-history, social-history, invoices, and amendments.
  • Episodes — GET, POST /episodes, GET, PATCH /episodes/{id}, lifecycle actions (close, reopen, assign, change-priority), and GET, POST /episodes/{id}/events.
  • Episode Events — GET /episode-events/{id}.
  • Questionnaire Templates — GET /questionnaire-templates, GET /questionnaire-templates/{id}.
  • Questionnaire Responses — GET, POST /questionnaire-responses, GET, PATCH /questionnaire-responses/{id}.
  • Pathway Configs — GET /pathway-configs, GET, PATCH /pathway-configs/{id}.
  • Pathway Rules — GET, POST /pathway-rules, GET, PATCH, DELETE /pathway-rules/{id}.
  • Patient clinical collections — GET /patients/{id}/{observations|medications|problems|referrals|allergies|immunisations}.

2026-03-25 — v1.0.0 (initial release)

The first public release of the Jump EHR API.

  • Health — GET /health, an unauthenticated health check.
  • Patients — GET, POST /patients and GET, PATCH /patients/{id} with search, filtering and pagination.
  • Appointments — GET, POST /appointments, GET, PATCH /appointments/{id} (idempotency-key support on POST), and POST /appointments/{id}/cancel with state-machine validation and audit logging.
  • Appointment Templates — GET, POST /appointment-templates, GET, PATCH /appointment-templates/{id}, with an immutability guard on in-use templates.
  • Authentication & security — Bearer-token API keys (pk_live_* / pk_test_*), granular scopes, per-key rate limiting, and multi-tenant data isolation.
  • Developer experience — interactive API Explorer (Swagger UI) and code examples in cURL, JavaScript and Python.

Versioning Policy

The Jump EHR API follows semantic versioning:

  • Major versions (v1, v2) may include breaking changes
  • Minor versions add functionality in a backward-compatible manner
  • Patch versions include backward-compatible bug fixes

We provide advance notice of breaking changes and maintain previous major versions during transition periods.

API Stability

The v1 API is considered stable. We commit to:

  • No breaking changes within a major version
  • 12-month deprecation notice before removing endpoints
  • Migration guides for all major version upgrades

On this page

2026-04-03 — Booking & Scheduling2026-03-26 — Clinical records, episodes & questionnaires2026-03-25 — v1.0.0 (initial release)Versioning PolicyAPI Stability