Halaxy

Halaxy is a global health platform built for both practitioners and patients, providing free practice management software including online bookings, clinical notes, invoicing and payments, telehealth and patient records for allied health and medical practices in Australia, New Zealand, the UK, Ireland, Canada, Singapore and other countries. Its developer portal at developers.halaxy.com documents the Halaxy API, a FHIR R4-based REST API (OAuth-secured, with AU and EU production hosts) covering resources such as Patient, Appointment, Practitioner, Schedule, Slot, Invoice and Coverage, plus webhooks.

Halaxy publishes 18 API contracts indexed on the APIs.io network, including Appointment API, Charge Item Definition API, Coverage API, and 15 more. Tagged areas include Company, Healthcare, Practice Management, FHIR, and Telehealth.

The Halaxy catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

Halaxy’s developer surface includes changelog, authentication, documentation, API reference, support, engineering blog, pricing, and 36 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

56.5/100 strong ▼ -10.8 Agent 37/100 agent ready Heartbeat 70/100 slowing Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessFreemiumSelf serve⚡ Free to try

1 published contract 5 Agent Skills

Company Healthcare Practice Management FHIR Telehealth Appointments Billing Patients

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 56.5/100 · strong

Contract Quality 13.0 / 19

Developer Ergonomics 3.7 / 15

Access Clarity 9.9 / 15

Operational Transparency 5.0 / 10

Contract Governance 3.2 / 9

Discoverability 5.5 / 8

Regulatory Posture 5.4 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 37/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 4 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Health regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/halaxy/"><img src="https://apis.io/badge/halaxy/card.svg" alt="Halaxy on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
Documented Reversibility +6 pts — a reversal operation in the contract, graded up when a window is documented too

4 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Developer Ergonomics scores 24.4 — up to +15.1 composite points
Contract Quality scores 69.1 — up to +7.7 composite points
Contract Governance scores 35.6 — up to +7.7 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/halaxy/apis.yml: open an issue on github.com/api-evangelist/halaxy to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
FHIR Implementation Guides (HL7 FHIR package and IG publishers)	list	13.7	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 3

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

HL7 FHIR

tagged — the provider's own APIs.json carries the standard as a tag; implementation not verified

OpenAPI

measured — observed by APIs.io (published)

OAuth 2.0

measured — observed by APIs.io (declared)

APIs 18

Individual APIs this provider publishes, each with its own machine-readable definition.

Halaxy Appointment API

The Appointment API from Halaxy — 4 operation(s) for appointment.

Halaxy Charge Item Definition API

The ChargeItemDefinition API from Halaxy — 2 operation(s) for chargeitemdefinition.

Halaxy Coverage API

The Coverage API from Halaxy — 2 operation(s) for coverage.

Halaxy Invoice API

The Invoice API from Halaxy — 2 operation(s) for invoice.

Halaxy Invoice Line API

The InvoiceLine API from Halaxy — 2 operation(s) for invoiceline.

Halaxy Organization API

The Organization API from Halaxy — 2 operation(s) for organization.

Halaxy Patient API

The Patient API from Halaxy — 3 operation(s) for patient.

Halaxy Payment Transaction API

The PaymentTransaction API from Halaxy — 2 operation(s) for paymenttransaction.

Halaxy Practitioner API

The Practitioner API from Halaxy — 2 operation(s) for practitioner.

Halaxy Referral API

The Referral API from Halaxy — 2 operation(s) for referral.

Halaxy Referral Definition API

The ReferralDefinition API from Halaxy — 2 operation(s) for referraldefinition.

Halaxy Schedule API

The Schedule API from Halaxy — 3 operation(s) for schedule.

Halaxy Slot API

The Slot API from Halaxy — 2 operation(s) for slot.

Halaxy Capability Statement API

The Capability Statement API from Halaxy — 1 operation(s) for capability statement.

Halaxy Document Reference API

The Document Reference API from Halaxy — 1 operation(s) for document reference.

Halaxy Healthcare Service API

The Healthcare Service API from Halaxy — 2 operation(s) for healthcare service.

Halaxy Practitioner Role API

The Practitioner Role API from Halaxy — 2 operation(s) for practitioner role.

Halaxy Search Parameter API

The Search Parameter API from Halaxy — 1 operation(s) for search parameter.

Scroll for all 18

Agent Skills 5

Packaged agent skills for driving this provider's APIs from an AI assistant.

halaxy-book-an-appointment

AGENT SKILL

halaxy-create-a-referral

AGENT SKILL

halaxy-publish-schedule-slots

AGENT SKILL

halaxy-reconcile-invoices-and-payments

AGENT SKILL

halaxy-register-and-update-a-patient

AGENT SKILL

Halaxy API pricing

Prices published by Halaxy.

Plan	Price
Halaxy's core platform	Halaxy's core platform - completely free
Payment Processing	1.5% to 1.9% per transaction plus a 75c to $1 fee for Silver and Bronze bands.
Pay as you go credits	AUD $0.15 - $0.22 per credit including GST
Subscription features	25 credits per month

Plan details, limits and sources →

Rate limits

OAuth-authenticated requests: All requests authenticated with OAuth are rate-limited to **500 requests per minute**

Rate-limit details →

Pricing Plans 1

Published pricing tiers and plan structures.

Halaxy Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Halaxy Rate Limits

1 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

Halaxy

SLA

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Halaxy Context

120 classes · 186 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs. Counts are the severity each rule declares, not results of running them.

Halaxy API Rules

18 rules · 14 error-severity 3 warn-severity 1 info-severity

SPECTRAL

OpenAPI Overlays 1

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Halaxy Api Overlay

5 actions · documentation · halaxy-api-openapi.yml

DERIVED

JSON Schema 6

Standalone JSON Schema definitions for this provider's data models.

CapabilityStatement.jsonfhir

26 properties

JSON SCHEMA

CapabilityStatement

26 properties

JSON SCHEMA

Referral.jsonfhir

20 properties

JSON SCHEMA

Referral

20 properties

JSON SCHEMA

SearchParameter.jsonfhir

28 properties

JSON SCHEMA

SearchParameter

28 properties

JSON SCHEMA

Examples 1

Example request and response payloads for these APIs.

Halaxy Fhir Capabilitystatement

17 fields

EXAMPLE

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Halaxy Authentication

oauth2 · 1 scheme

SECURITY

Halaxy Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Halaxy Vulnerability Disclosure

security.txt · contact published

SECURITY

Halaxy Trust Center

ISO 27001

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Halaxy Scopes

OAuth 2.0 · no documented scopes

0 scopes

SCOPES

Agentic Access (API Evangelist recommendations) 1

Recommended x-agentic-access execution contracts for AI agents.

Halaxy Agentic Access

49 operations · 15 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal

DeveloperPortal

SignUp

SignUp

Login

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgentSkill

LLMsTxt

WellKnown

Design & Contract 8

Pagination, idempotency, versioning, errors, and events

Spectral

JSONLD

Vocabulary

DataModel

Conventions

Lifecycle

ErrorCatalog

Conformance

Scroll for all 8

Build 1

SDKs, sample code, and the tooling you integrate with

IntegrationEdges

IntegrationEdges

Access & Security 7

Authentication, authorization, and security posture

Compliance

Security

SecurityTxt

Authentication

TrustCenter

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Scroll for all 7

Learn 1

Tutorials, courses, talks, and written guidance

Recipes

Recipes

Operate 5

Status, limits, changes, and where to get help

RateLimits

ChangeLog

Deprecation

Support

ChangeLog

Commercial 4

Pricing, plans, and the legal terms of use

Plans

Pricing

TermsOfService

PrivacyPolicy

Company 4

The organization behind the API

Website

Website

Blog

Blog

AboutUs

AboutUs

LinkedIn

Other 4

Properties that don't map to a standard resource type

Overlay

Overlay

Hosts

Hosts

Vendors

Vendors

Email

Source (apis.yml)

aid: halaxy
name: Halaxy
description: Halaxy is a global health platform built for both practitioners and patients, providing free practice management
  software including online bookings, clinical notes, invoicing and payments, telehealth and patient records for allied health
  and medical practices in Australia, New Zealand, the UK, Ireland, Canada, Singapore and other countries. Its developer portal
  at developers.halaxy.com documents the Halaxy API, a FHIR R4-based REST API (OAuth-secured, with AU and EU production hosts)
  covering resources such as Patient, Appointment, Practitioner, Schedule, Slot, Invoice and Coverage, plus webhooks.
url: https://raw.githubusercontent.com/api-evangelist/halaxy/refs/heads/main/apis.yml
x-type: company
x-source: harvest:australia-apidays-2026
x-tier: profiled
x-tier-reason: enrichment pass 2026-10-22 (modular-v1; was harvest)
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: high
  probe_state: covered
  source:
  - plans
  - authentication
  - rate-limits
  - security
  generated: '2026-11-06'
  method: derived
specificationVersion: '0.20'
created: '2026-10-22'
modified: '2026-10-22'
tags:
- Company
- Healthcare
- Practice Management
- FHIR
- Telehealth
- Appointments
- Billing
- Patients
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
image: https://files.readme.io/8dfcf90955338f72c92553c41e4bf930d700d518db32bffdab5ba77c44b3656a-logo.png
common:
- type: AgenticAccess
  url: agentic-access/halaxy-agentic-access.yml
- type: RateLimits
  url: rate-limits/halaxy-rate-limits.yml
- type: Plans
  url: plans/halaxy-plans-pricing.yml
- type: Spectral
  url: rules/halaxy-rules.yml
- type: JSONLD
  url: json-ld/halaxy-context.jsonld
- type: Vocabulary
  url: vocabulary/halaxy-vocabulary.yml
- type: AgentSkill
  url: skills/_index.yml
- type: DataModel
  url: data-model/halaxy-data-model.yml
- type: ChangeLog
  url: changelog/halaxy-changelog.yml
- type: Conventions
  url: conventions/halaxy-conventions.yml
- type: Compliance
  url: https://trust.halaxy.com/
- type: Security
  url: security/halaxy-vulnerability-disclosure.yml
- type: Deprecation
  url: lifecycle/halaxy-lifecycle.yml
- type: Lifecycle
  url: lifecycle/halaxy-lifecycle.yml
- type: ErrorCatalog
  url: errors/halaxy-problem-types.yml
- type: Conformance
  url: conformance/halaxy-conformance.yml
- type: Overlay
  url: overlays/halaxy-api-overlay.yaml
- type: LLMsTxt
  url: llms/halaxy-llms.txt
- type: SecurityTxt
  url: well-known/halaxy-security.txt
- type: WellKnown
  url: well-known/halaxy-well-known.yml
- type: Hosts
  url: hosts/halaxy-hosts.yml
- type: IntegrationEdges
  url: integrations/halaxy-integration-edges.yml
- type: Vendors
  url: vendors/halaxy-vendors.yml
- type: Authentication
  url: authentication/halaxy-authentication.yml
- type: Website
  url: https://www.halaxy.com/
- type: DeveloperPortal
  url: https://developers.halaxy.com/
- type: Documentation
  url: https://developers.halaxy.com/docs/about-this-guide
- type: APIReference
  url: https://developers.halaxy.com/reference/patient
- type: Recipes
  url: https://developers.halaxy.com/recipes
- type: Support
  url: https://support.halaxy.com/hc/en-au
- type: Blog
  url: https://blog.halaxy.com/
- type: ChangeLog
  url: https://blog.halaxy.com/tag/whats-new/
- type: Pricing
  url: https://www.halaxy.com/pricing
- type: SignUp
  url: https://www.halaxy.com/a/signup
- type: Login
  url: https://www.halaxy.com/a/login
- type: TermsOfService
  url: https://www.halaxy.com/terms/practitioner/
- type: PrivacyPolicy
  url: https://www.halaxy.com/privacy/
- type: AboutUs
  url: https://www.halaxy.com/article/about-us
- type: LinkedIn
  url: https://www.linkedin.com/company/halaxy
- type: Email
  url: mailto:community@halaxy.com
- type: TrustCenter
  url: security/halaxy-trust-center.yml
- type: VulnerabilityDisclosure
  url: security/halaxy-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/halaxy-domain-security.yml
apis:
- aid: halaxy:halaxy-appointment-api
  name: Halaxy Appointment API
  description: The Appointment API from Halaxy — 4 operation(s) for appointment.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Appointment
  properties:
  - type: OpenAPI
    url: openapi/halaxy-appointment-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-chargeitemdefinition-api
  name: Halaxy Charge Item Definition API
  description: The ChargeItemDefinition API from Halaxy — 2 operation(s) for chargeitemdefinition.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - ChargeItemDefinition
  properties:
  - type: OpenAPI
    url: openapi/halaxy-chargeitemdefinition-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-coverage-api
  name: Halaxy Coverage API
  description: The Coverage API from Halaxy — 2 operation(s) for coverage.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Coverage
  properties:
  - type: OpenAPI
    url: openapi/halaxy-coverage-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-invoice-api
  name: Halaxy Invoice API
  description: The Invoice API from Halaxy — 2 operation(s) for invoice.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Invoices
  tags_raw:
  - Invoice
  properties:
  - type: OpenAPI
    url: openapi/halaxy-invoice-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-invoiceline-api
  name: Halaxy Invoice Line API
  description: The InvoiceLine API from Halaxy — 2 operation(s) for invoiceline.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - InvoiceLine
  properties:
  - type: OpenAPI
    url: openapi/halaxy-invoiceline-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-organization-api
  name: Halaxy Organization API
  description: The Organization API from Halaxy — 2 operation(s) for organization.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Organization
  properties:
  - type: OpenAPI
    url: openapi/halaxy-organization-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-patient-api
  name: Halaxy Patient API
  description: The Patient API from Halaxy — 3 operation(s) for patient.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Patients
  tags_raw:
  - Patient
  properties:
  - type: OpenAPI
    url: openapi/halaxy-patient-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-paymenttransaction-api
  name: Halaxy Payment Transaction API
  description: The PaymentTransaction API from Halaxy — 2 operation(s) for paymenttransaction.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Payment Transaction
  tags_raw:
  - PaymentTransaction
  properties:
  - type: OpenAPI
    url: openapi/halaxy-paymenttransaction-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-practitioner-api
  name: Halaxy Practitioner API
  description: The Practitioner API from Halaxy — 2 operation(s) for practitioner.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Practitioner
  properties:
  - type: OpenAPI
    url: openapi/halaxy-practitioner-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-referral-api
  name: Halaxy Referral API
  description: The Referral API from Halaxy — 2 operation(s) for referral.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Referrals
  tags_raw:
  - Referral
  properties:
  - type: OpenAPI
    url: openapi/halaxy-referral-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-referraldefinition-api
  name: Halaxy Referral Definition API
  description: The ReferralDefinition API from Halaxy — 2 operation(s) for referraldefinition.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - ReferralDefinition
  properties:
  - type: OpenAPI
    url: openapi/halaxy-referraldefinition-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-schedule-api
  name: Halaxy Schedule API
  description: The Schedule API from Halaxy — 3 operation(s) for schedule.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Schedule
  properties:
  - type: OpenAPI
    url: openapi/halaxy-schedule-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-slot-api
  name: Halaxy Slot API
  description: The Slot API from Halaxy — 2 operation(s) for slot.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Slot
  properties:
  - type: OpenAPI
    url: openapi/halaxy-slot-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-capability-statement-api
  name: Halaxy Capability Statement API
  description: The Capability Statement API from Halaxy — 1 operation(s) for capability statement.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - CapabilityStatement
  tags_raw:
  - Capability Statement
  properties:
  - type: OpenAPI
    url: openapi/halaxy-capability-statement-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-document-reference-api
  name: Halaxy Document Reference API
  description: The Document Reference API from Halaxy — 1 operation(s) for document reference.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - DocumentReference
  tags_raw:
  - Document Reference
  properties:
  - type: OpenAPI
    url: openapi/halaxy-document-reference-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-healthcare-service-api
  name: Halaxy Healthcare Service API
  description: The Healthcare Service API from Halaxy — 2 operation(s) for healthcare service.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - HealthcareService
  tags_raw:
  - Healthcare Service
  properties:
  - type: OpenAPI
    url: openapi/halaxy-healthcare-service-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-practitioner-role-api
  name: Halaxy Practitioner Role API
  description: The Practitioner Role API from Halaxy — 2 operation(s) for practitioner role.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - PractitionerRole
  tags_raw:
  - Practitioner Role
  properties:
  - type: OpenAPI
    url: openapi/halaxy-practitioner-role-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
- aid: halaxy:halaxy-search-parameter-api
  name: Halaxy Search Parameter API
  description: The Search Parameter API from Halaxy — 1 operation(s) for search parameter.
  humanURL: https://developers.halaxy.com/
  baseURL: https://au-api.halaxy.com
  tags:
  - Search Parameter
  properties:
  - type: OpenAPI
    url: openapi/halaxy-search-parameter-api-openapi.yml
  - type: Documentation
    url: https://developers.halaxy.com/docs/about-this-guide
  - type: APIReference
    url: https://developers.halaxy.com/reference/patient
  - type: Authentication
    url: https://developers.halaxy.com/docs/authentication
  - type: Webhooks
    url: https://developers.halaxy.com/docs/webhooks
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-search-parameter-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-capability-statement-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-jsonfhir-schema.json
  - type: JSONSchema
    url: json-schema/halaxy-referral-schema.json
x-coverage:
  state: covered
  reason: identity-verified
  detail: 'Website, developer portal (ReadMe) and policy pages verified by GET with a browser UA on 2026-10-22; support.halaxy.com
    answered a Cloudflare challenge (403) to our crawler but was 200 in pre-flight. github.com/halaxy not recorded: org page
    does not link to halaxy.com, ownership unconfirmed.'
  evidence:
  - url: https://www.halaxy.com/
    status: 200
  - url: https://developers.halaxy.com/
    status: 200
  - url: https://www.halaxy.com/pricing
    status: 200
  - url: https://www.halaxy.com/privacy/
    status: 200
  - url: https://www.halaxy.com/terms/practitioner/
    status: 200
  - url: https://blog.halaxy.com/
    status: 200
  - url: https://support.halaxy.com/hc/en-au
    status: 403
x-enrichment:
  date: '2026-10-22'
  status: enriched
  artifacts_added: 44
  pass: modular-v1
  engine: identity=anthropic,contract=anthropic,surfaces=anthropic,docs=anthropic,regulatory=anthropic

Halaxy API — frequently asked questions

Does Halaxy have an API?

Yes. APIs.io lists 18 APIs from Halaxy, including Halaxy Appointment API, Halaxy Charge Item Definition API and Halaxy Coverage API, and 15 more.

Is there an OpenAPI specification for the Halaxy API?

Yes. APIs.io indexes 18 OpenAPI specifications for Halaxy, each linked for download from this page.

How do I authenticate with the Halaxy API?

Halaxy documents its authentication (oauth2 · 1 scheme). The details are profiled on APIs.io as Halaxy Authentication.

How much does the Halaxy API cost?

Halaxy publishes its prices; its Halaxy's core platform plan is Halaxy's core platform - completely free as of 2026-10-22. APIs.io lists 4 pricing plans for Halaxy, with each plan's price, limits and inclusions under Pricing on this page.

Is the Halaxy API ready for AI agents?

Halaxy has a Kin Score of 56.5 out of 100 (strong) and an Agent Readiness score of 37.1 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/halaxy"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/halaxy/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/halaxy/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.