Skip to main content
Format follows Keep a Changelog.

2026-09-23

Added

  • GET /api/v2/referrals/{referral_id}/payments lists amount, date, check number, and allocated procedures (description is the portal study string, for example MRI Left Ankle w/contrast). Off until Scan enables payment read.
  • Workers’ compensation guide covers pulling payments after the referral leaves pending / canceled. Payments can arrive months after invoice ready.

2026-09-22

Added

  • Structured error envelope (type, code, request_id, documentation_url) and X-Request-Id on v2 errors. Existing error / errors keys remain.
  • Sandbox testing: POST /api/v2/testing/fixtures, PATCH /api/v2/testing/visits/{id}, POST /api/v2/testing/events.
  • Stable webhook event_id for visit and notification status events, five-attempt retries, and a 24-hour previous-signing-secret grace period.
  • delivery=url on order documents (base64 still default, deprecated). Combined documents include invoice.
  • Native interop fields: split patient name, ISO DOB, CPT/ICD-10 system, accession_id, study_uid / series_uid, location npi.
  • FHIR R4 mapping page and opt-in GET /api/v2/fhir/diagnostic_reports/{id} / imaging_studies/{id}.

Changed

  • The sandbox allowance is 2,000 successful requests or 7 days. Failed 4xx/5xx requests do not count.
  • The referral response schema and create-referral required fields now match API behavior. Error responses use the shared envelope. Documentation navigation is organized into Guides, Platform, and API reference.