Halaxy Integration

Integrate Halaxy with Everbility to streamline your workflow and save time.

Before you begin

Before you begin, make sure:

1. Your Halaxy account is fully verified.
2. You have the API Key Manager permission in Halaxy.
3. You have Halaxy credits or a credit pack to cover the API subscription fee.

If you work on your own, you can connect your own Halaxy key in Everbility.

If you use Everbility as part of an organisation, your organisation admin can create one shared Halaxy connection for the whole team. If you have not set up an organisation yet, start with the Manage an Organisation guide.

Step 1: Verify Your Halaxy Account

Note: If your profile already says "Verified" or "Enabled", skip to Step 2.

Follow the Halaxy documentation to verify your account. The options to create an API key will not be provided in the Halaxy application until this is done. If you have questions regarding Halaxy verification, consult the Halaxy documentation or contact Halaxy for support.

Step 2: Create a Halaxy API key

Access to the API is an "Add-on" feature that must be activated.

1. Log in to Halaxy.
2. Go to Settings > Integrations.
3. Click on the EXTERNAL tab just below the title bar.
4. Click CREATE NEW KEY on the end of the tab bar.
5. Fill in the form. The suggested name is Everbility.
6. Select the following permissions: Patients, Practitioners, Appointments and Clinical Notes.
7. Copy the Client ID and Client Secret.

Step 3: Add the key in Everbility

1. In Everbility, go to Manage account.
2. Click Integrations.
3. Open the Halaxy integration.
4. Paste the Halaxy Client ID into the API Client ID field.
5. Paste the Halaxy Client Secret into the API key field.
6. Select your Halaxy region.
7. If your practice is based in Europe or the UK, choose the Europe or UK region. Otherwise, choose Default.
8. If you are an organisation admin and want your team to use the same connection, turn on Share with other members of [your organisation].
9. Click Save API Key.

Step 4: Connect other team members to the shared key

If your organisation admin has shared the Halaxy key, other team members do not need to create their own Halaxy API keys.

Each team member should:

1. Go to Manage account in Everbility.
2. Click Integrations.
3. Open Halaxy.
4. Click Connect in the Connect using organisation key section.

Once connected, they can use the shared Halaxy connection in their own Everbility account.

What you can do after connecting

Once Halaxy is connected, you can:

• view upcoming Halaxy appointments in Everbility
• start a note or transcription from an appointment
• push documents generated in Everbility back to Halaxy