Changelog
All notable changes to the Jump EHR API will be documented here.
Subscribe to API updates by following our developer blog (opens in a new tab) or contacting developers@jump.health.
v1.0.0 (January 2025)
Initial Release
We're excited to announce the public release of the Jump EHR API!
Features
Core Resources
- Patients API - Create, read, update patient records
- Consultations API - Manage clinical consultation records
- Problems API - Track patient diagnoses with SNOMED/ICD-10 codes
- Appointments API - Schedule and manage appointments
- Documents API - Upload and retrieve patient documents
- Prescriptions API - Manage medication prescriptions
Marketplace Resources
- Appointment Types API - Query available service types
- Clinicians API - View healthcare provider profiles
- Locations API - Access practice location details
- Availability API - Query available appointment slots
- Holds API - Temporarily reserve slots before booking
Webhooks
- Real-time event notifications for appointments, patients, and documents
- HMAC-SHA256 signature verification
- Automatic retry with exponential backoff
Developer Experience
- Interactive API Explorer with Swagger UI
- Comprehensive documentation
- Code examples in cURL, JavaScript, and Python
Authentication & Security
- Bearer token authentication with API keys
- Granular scopes for fine-grained access control
- Rate limiting with customizable quotas
- Multi-tenant data isolation
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