Unfortunately, the Heidi API and Widget are no longer available for future integrations in Australia and New Zealand. If you are a current Heidi customer looking to integrate, reach out to your Customer Success representative. Otherwise, contact our team to find out what this means for you.
Connectors
Overview
Connector program

Bring your clinical software into Heidi.

Build one connector and every clinic on your system can use Heidi with their schedule, patients and notes. Build it to the spec, or send us your API docs and Heidi builds it for you.

What clinicians get

  • Their day in HeidiToday's appointments from your system, scoped to the signed-in clinician.
  • The right patient, first timeSessions start from an appointment with the patient already identified.
  • Pre-chartingAllergies, medications, problems and recent notes, before the consult.
  • Notes written backThe clinician-approved note lands on the patient's record in your system.

Three ways in

Every route carries the same operations and goes through the same review.

From application to live

  1. Step 1ApplyTell us about your product. We reply with sandbox details.
  2. Step 2BuildBuild to the spec, or let Heidi build from your API docs.
  3. Step 3ValidateWe check the connector with you against the specification.
  4. Step 4Go liveHeidi reviews it, then clinics switch it on in Settings.

Connectors are in preview. The transport (REST or MCP) and the submission process may change before general availability. We will give connector authors notice before any breaking change.

Who can build one

Anyone. EMR and PMS vendors, practice groups with an in-house system, or a clinic's one-person IT team. If your system has an API or a database, you can build a connector. Every connector goes through Heidi's review before clinics can switch it on.

Connectors are open in every region, including Australia and New Zealand.

Operations

REST and MCP connectors carry the same operations:

ToolPurpose
heidi_get_connector_infoIdentify the connector and the practice behind a key
heidi_list_practitionersLet each clinician pick themselves during setup
heidi_list_appointmentsShow a clinician's appointments
heidi_search_patients / heidi_get_patientFind and read patients
heidi_push_noteWrite an approved note back to the record
heidi_get_patient_context (optional)Pre-chart from history
heidi_upload_document (optional)Attach letters and PDFs

Heidi's agents can also use your connector: "find Margaret Hughes' last visit", "write this letter to her record". Every write waits for the clinician's approval.

How clinics connect

  1. You issue each clinic a connector key, the same way you issue API access today.
  2. In Heidi, the clinic opens Settings → Connectors, picks your connector, pastes the key and selects their practitioner.
  3. Heidi calls your connector with that key over HTTPS.

Get started

  • Apply: tell us about your product by email. We work closely with partners to set the connector up.
  • Specification: operations, shapes, auth, errors and the REST binding
  • Tool connectors: already have an MCP server, e.g. for billing? Offer its tools to Heidi's agent as they are
  • Testing: the conformance validator
  • Submitting: review and compliance checks

Have API docs but no engineering time? Apply and say "send Heidi our docs": we build and host the connector for you.