Healthcare· 8 min read

AI Receptionist for Halaxy: How the Booking Actually Reaches Your Diary

Halaxy publishes a FHIR-based API with appointment endpoints and webhooks, which means a call answered at 8pm can become a real appointment in your diary. Here is how that works, what it costs, and how to keep control of your data while doing it.

By the Elevate team · Built and reviewed against our standards.

Key takeaways

  • Halaxy publishes a public API at developers.halaxy.com built on FHIR, with endpoints to create, read and update appointments, plus webhooks for real-time updates.
  • That means a booking taken on a call can be written into your Halaxy diary during the call, rather than arriving as a message someone has to re-key.
  • The API is a paid Halaxy subscription, currently 150 credits per month with a 30 day free trial, billed by Halaxy rather than by your receptionist provider.
  • Access is controlled by you through Halaxy's API Key Manager. You generate a key scoped to specific data and revoke it whenever you want, which is the right way to grant a vendor access to a health practice.

If you run a Halaxy practice and you have started looking at AI receptionists, the question that actually matters is not whether the agent sounds good on a demo. It is what happens at the end of the call. An agent that takes a lovely booking and then emails your reception a paragraph to type up has moved the work, not removed it.

The good news for Halaxy practices is that this is one of the systems where the booking can go straight in.

Does an AI receptionist book directly into Halaxy?

Yes. Halaxy publishes a public API at developers.halaxy.com with endpoints to create, read and update appointments, so an appointment agreed on a phone call can be written into your Halaxy diary while the caller is still on the line. There are also webhooks, which means changes can flow back out to other systems in real time rather than on a nightly sync.

It is built on FHIR, which is the international standard for exchanging health information and is used by health systems and governments worldwide. That matters more than it sounds. A standards-based API is predictable, well documented, and far less likely to break underneath you than a bespoke one, which is exactly what you want sitting between your phone and your patient records.

What does the Halaxy API cost?

The API is a paid Halaxy subscription, currently 150 credits per month with a 30 day free trial. That is billed by Halaxy, not by your receptionist provider, and it is worth confirming the current figure with Halaxy directly since pricing changes.

Two things follow from that. First, budget for it separately rather than being surprised by it. Second, the free trial is genuinely useful, because it means you can prove the connection works against your own diary before anyone is locked into anything.

Do we have to hand over access to our whole practice?

No, and this is the part worth understanding properly, because it is the bit most practice managers are rightly nervous about.

Halaxy has an API Key Manager that lets you generate keys scoped to specific data. You decide what a given key can reach, you issue it, and you can revoke it whenever you want. That means access to your practice runs through a control you hold rather than a permission you granted once and forgot about.

The practical implication: a vendor should be able to tell you the minimum access they need to do the job, and you should grant that and nothing more. If a supplier asks for broad access to your practice data without being able to explain why each part is needed, that is a reasonable point to stop and ask questions.

Scoped keys you can revoke are the right way for a health practice to grant a vendor access. Ask for the minimum, and keep the ability to switch it off.

So what actually happens on a call?

The agent answers, works out what the caller needs, checks what is genuinely available, and books it. Who they are, which practitioner and appointment type, when they are coming in, whether they are new or returning, and how to reach them. The appointment appears in Halaxy and the caller hangs up knowing they have a time, rather than knowing somebody will get back to them.

What it covers

  • New patient enquiries, including which practitioner and appointment type they need
  • Bookings, reschedules and cancellations against your real availability
  • After-hours and weekend calls that would otherwise hit voicemail
  • Overflow when your front desk is already on a call or with someone at the counter
  • A structured message for anything that genuinely needs a person

Will it double book against our diary?

It should not, and this is the single most important thing to test before you go live. Because the agent is working against your real Halaxy availability rather than a side calendar, it is checking the same source of truth your front desk uses.

The case worth testing deliberately is two callers wanting the same slot within a minute of each other, plus a caller ringing at the exact moment somebody books the same time online. Ask any vendor how they handle that. A good answer describes what happens; a vague answer means it has not been thought about.

Do we have to change our phone number?

No. We use conditional call forwarding, so your existing number stays exactly where it is. Calls ring your practice as they always have, and only the ones that would have gone unanswered are forwarded to the agent. Nothing changes on your printed material, your Halaxy profile, or your Google listing. Porting the number to a unified platform is available later if you ever want it, but it is not a prerequisite.

What about patient information?

Allied health practices have real obligations under the Privacy Act and the Australian Privacy Principles, and a phone agent that captures patient details sits squarely inside them. Two things should be true before you go ahead. You should have it in writing what the agent captures, where that data is stored, and how long it is kept. And the technical access should be limited by a scoped API key rather than by trust alone.

The second is what makes the first enforceable. An agreement says what a vendor will do; a scoped key limits what they can do. Ask for both.

The agent should also be scoped to reception work only. Bookings, hours, location, and messages. Anything clinical goes to your practitioners. We hold that line deliberately, and it is not a limitation we are working around.

How does this compare to other practice systems?

It varies more than most people expect, which is why we publish the position for each system rather than a blanket claim about integrating with everything. Broadly, Australian practice software falls into three groups: systems that publish open developer documentation, systems that run an application-gated partner programme, and systems where integration happens through direct arrangements rather than public docs.

Halaxy is firmly in the first group, alongside Cliniko, coreplus and Nookal. That is good news if deep automation matters to you, and it is a genuine point in Halaxy's favour that does not get talked about much during a software sales process.

You can see where each system currently sits on the integrations page. If you are weighing up practice software as well as phone coverage, the difference is worth knowing about before you commit to either.

Where to start

Start with the calls you know you are losing. For most Halaxy practices that is after hours and the middle of a busy clinic day, and both are measurable in a way that makes the decision easy. You do not have to hand the whole phone line over on day one.

If you want to hear how it actually sounds before you talk to anyone, ring our number. It is answered by our own agent, which is the most honest demo we can offer. Otherwise, book a discovery call and we will scope what is realistic for your practice, including telling you if we think the case is weak.

Frequently asked questions

Does the Halaxy API let a third party create appointments?

Yes. The published API reference includes create, update and read endpoints for appointments, along with webhooks for real-time updates. That is what makes a genuine phone-to-diary booking possible rather than a message handoff.

Who pays for the Halaxy API subscription?

You do, directly to Halaxy. It is currently 150 credits per month with a 30 day free trial. Confirm the current figure with Halaxy, since pricing changes. Our build is scoped separately, and see [pricing](/pricing) for how we structure that.

Can we limit what the AI receptionist can access?

Yes, and you should. Halaxy's API Key Manager lets you generate a key scoped to specific data and revoke it at any time. Ask any vendor for the minimum access they need and grant only that.

Will it try to give clinical advice?

No. It should be scoped to reception work: booking, rescheduling, hours, location, and taking messages. Anything clinical goes to your practitioners. This is a deliberate boundary, not a technical limitation.

Can we start with after hours only?

Yes, and it is a sensible way in. Cover the calls you are definitely losing, see what comes back, then widen the hours once you trust it.

See it handle your kind of calls.

A 30-minute discovery call: we map where Elevate fits and send a tailored proposal within 48 hours.