Resources / API

API Reference.

A typed, versioned REST API and SMART on FHIR surface for integrating Medi Prompt into your clinical stack - designed with idempotency, clear errors, and thoughtful defaults.

Highlights

  • OAuth 2.0 + PKCE

    SMART launch flows, refresh tokens, and short-lived service tokens.

  • FHIR R4 resources

    Patient, Encounter, Observation, MedicationRequest, DocumentReference.

  • Webhooks

    Consult lifecycle, prescription events, red-flag triggers, message events.

  • Rate limits

    Per-tenant burst allowances with clear headers and honest retry semantics.

Conventions

  • Idempotency

    All POST endpoints accept an Idempotency-Key header.

  • Versioning

    URI-versioned major, additive minor changes, six-month deprecation windows.

  • Errors

    Structured JSON with code, message, hint, and correlation ID.

  • Pagination

    Cursor-based with stable ordering.

Getting an API key

API keys are issued per environment (sandbox and production) and scoped to specific capabilities. Rotate at any time from the admin console.

Every account gets a free sandbox with realistic synthetic patients - build and test without touching real PHI.