Submitting for review

Anyone can build a Heidi connector. Before clinicians can switch it on, it goes through Heidi's review.

The process

Step	Who	What happens
1. Tell us	You	Apply by email with your product, regions and rough clinic count. We'll reply with a sandbox Heidi account.
2. Set up	Both	We work closely with you to implement the specification.
3. Validate	Both	We check the connector against your sandbox until it is conformant.
4. Submit	You	Send the submission pack below.
5. Review	Heidi	Automated conformance re-run, security and privacy review, and an end-to-end clinical test. Target turnaround is 10 business days.
6. Pilot	Both	The connector is switched on for 1–3 named clinics. We watch error rates and note-push accuracy.
7. Live	Heidi	Listed under Settings → Connectors for every clinic in your regions.

Got API docs but no time to build? Send us the docs. For some systems Heidi builds and hosts the connector. That still goes through the same review.

heidi-connector.json: the manifest for your connector. We prepare this with you.
Sandbox access: the sandbox_url and two test practice keys, with test patients and appointments in the next 7 days.
Validation: we re-run conformance against your sandbox during review.
Security questionnaire: we send it after step 1. It's short for small vendors.
Logo: square SVG or PNG, at least 256 px.

Every check in the validator passes against your sandbox, re-run by Heidi from our infrastructure.
Error responses contain no patient data.

HTTPS only (TLS 1.2+). Keys are per practice and can be revoked.
A key can only read and write its own practice's data. We test this with your two sandbox keys.
Keys are stored hashed or encrypted at rest on your side.
You have a named security contact and will notify Heidi of any incident affecting connector data within 72 hours.

data_handling.hosting_regions covers every region you list in regions. Patient data for AU clinics stays in AU, UK in UK, and so on.
If connector_stores_phi is true, you tell us what you store, for how long, and why.
Sub-processors are listed.
You accept Heidi's data processing terms (compliance.accepts_heidi_dpa).

A pushed note lands on the correct patient and practitioner, is readable in your UI, and is not duplicated on retry.
Appointments shown in Heidi match your system's book for the same day.

Changes: re-run the validator before deploying changes to your connector. Breaking changes need 30 days' notice.
Monitoring: Heidi tracks error rates and latency per connector and will contact your support email if they degrade.
Suspension: Heidi may switch off a connector that leaks data across practices, fails conformance, or has an unresolved security issue.