Who can do this?
-
Only account owners can purchase a Halaxy API subscription
-
Account owners can grant access for other users to the API Key Manager
-
Requires Halaxy credits
Halaxy API allows you to connect Halaxy with external software used in your practice, making it easier to seamlessly transfer data across your systems without double-handling.
With Halaxy API, you or your developer can securely retrieve and sync a wide range of information directly from Halaxy. You can also use the API to create records in your external system, which automatically create in Halaxy as well.
This level of integration enables you to:
-
Improve workflow efficiency
-
Reduce administrative workload
-
Ensure consistency in your records across platforms
-
Design a practice management workflow with tools that fit your needs.
This guide outlines what Halaxy API can do, and how to get and share access.
Halaxy API requires a monthly subscription and costs 150 credits per month. New subscribers enjoy a 30-day free trial and will be charged after the trial period ends.
Tip
The Halaxy API subscription also includes access to create webhooks to automate and update your external software systems in real time!
The Halaxy API is built according to the globally recognised Fast Healthcare Interoperability Resources (FHIR) standard, which enables Halaxy practices to seamlessly integrate and share health information across platforms.
FHIR is a global healthcare industry standard for passing healthcare data between systems. As the standard for medical APIs, FHIR has been adopted by governments worldwide and simplifies interoperability between Halaxy and global vendors, partners and third-party applications.
|
Data Type |
Retrieve |
Create |
Update |
|---|---|---|---|
|
Patients |
|
|
|
|
Claims |
|
|
|
|
Referrals |
|
|
|
|
Appointments |
Includes availability |
|
|
|
Professional Contacts |
|
|
|
|
Clinical Notes |
|
||
|
Appointment Types |
|
||
|
Fees |
|
||
|
Practitioners |
|
||
|
Invoices |
|
||
|
Payments |
|
||
|
Groups & Locations |
|
||
|
Organisations |
|
||
|
More to come! |
With the Halaxy API, you can perform the following functions with the following resources:
As a Halaxy API subscriber, you can generate your own API Keys and fully customise which resources each key can access and what actions they are allowed to perform.
Note
Halaxy API is built using FHIR standards for global compatibility and scale. Because of this, some terminology may differ between Halaxy (the software) and Halaxy API (which uses FHIR terminology). For example, what the Halaxy API refers to as DocumentReference is actually referred to in the Halaxy software as a clinical note. The Halaxy API Docs provides context and explanation for any instances where terminology may differ.
-
Click Settings > Add-ons.
-
Under Group Add-ons, click Add a Subscription.
-
In the pop-up, under Halaxy API, click Purchase Halaxy API.
-
Click Purchase.
You have successfully purchased a Halaxy API subscription. You can now create an API key using the API Key Manager.
You can cancel your subscription anytime.
Tip
Ready to connect to the Halaxy API? Our Halaxy API Docs have helpful resources to guide you with connecting and querying your Halaxy data to your external application. Our docs include API reference, schema tables, query guides, error explanations - even recipes with payload templates!
The API Key Manager lets you generate unique API keys with custom access to specific data types, allowing you to securely control and manage who has access to your practice data.
-
Click Settings > Integrations, then at the top, click the External tab.
-
On the top right, click Create New Key.
-
In the pop-up, configure the following:
-
Name: Enter a name for this key.
-
Key Access: Enable the toggle switches for the resource and the functions you want this key to have access to. (For example: if this key is only for gathering Halaxy data to create financial reports on an external application, you may want to enable only the Retrieve functions for the Invoices & Payments, Patients and Practitioners resources.)
-
-
Click Save.
You have successfully created an API key.
IMPORTANT: Your Client Secret will not be shown again. Copy the Client ID and Client Secret before you close the confirmation pop-up. You can enter these credentials in your external application or provide them to your trusted developer.
Caution
Protect your API keys! Your API keys provide access to sensitive patient, financial and other confidential data in your practice. Avoid sharing them publicly or with untrusted parties.
If you want someone else in your practice group to manage your API keys, you can enable their access to the API Key Manager.
-
Click Settings > Users.
-
In the list, next to the user's name, click the
pencil icon to open their access settings.
-
Tick the API Key Manager checkbox.
-
Click Save.
This user now has access to the API Key Manager and can now also create, edit and delete API keys. Make sure this user is someone you trust.
Caution
Anyone in your practice with an API key will have access to records enabled in their API key, regardless of their Halaxy access level.
Updated