A detailed explainer on getting started with your Halaxy integration — for both Heidi Scribe and Heidi Comms.
⚠️ To integrate with Halaxy, you'll need to be on the Practice tier plan (a 30-day free trial is available). This applies to both Heidi Scribe and Heidi Comms.
Setup is different for each product. Heidi Scribe runs as an embedded widget inside your Halaxy clinical notes — sign in once via the widget and you're set. Heidi Comms requires the Halaxy API add-on and an API key, which you'll hand off to your Heidi onboarding engineer. Jump down to the section for whichever side of Heidi you're connecting.
Video demo — using Heidi Scribe in Halaxy
Connect Heidi Scribe to Halaxy
Heidi Scribe runs as an embedded widget inside Halaxy clinical notes. There's no separate setup — once you have a Heidi Practice tier plan, the Heidi widget will appear in your clinical notes. The first time you launch it, you'll be prompted to log in or sign up.
Launch the widget for the first time
Open a Halaxy clinical note.
On the bottom right of the clinical note, click Launch AI to open the Heidi widget.
If it's your first time, you'll be prompted to log in or sign up at Heidi. You'll only need to do this once — Heidi offers a 30-day trial without a credit card.
Use Heidi Scribe with Halaxy
Transcribing a clinical note
Open a Halaxy clinical note.
On the bottom right, click Launch AI to open the Heidi widget.
(Optional) Click Context and add any patient information you'd like Heidi to incorporate in your notes — for example, the patient's age, the reason for the visit, or relevant health and medication history.
When you're ready, click Start visit to begin recording the session.
To pause or end recording, hover over the timestamp and click End Session.
From the list that appears, select the template format you want for this note (for example, SOAP).
Click Note to view the generated output. To change format, click the magic wand icon and select another template — you can change format as many times as you need.
When the note is ready, click Push Note to write it back into your Halaxy clinical note.
You have successfully transcribed a Halaxy clinical note on with Heidi.
Tips for using the Heidi widget
Click Transcript to view the raw transcription of the session.
To create custom templates, log in to Heidi via the desktop or mobile app — templates you create there sync to the widget.
Launching the Heidi widget automatically loads the last session for the current patient on the same day. To start a new session on the same day, click the cog icon in the top-right of the widget, then click New session.
If you launch the widget on a new day, a fresh session loads automatically.
Connect Heidi Comms to Halaxy
Heidi Comms connects to Halaxy via an API key. Setup involves three parts — enable the API, generate and hand off your key, and confirm a few additional Halaxy settings.
Part 1: Enable the Halaxy API
1. Go to Add-Ons
Sign in to Halaxy.
From the left sidebar, open Settings → Add-Ons.
2. Add a subscription
Click Add a Subscription.
3. Purchase Halaxy API
Click Purchase Halaxy API.
Click Purchase to confirm.
⚠️ Purchasing the Halaxy API uses credits in your Halaxy account. If you don't have credits, contact Halaxy support or your practice manager before continuing.
Part 2: Generate your Halaxy API key
1. Go to Integrations
From the left sidebar, open Settings → Integrations.
2. Create a new external key
Click External in the top-left.
Click Create New Key in the top-right.
3. Configure and save the key
Select the resources this key will have access to.
Click Save.
4. Copy and send your credentials
Copy your Client ID and Client Secret shown on screen.
Forward both values to your Heidi onboarding engineer, who'll complete the setup on Heidi's side. If you don't know who your onboarding engineer is, reach out to our support team.
Part 3: Enable additional Halaxy settings
Three Halaxy settings need to be confirmed before the integration works end-to-end.
Online Bookings
1. Go to Locations
From the left sidebar, open Personal → Locations.
2. Edit booking preferences
Click the pencil icon next to Online Bookings and Profile Preferences.
Confirm Online Bookings is toggled on.
Click Save.
Appointment Types
1. Go to General Settings
From the left sidebar, open Settings → General.
2. Check Appointment Types
Click View All next to Appointment Types List.
Confirm your appointment types are set up.
In the Online Booking column, set Allow Online Booking to Yes - any bookable appointment type.
Click Save.
Attendance Update
1. Check Appointment Settings
Still in Settings → General, scroll to Appointment Settings.
For each practitioner, confirm Attendance Update is set to Automatic.
