Halaxy

Halaxy + Konnectify

Halaxy Integration with Konnectify

Connect Halaxy, a global practice management platform for health and wellness, with Konnectify to automate patient administration, appointment scheduling, billing, coverage, referrals, and clinical workflow processes.

Patients Practitioners & Organizations Appointments & Scheduling Billing & Coverage Referrals & Documents 15 Triggers 46 Actions

ON THIS PAGE

→ What is Halaxy? → API & authentication → How to connect → Triggers (15) → Actions (46) → Popular automations → FAQ

What is Halaxy?

Halaxy is a global practice management software platform used by health and wellness providers to manage patients, practitioners, appointments, schedules, billing, claims, referrals, and clinical documentation.

With Konnectify, teams can connect Halaxy to CRMs, finance tools, spreadsheets, notification platforms, and internal systems to reduce manual data entry and keep healthcare operations in sync.

New to Halaxy?

Explore Halaxy’s practice management tools for health and wellness businesses.

Visit Halaxy

New to Konnectify?

Build automated workflows across your healthcare, finance, support, and operations apps.

What you can automate

• Sync new or updated patient profiles to downstream systems

• Book and update appointments based on external events

• Retrieve practitioner, role, and organization data

• Generate schedules and appointment slots

• Track invoices, invoice lines, payments, and coverage records

• Create referrals and clinical document references

API & Authentication

Authentication method: OAuth 2.0 client credentials

The Halaxy connector uses the OAuth 2.0 client credentials flow. In Konnectify, you authenticate by entering the Client ID and Client Secret issued for your Halaxy API access. Konnectify exchanges these credentials for an access token using Halaxy’s token endpoint.

Token endpoint: https://au-api.halaxy.com/main/oauth/token

Supported API capabilities

Patient creation, updates, replacement, retrieval, and listing
Practitioner, practitioner role, and organization retrieval and creation
Appointment booking, updates, available appointment search, and listing
Schedule and slot management, including schedule slot generation
Healthcare service and charge item definition lookups
Coverage, invoice, invoice line, payment transaction, referral, and referral definition access
DocumentReference creation for clinical notes in a patient profile

Important: Halaxy API access, available modules, regional endpoints, and rate limits may vary by account, API agreement, and plan. Contact Halaxy support or your account administrator if you cannot generate API credentials or access a specific resource.

Before you start
When creating your app to get the Client ID and Client Secret, you'll be asked to add a Redirect URI. Make sure to add the URI below:
https://app.us.konnectifyapp.co/ipaas/api/oauth/callback

For detailed endpoint behavior and resource requirements, refer to the Halaxy help and API documentation.

How to Connect Halaxy to Konnectify

Prerequisites

An active Halaxy account with API access enabled
A Halaxy Client ID and Client Secret
Permission to access the required practice group and resources
An active Konnectify workspace

Add Halaxy to a Workflow

Open Konnectify and create or edit a workflow.
Search for Halaxy in the app selector.
Choose a Halaxy trigger or action as your workflow step.

Authorize via OAuth 2.0 client credentials

Click Connect or select an existing Halaxy connection.
Enter your Client ID and Client Secret.
Save the connection so Konnectify can securely request access tokens.

Configure the Trigger or Action

Map required fields such as patient IDs, appointment IDs, practitioner references, schedule references, or billing resource IDs.
Use outputs from earlier workflow steps to populate Halaxy fields dynamically.

Review destructive operations carefully. For example, Replace Patient replaces the entire record, and omitted properties may be removed.

Test the Workflow

Run a test using a safe patient, appointment, schedule, or billing record.
Confirm the returned FHIR resource data and mapped fields.
Check the target app or Halaxy record before activating automation.

Activate the Workflow

Turn the workflow on when testing is complete.
Monitor initial runs in Konnectify to validate data quality and API responses.

Triggers 15

Halaxy [Beta] includes 15 polling triggers. Konnectify checks Halaxy for newly created or modified records and starts workflows when matching changes are found.

Patients 1 trigger

New Or Updated Patient

This trigger fires whenever a Patient record is created or modified.

Practitioners & Organizations 3 triggers

New Or Updated Practitioner

This trigger fires whenever a Practitioner record is created or modified.

New Or Updated Practitioner Roles

This trigger fires whenever a PractitionerRole is created or modified.

New Or Updated Organization

This trigger fires whenever an Organization is created or modified.

Scheduling & Services 5 triggers

New Or Updated Appointments

This trigger fires whenever an Appointment record is created or modified.

New Or Updated Schedules

This trigger fires whenever a Schedule record is created or modified.

New Or Updated Slot

This trigger fires whenever a Schedule Slot (available time interval) is created or modified.

New Or Updated Health Services

This trigger fires whenever a HealthcareService (appointment type placeholder) is created or modified.

New Or Updated Charge Item Definition

This trigger fires whenever a ChargeItemDefinition (fee) is created or modified.

Billing & Coverage 4 triggers

New Or Updated Coverage

This trigger fires whenever a Coverage record (patient claim details) is created or modified.

New Or Updated Invoice

This trigger fires whenever an Invoice record is created or modified.

New Or Updated Invoice Lines

This trigger fires whenever an Invoice Line (fee) is added to an invoice or modified.

New Or Updated Transaction

This trigger fires whenever a Payment Transaction (payment, refund, or credit) is created or modified.

Referrals 2 triggers

New Or Updated Referrals

This trigger fires whenever a patient Referral record is created or modified.

New Or Updated Referral Definition

This trigger fires whenever a Referral Definition (referral template/type) is created or modified.

Actions 46

Use Halaxy actions to create, update, retrieve, search, and manage healthcare practice management resources from your Konnectify workflows.

Patients & Clinical Documents6 actions

Create Patient

Adds a new patient profile into your health practitioner practice management ecosystem.

Update Patient

Performs a partial update (PATCH) to fields such as name, telecom identifiers, addresses, or demographics on an existing patient graph.

Replace Patient

Replaces the entire patient record with provided data. Warning: Any existing properties that are not included in this request will be removed from the patient profile.

Get Patient

Fetches the full details of a specific patient profile from your Halaxy practice management system using the patient's ID.

List Patients

Fetches a FHIR Bundle of patient records matching the specified filter criteria and search parameters.

Create DocumentReference

Creates a new DocumentReference resource which represents a clinical note in a patient's Halaxy profile.

Practitioners, Roles & Organizations9 actions

Get Practitioner

Retrieves an individual practitioner or administrator record within a practice group using their unique ID.

List Practitioners

Retrieves a collection of practitioner and administrator records within a practice group filtered by criteria.

Create Practitioner

Creates a new external practitioner or professional contact profile within your group.

Get Practitioner Role

Retrieves an individual practitioner role (clinic ID or specific assignment detail) using their unique ID.

List Practitioner Roles

Retrieves a collection of practitioner clinic IDs within a practice group, filtered by criteria.

Create Practitioner Role

Creates a new professional contact identifier linked to their practice (links a Practitioner to an Organization).

Get Organization

Retrieves an individual organization such as a practice group, clinic location, funder, or professional contact's practice.

List Organizations

Retrieves a collection of organizations (clinics, groups, funders) in a practice group.

Create Organization

Creates a new organization record, typically used for adding a professional contact's external practice location.

Appointments & Availability5 actions

Create Appointment

Books a new appointment. This endpoint uses the $book operation to handle creation of linked invoices, clinical notes, and reminders.

Update Appointment

Performs a partial update (PATCH) to fields such as start time, description, or participants on an existing appointment.

Get Appointment

Retrieves an individual appointment using its ID.

Find Available Appointments

Generates a list of available appointments from Slot Resources based on practitioner's Online booking preferences, lead time, and buffer times.

List Appointments

Fetches a FHIR Bundle of scheduled or created appointment records matching your specified filter criteria.

Schedules & Slots6 actions

Create Schedule

Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.

Generate Schedule Slots

The $generate operation populates the Slots for a Schedule. It uses online booking preferences to ensure times adhere to buffer time, lead time and advance booking limits.

Get Schedule

Fetches the full details of a specific Schedule container (time-slots defined for appointments) using its ID.

List Schedules

Fetches a FHIR Bundle of practitioner schedules in a practice group matching your specified filter criteria.

Get Slot

Retrieves an individual slot resource (time interval available for booking appointments). These are effectively spaces of free/busy time.

List Slots

Fetches a FHIR Bundle of Slot resources representing free/busy time intervals available for booking appointments.

Healthcare Services & Fees4 actions

Get Healthcare Service

Retrieves an individual HealthcareService record (which in Halaxy refers to an appointment type placeholder).

List Healthcare Services

Fetches a FHIR Bundle of HealthcareService resources (appointment types) matching your specified filter criteria.

Get Charge Item Definition

Retrieves an individual fee (ChargeItemDefinition) from Halaxy using its unique identifier.

List Charge Item Definitions

Fetches a FHIR Bundle of ChargeItemDefinition resources (fees) matching your specified filter criteria.

Coverage4 actions

Create Coverage

Adds a new coverage record (e.g., Medicare card details, health fund details) for a specific patient.

Update Coverage

Performs a partial update (PATCH) to an existing coverage record. Currently, this endpoint only supports adding a new file attachment to the claim details.

Get Coverage

Fetches the full details of a specific Coverage claim using its ID.

List Coverage

Fetches a FHIR Bundle of patient coverage records matching your specified filter criteria.

Invoices & Payments6 actions

Get Invoice

Fetches the full details of a specific Invoice using its ID.

List Invoices

Fetches a FHIR Bundle of Invoice records matching your specified filter criteria.

Get Invoice Line

Fetches the full details of an individual invoice line (a fee added to an invoice) using its ID.

List Invoice Lines

Fetches a FHIR Bundle of InvoiceLine records matching your specified filter criteria.

Get Payment Transaction

Fetches the full details of a specific payment transaction (payment, refund, or credit) using its ID.

List Payment Transactions

Fetches a FHIR Bundle of PaymentTransaction resources matching your specified filter criteria.

Referrals6 actions

Get Referral

Fetches the full details of a specific Referral record by its ID.

Create Referral

Creates a new Referral record linked to a Patient and Coverage (claim) profile.

Update Referral

Performs a partial update (PATCH) to an existing Referral record. Note: Halaxy currently only supports adding a new file attachment to the referral with this endpoint.

List Referrals

Fetches a FHIR Bundle of referral records matching your specified filter criteria.

Get Referral Definition

Fetches the full details of a specific ReferralDefinition (referral type template) using its ID.

List Referral Definitions

Fetches a FHIR Bundle of ReferralDefinition records (referral types) configured for a practice group.

Popular Automations

Here are common ways teams use Halaxy with Konnectify.

Sync patient updates to your CRM or data warehouse

When patient profiles change in Halaxy, retrieve the latest patient details and update external records for reporting or follow-up workflows.

New Or Updated Patient→Get Patient→Update Patient

Automate online appointment booking

Find available appointment times, book a new appointment, and allow Halaxy’s booking operation to create linked invoices, notes, and reminders.

New Or Updated Slot→Find Available Appointments→Create Appointment

Track invoices and payments in finance tools

Start workflows when invoices, invoice lines, or payment transactions change and send billing data to accounting, dashboards, or spreadsheets.

New Or Updated Invoice→List Invoice Lines→List Payment Transactions

Create and enrich referral workflows

When claim coverage or referral records are updated, create new referrals, attach supporting documentation, or fetch referral templates.

New Or Updated Coverage→Create Referral→Create DocumentReference

FAQ

How does Halaxy authentication work in Konnectify?

Halaxy [Beta] uses OAuth 2.0 client credentials. You provide a Client ID and Client Secret in Konnectify, and Konnectify uses them to request access tokens from Halaxy’s token endpoint.

Which Halaxy plans are supported?

Support depends on whether your Halaxy account has API access enabled and permission to use the relevant resources. If you cannot create API credentials or receive permission errors, contact Halaxy support or your Halaxy account administrator.

Do Halaxy triggers use polling or webhooks?

The triggers in this connector are polling triggers. Konnectify periodically checks Halaxy for new or modified records such as patients, appointments, schedules, invoices, payments, and referrals.

How can I prevent duplicate patients, referrals, or appointments?

This connector does not include a native upsert action. To prevent duplicates, use List or Get actions to search for an existing resource before running Create actions, and store Halaxy IDs in your source system where possible.

How does Konnectify handle Halaxy rate limits?

If Halaxy returns rate limit or temporary API errors, Konnectify surfaces the error in workflow run history so you can retry or adjust workflow volume. Exact limits may depend on Halaxy’s API policy and your account access.

Can I connect multiple Halaxy accounts or practice groups?

Yes. You can create separate Halaxy connections in Konnectify using different Client IDs and Client Secrets, then select the appropriate connection for each workflow or workflow step.

What is special about Halaxy appointment booking actions?

The Create Appointment action uses Halaxy’s booking operation, which can handle linked outputs such as invoices, clinical notes, and reminders. You should map patients, practitioners, appointment types, and slots carefully to match your practice configuration.

Ready to automate your Halaxy workflows?

Connect Halaxy to Konnectify and streamline healthcare practice operations across your apps.

Get started free →