Get started
Feature guides

Integrations: API, webhooks, FHIR and calendars

Everything another system needs is on the Integrations screen and the developer pages: keys that call the same API the product uses, webhooks signed so you can trust them, read-only FHIR, and a sandbox clinic to build against.

Step by step

How to do it

  1. Make a keyIntegrations → API keys. Keys need platform.api_key.issue to make, and carry only the scopes you give them.
  2. Subscribe to webhooksAdd an endpoint for the events you want — patients, bookings, visits, bills, payments, dispenses, admissions, leads. Each delivery is signed in x-medappz-signature with your whsec_ secret, and carries no clinical content.
  3. Use the OpenAPI file or an SDKThe OpenAPI file and the TypeScript and Python SDKs download from the developer pages.
  4. Read FHIR R4A patient and their record as FHIR resources — Patient, Encounter, Observation, Condition, AllergyIntolerance, MedicationRequest, DiagnosticReport and DocumentReference. Read only.
  5. Build against the sandboxMake a sandbox clinic on the developer page: synthetic patients and an API key, with messages, AI and uploads off.
In the product

Where to find it

Integrations
/integrations
Calendar Sync
/calendar-sync
FHIR capability statement
GET /v1/fhir/metadata

Paths are in the product, after you sign in; each opens only for people whose role includes it.

Not live yet

Calendar Sync’s Connect Google and Connect Microsoft stay disabled until the platform registers its Google and Microsoft keys. FHIR is read-only, and a key sees document metadata, not the file. Revenue-share payouts for third-party apps are not built.

Apps

The apps involved

FHIRBridgeSend records to another system in FHIR, and take theirs inCalendarSyncKeep your Google or Outlook calendar in step with your diary
Read on

Related pages

Next: Your own brand, and partners →