Skip to main content
This changelog records changes to the Hi Doctor patient REST API and its documentation, newest first. Existing operation IDs, request shapes and responses stay unchanged unless an entry says otherwise. Changes to the AI assistant connector are tracked separately in the MCP changelog. Last reviewed: 2026-11-04

​
2026-11-04: Reference cleanup

  • The marketing attribution and funnel event endpoints are no longer part of the published patient reference. They were never needed to sign a patient in, run a consultation or read records.
  • The guided questionnaire endpoints are documented with English, Spanish and Chinese copy (locale=en, es or zh).
  • Uploads and downloads now states that photo and document uploads accept an Idempotency-Key, matching the safe retries guide.
  • Sign up lists the 27 country codes accepted for the country of residence.
  • Authentication and errors now document the verification_required sign-in code and the Retry-After header on account cooldowns.

​
2026-10-07: Guided questionnaires and safe retries

Live in production since 7 October 2026.
  • New guided questionnaire endpoints: current/, answer/, back/ and review/ under /v1/users/questionnaires/{slug}/. They apply the branching and validation rules for you and support skips of optional questions, grid and follow-up sub-items, atomic batches and optimistic revisions (409 stale_revision).
  • New Idempotency-Key header on questionnaire submission, messages, checkout, subscription changes, photo uploads and document uploads, with GET /v1/users/idempotency/{key}/ to reconcile an uncertain write. Keys are kept for 30 days.
  • Updated errors and recovery for keyed writes.
  • Existing operation IDs, request shapes and responses are unchanged. Requests without the new header behave as before.

​
2026-10-06: Integration guidance

  • Added the agent entry point, agent quickstart, curated machine-readable indexes and capability skill.
  • Updated REST quickstart and authentication to separate patient JWTs, product MCP OAuth and public docs search.
  • Corrected error examples and recovery: field-error arrays, Google-only account handling, cooldown body hints, HTML errors and uncertain-write reconciliation.
  • Clarified existing list envelopes and safe continuation. No unified cursor pagination was introduced.
  • The canonical public specification is OpenAPI.

​
What stays compatible?

These documentation updates do not rename operation IDs, tool names, scopes or error codes. Consumers should check the current endpoint schema and the relevant changelog before upgrading. Idempotency keys apply only to the endpoints listed in the safe retries guide. There is no RFC 9457 response contract, quota-header guarantee or universal retry policy. No fixed deprecation notice period is promised here. For integration questions, contact Hi Doctor. Start with the REST quickstart or the agent guide.