Halo Connect

Halo Connect is an Australian healthcare interoperability platform, founded in 2021 and headquartered in Brisbane, Queensland, that makes primary-care data integration simple by exposing on-premise practice management system (PMS) databases through a modern cloud API. Its Halo Link agent and Halo Cloud service let approved software integrators query systems such as Best Practice, Zedmed, and Dental4Windows using either SQL passthrough or a standards-based FHIR R4 (4.0.1) API built toward the AU Base 4.1.0 implementation guide, without maintaining a separate database agent per integration. Halo Connect built the first FHIR API for the Best Practice Premier medical-practice industry. The platform runs on Microsoft Azure hosted in Australia, and access is gated behind a Halo Cloud subscription using Azure API Management subscription keys and, for desktop applications, bearer JWT tokens issued from a token endpoint; there is no self-serve public API.

Halo Connect publishes 5 API contracts indexed on the APIs.io network, including FHIR API, Registered Queries API, Sites API, and 2 more. Tagged areas include Healthcare, Australia, FHIR, HL7, and Interoperability.

The Halo Connect catalog on APIs.io includes 1 event-driven AsyncAPI specification and 1 Spectral governance ruleset.

Halo Connect’s developer surface includes authentication, documentation, API reference, getting-started guide, engineering blog, changelog, sandbox, and 27 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

55.4/100 strong ▬ flat Agent 28/100 agent aware Front door AI 1/6 silent Heartbeat 0/100 dormant saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

2 published contracts 4 Agent Skills

Healthcare Australia FHIR HL7 Interoperability Electronic Health Records Practice Management Primary CareAU BaseHealth Data

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Health Information Management

BC-2900

FHIR

GET /integrator/sites/{siteId}/fhir/R4/{fhirParameters}

Kin Score

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

Composite quality — 55.4/100 · strong

Contract Quality 11.2 / 19

Developer Ergonomics 9.9 / 15

Access Clarity 5.5 / 15

Operational Transparency 4.9 / 10

Contract Governance 2.9 / 9

Discoverability 5.5 / 8

Regulatory Posture 4.8 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 28/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 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 0 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 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 0 / 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/halo-connect/"><img src="https://apis.io/badge/halo-connect/card.svg" alt="Halo Connect 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
Rate-Limit Signaling +7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented)
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)

6 more unmet checks in the Agent Readiness table above.

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

Access Clarity scores 36.8 — up to +12.6 composite points
Contract Quality scores 59.8 — up to +10.1 composite points
Contract Governance scores 31.8 — up to +8.2 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/halo-connect/apis.yml: open an issue on github.com/api-evangelist/halo-connect 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
Medical Technology (certified health IT, FDA-authorized AI devices)	undeclared	-	-	-

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 2

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)

APIs 5

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

Halo Connect FHIR API

Query practice data using FHIR resources.

Halo Connect Registered Queries API

The Registered Queries API from Halo Connect — 6 operation(s) for registered queries.

Halo Connect Sites API

Endpoints for practice onboarding and site metadata.

Halo Connect SQL Passthrough API

Send SQL queries to practices as immediate, async or registered queries. **Immediate queries** are small, time-sensitive queries that return a result in seconds. Response size i...

Halo Connect Tokens API

Obtain authorization tokens for desktop applications to authenticate API requests.

Open Collections 2

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Halo Cloud API for Desktop Applications

OPEN COLLECTION

Halo Cloud API for Integrators

OPEN COLLECTION

Agent Skills 4

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

Submit an async query and collect results

AGENT SKILL

Search primary-care data with the FHIR R4 API

AGENT SKILL

Pair a site and run an immediate query

AGENT SKILL

Manage registered (recurring) queries

AGENT SKILL

Service Levels 1

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

Halo Connect

SLA

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Halo Connect Webhooks

Halo Cloud delivers HTTPS POST webhook notifications when an async or a registered query completes. The payload does NOT include the query result; the integrator retrieves resul...

ASYNCAPI

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Halo Connect API Rules

63 rules · 52 errors 7 warnings 4 info

SPECTRAL

OpenAPI Overlays 2

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.

Halo Connect Desktop Overlay

1 action · update · halo-connect-desktop-openapi.json

DERIVED

Halo Connect Integrator Overlay

2 actions · update · halo-connect-integrator-openapi.json

DERIVED

Security Posture 4

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

Halo Connect Authentication

apiKey/http · 3 schemes

SECURITY

Halo Connect Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Halo Connect Vulnerability Disclosure

contact published

SECURITY

Halo Connect Trust Center

CyberCert SMB1001-2023 Level 3 (Gold), ISO 27001 (policies/procedures align to principles; not stated as certified)

SECURITY

Agentic Access 1

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

Halo Connect Agentic Access

29 operations · 11 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal

DeveloperPortal

GettingStarted

GettingStarted

Sandbox

Sandbox

Documentation 3

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

AsyncAPI

AsyncAPI

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

X-MCPServerCandidate

LLMsTxt

AgentSkill

WellKnown

Design & Contract 6

Pagination, idempotency, versioning, errors, and events

Lifecycle

ErrorCatalog

Conventions

Conformance

Webhooks

DataModel

Access & Security 6

Authentication, authorization, and security posture

DomainSecurity

Authentication

TrustCenter

Compliance

VulnerabilityDisclosure

VulnerabilityDisclosure

Security

Security

Operate 4

Status, limits, changes, and where to get help

StatusPage

ChangeLog

Deprecation

Support

Commercial 2

Pricing, plans, and the legal terms of use

TermsOfService

TermsOfService

PrivacyPolicy

PrivacyPolicy

Company 2

The organization behind the API

Website

Website

Blog

Blog

Other 3

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Overlay

Overlay

Overlay

Overlay

Source (apis.yml)

aid: halo-connect
url: https://raw.githubusercontent.com/api-evangelist/halo-connect/refs/heads/main/apis.yml
name: Halo Connect
kind: company
description: Halo Connect is an Australian healthcare interoperability platform, founded in 2021 and headquartered in Brisbane,
  Queensland, that makes primary-care data integration simple by exposing on-premise practice management system (PMS) databases
  through a modern cloud API. Its Halo Link agent and Halo Cloud service let approved software integrators query systems such
  as Best Practice, Zedmed, and Dental4Windows using either SQL passthrough or a standards-based FHIR R4 (4.0.1) API built
  toward the AU Base 4.1.0 implementation guide, without maintaining a separate database agent per integration. Halo Connect
  built the first FHIR API for the Best Practice Premier medical-practice industry. The platform runs on Microsoft Azure hosted
  in Australia, and access is gated behind a Halo Cloud subscription using Azure API Management subscription keys and, for
  desktop applications, bearer JWT tokens issued from a token endpoint; there is no self-serve public API.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - security
  - sandbox
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
x-docs-platform: mkdocs
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-03
tags:
- Healthcare
- Australia
- FHIR
- HL7
- Interoperability
- Electronic Health Records
- Practice Management
- Primary Care
- AU Base
- Health Data
tags_raw:
- Healthcare
- Australia
- FHIR
- HL7
- Interoperability
- EHR
- Practice Management
- Primary Care
- AU Base
- Health Data
created: '2026-07-24'
modified: '2026-07-24'
specificationVersion: '0.23'
apis:
- aid: halo-connect:halo-connect-fhir-api
  name: Halo Connect FHIR API
  description: Query practice data using FHIR resources.
  humanURL: https://docs.haloconnect.io/halo-cloud/overview/
  baseURL: https://api.haloconnect.io
  tags:
  - FHIR
  properties:
  - type: OpenAPI
    url: openapi/halo-connect-fhir-api-openapi.yml
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/desktop-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/overview/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/capabilities/
- aid: halo-connect:halo-connect-registered-queries-api
  name: Halo Connect Registered Queries API
  description: The Registered Queries API from Halo Connect — 6 operation(s) for registered queries.
  humanURL: https://docs.haloconnect.io/halo-cloud/overview/
  baseURL: https://api.haloconnect.io
  tags:
  - Registered Queries
  properties:
  - type: OpenAPI
    url: openapi/halo-connect-registered-queries-api-openapi.yml
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/desktop-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/overview/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/capabilities/
- aid: halo-connect:halo-connect-sites-api
  name: Halo Connect Sites API
  description: Endpoints for practice onboarding and site metadata.
  humanURL: https://docs.haloconnect.io/halo-cloud/overview/
  baseURL: https://api.haloconnect.io
  tags:
  - Sites
  properties:
  - type: OpenAPI
    url: openapi/halo-connect-sites-api-openapi.yml
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/desktop-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/overview/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/capabilities/
- aid: halo-connect:halo-connect-sql-passthrough-api
  name: Halo Connect SQL Passthrough API
  description: "Send SQL queries to practices as immediate, async or registered queries.\n\n**Immediate queries** are small,\
    \ time-sensitive queries that return a result in seconds. Response size is limited to 8MB.\n\n**Async queries** are queued\
    \ for execution and results can be retrieved later. The workflow is:\n\n  1. **Submit async query** – Creates a query\
    \ and returns a `queryId` on success.\n  2. **Get query status** – Check query status. When complete, includes pagination\
    \ details.\n  3. **Get query result page** – Retrieve result pages using the pagination info from the status response.\n\
    \n**Registered Queries** are also supported. See the [Registered Queries](#tag/Registered-Queries) section for more information."
  humanURL: https://docs.haloconnect.io/halo-cloud/overview/
  baseURL: https://api.haloconnect.io
  tags:
  - SQL Passthrough
  properties:
  - type: OpenAPI
    url: openapi/halo-connect-sql-passthrough-api-openapi.yml
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/desktop-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/overview/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/capabilities/
- aid: halo-connect:halo-connect-tokens-api
  name: Halo Connect Tokens API
  description: Obtain authorization tokens for desktop applications to authenticate API requests.
  humanURL: https://docs.haloconnect.io/halo-cloud/overview/
  baseURL: https://api.haloconnect.io
  tags:
  - Tokens
  properties:
  - type: OpenAPI
    url: openapi/halo-connect-tokens-api-openapi.yml
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/desktop-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/overview/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/capabilities/
common:
- type: CapabilityMap
  url: capabilities/halo-connect-capability-edges.yml
  name: Halo Connect Business Capability Map
- type: AgenticAccess
  url: agentic-access/halo-connect-agentic-access.yml
- type: DomainSecurity
  url: security/halo-connect-domain-security.yml
- type: Authentication
  url: authentication/halo-connect-authentication.yml
- type: Website
  url: https://haloconnect.io/
- type: DeveloperPortal
  url: https://docs.haloconnect.io/
- type: Documentation
  url: https://docs.haloconnect.io/
- type: APIReference
  url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
- type: GettingStarted
  url: https://docs.haloconnect.io/halo-cloud/getting-started/
- type: StatusPage
  url: https://status.haloconnect.io/
- type: TrustCenter
  url: https://haloconnect.io/trust
- type: Blog
  url: https://haloconnect.io/blog
- type: ChangeLog
  url: changelog/halo-connect-changelog.yml
- type: Lifecycle
  url: lifecycle/halo-connect-lifecycle.yml
- type: Deprecation
  url: https://haloconnect.io/sla
- type: ErrorCatalog
  url: errors/halo-connect-error-codes.yml
- type: Conventions
  url: conventions/halo-connect-conventions.yml
- type: Sandbox
  url: sandbox/halo-connect-sandbox.yml
- type: Conformance
  url: conformance/halo-connect-conformance.yml
- type: Compliance
  url: https://haloconnect.io/trust
- type: AsyncAPI
  url: asyncapi/halo-connect-webhooks-asyncapi.yml
- type: Webhooks
  url: asyncapi/halo-connect-webhooks-asyncapi.yml
- type: VulnerabilityDisclosure
  url: security/halo-connect-vulnerability-disclosure.yml
- type: Security
  url: https://docs.haloconnect.io/security/
- type: X-MCPServerCandidate
  url: mcp/halo-connect-mcp.yml
  note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
    from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
    correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- type: LLMsTxt
  url: llms/halo-connect-llms.txt
- type: DataModel
  url: data-model/halo-connect-data-model.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Overlay
  url: overlays/halo-connect-integrator-overlay.yaml
- type: Overlay
  url: overlays/halo-connect-desktop-overlay.yaml
- type: WellKnown
  url: well-known/halo-connect-well-known.yml
- type: TermsOfService
  url: https://haloconnect.io/terms-and-conditions
- type: PrivacyPolicy
  url: https://haloconnect.io/privacy-policy
- type: Support
  url: https://haloconnect.io/contact-us
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

Halo Connect API — frequently asked questions

Does Halo Connect have an API?

Yes. APIs.io lists 5 APIs from Halo Connect, including Halo Connect FHIR API, Halo Connect Registered Queries API and Halo Connect Sites API, and 2 more.

Is there an OpenAPI specification for the Halo Connect API?

Yes. APIs.io indexes 5 OpenAPI specifications for Halo Connect, each linked for download from this page.

How do I authenticate with the Halo Connect API?

Halo Connect uses bearer-token authentication (apiKey/http · 3 schemes). The details are profiled on APIs.io as Halo Connect Authentication.

Is the Halo Connect API ready for AI agents?

Halo Connect has a Kin Score of 55.4 out of 100 (strong) and an Agent Readiness score of 28.3 (agent-aware), 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/halo-connect"

All providers

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

Every operation they expose

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

How their score was established

curl "https://apis.io/api/v1/providers/halo-connect/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.