Best Practice Software

Best Practice Software is an Australian clinical and practice-management software company, headquartered in Bundaberg, Queensland, and one half of the Australian GP-software duopoly (alongside MedicalDirector). Its flagship products - Bp Premier (general practice), Bp VIP.net (specialist and allied), and Bp Allied - run in thousands of Australian medical practices. Best Practice's programmatic surface is delivered through Halo Connect (Halo Cloud / Halo Link), a FHIR-based integration platform that lets approved partners query practice data over a modern API instead of the legacy SQL database. The FHIR API for Bp Premier is built to the AU Base 4.1.0 implementation guide, falling back to HL7 FHIR R4 (4.0.1), and exposes resources such as Patient, Appointment, Slot (Find Free Slots) and a Patient $summary document. Halo Cloud also offers SQL Passthrough and Registered Queries for structured practice data. Access is gated - integrators require a Halo Cloud subscription plus per-practice pairing and PMS-managed database credentials, authenticated with an Azure API Management subscription key (desktop apps additionally use a bearer JWT and device id). This is not a self-serve public API; it is a partner-onboarded, standards-aligned interoperability layer for the Australian primary-care market.

Best Practice Software publishes 5 APIs on the APIs.io network, including FHIR API, Registered Queries API, Sites API, and 2 more. Tagged areas include Healthcare, Australia, EHR, EMR, and FHIR.

The Best Practice Software catalog on APIs.io includes 1 event-driven AsyncAPI specification.

Best Practice Software’s developer surface includes authentication, documentation, API reference, getting-started guide, engineering blog, support, sandbox, and 22 more developer resources.

🌐 Visit website 📡 Source on GitHub

50.5/100 developing ▬ flat Agent 30/100 agent ready saas Full breakdown ↓
scored 2026-09-08 · rubric v0.20.0

2 APIs

Healthcare Australia EHR EMR FHIR HL7 InteroperabilityAU BasePractice ManagementGeneral PracticeAppointments Scheduling

Kin Score

Kin Score How this is scored →
scored 2026-09-08 · rubric v0.20.0

Composite quality — 50.5/100 · developing

Contract Quality 11.9 / 19

Developer Ergonomics 9.9 / 15

Access Clarity 3.2 / 15

Operational Transparency 3.9 / 10

Contract Governance 1.6 / 9

Discoverability 5.7 / 8

Regulatory Posture 5.8 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 30/100 · agent ready

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

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/.

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 github.com/api-evangelist/best-practice: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

APIs 5

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

Best Practice Software FHIR API

Query practice data using FHIR resources.

Best Practice Software Registered Queries API

The Registered Queries API from Best Practice Software — 6 operation(s) for registered queries.

Best Practice Software Sites API

Endpoints for practice onboarding and site metadata.

Best Practice Software 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...

Best Practice Software 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

Event Specifications 1

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

Best Practice Webhooks

ASYNCAPI

Security Posture 2

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

Best Practice Authentication

apiKey/http · 3 schemes

SECURITY

Best Practice Domain Security

TLSv1.3 · DMARC

SECURITY

Agentic Access 1

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

Best Practice Agentic Access

29 operations · 14 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

DeveloperPortal

DeveloperPortal

GettingStarted

GettingStarted

Sandbox

Sandbox

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

WellKnown

WellKnown

X-MCPServerCandidate

X-MCPServerCandidate

LLMsTxt

LLMsTxt

AgentSkill

AgentSkill

Design & Contract 6

Pagination, idempotency, versioning, errors, and events

Conventions

ErrorCatalog

Lifecycle

Conformance

DataModel

Webhooks

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 4

Status, limits, changes, and where to get help

StatusPage

Support

Deprecation

ChangeLog

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: best-practice
url: https://raw.githubusercontent.com/api-evangelist/best-practice/refs/heads/main/apis.yml
name: Best Practice Software
kind: company
description: Best Practice Software is an Australian clinical and practice-management software company, headquartered in Bundaberg,
  Queensland, and one half of the Australian GP-software duopoly (alongside MedicalDirector). Its flagship products - Bp Premier
  (general practice), Bp VIP.net (specialist and allied), and Bp Allied - run in thousands of Australian medical practices.
  Best Practice's programmatic surface is delivered through Halo Connect (Halo Cloud / Halo Link), a FHIR-based integration
  platform that lets approved partners query practice data over a modern API instead of the legacy SQL database. The FHIR
  API for Bp Premier is built to the AU Base 4.1.0 implementation guide, falling back to HL7 FHIR R4 (4.0.1), and exposes
  resources such as Patient, Appointment, Slot (Find Free Slots) and a Patient $summary document. Halo Cloud also offers SQL
  Passthrough and Registered Queries for structured practice data. Access is gated - integrators require a Halo Cloud subscription
  plus per-practice pairing and PMS-managed database credentials, authenticated with an Azure API Management subscription
  key (desktop apps additionally use a bearer JWT and device id). This is not a self-serve public API; it is a partner-onboarded,
  standards-aligned interoperability layer for the Australian primary-care market.
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: partner
  trial: false
  try_now: false
  public: false
  label: Partner-gated · Halo Cloud subscription + practice pairing
  confidence: high
  source:
  - authentication
  - documentation
  - url: https://bpsoftware.net/
    status: 301
    note: declared website redirects to https://bestpracticesoftware.com/ — a different registrable domain (bpsoftware.net
      -> bestpracticesoftware.com), possible rename or acquisition (probed 2026-09-03, roadmap#169)
  generated: '2026-07-24'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Healthcare
- Australia
- EHR
- EMR
- FHIR
- HL7
- Interoperability
- AU Base
- Practice Management
- General Practice
- Appointments
- Scheduling
created: '2026-07-24'
modified: '2026-07-24'
specificationVersion: '0.23'
apis:
- aid: best-practice:best-practice-fhir-api
  name: Best Practice Software FHIR API
  description: Query practice data using FHIR resources.
  humanURL: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  baseURL: https://api.haloconnect.io
  tags:
  - FHIR
  properties:
  - type: OpenAPI
    url: openapi/best-practice-fhir-api-openapi.yml
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: GettingStarted
    url: https://docs.haloconnect.io/halo-cloud/getting-started/
  - 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/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/examples/
  - type: ImplementationGuide
    url: https://kb.bpsoftware.net/au/bppremier/devportal/Content/Halo/HaloResources.htm
- aid: best-practice:best-practice-registered-queries-api
  name: Best Practice Software Registered Queries API
  description: The Registered Queries API from Best Practice Software — 6 operation(s) for registered queries.
  humanURL: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  baseURL: https://api.haloconnect.io
  tags:
  - Registered Queries
  properties:
  - type: OpenAPI
    url: openapi/best-practice-registered-queries-api-openapi.yml
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: GettingStarted
    url: https://docs.haloconnect.io/halo-cloud/getting-started/
  - 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/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/examples/
  - type: ImplementationGuide
    url: https://kb.bpsoftware.net/au/bppremier/devportal/Content/Halo/HaloResources.htm
- aid: best-practice:best-practice-sites-api
  name: Best Practice Software Sites API
  description: Endpoints for practice onboarding and site metadata.
  humanURL: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  baseURL: https://api.haloconnect.io
  tags:
  - Sites
  properties:
  - type: OpenAPI
    url: openapi/best-practice-sites-api-openapi.yml
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: GettingStarted
    url: https://docs.haloconnect.io/halo-cloud/getting-started/
  - 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/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/examples/
  - type: ImplementationGuide
    url: https://kb.bpsoftware.net/au/bppremier/devportal/Content/Halo/HaloResources.htm
- aid: best-practice:best-practice-sql-passthrough-api
  name: Best Practice Software 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/api-reference/integrator-openapi.html
  baseURL: https://api.haloconnect.io
  tags:
  - SQL Passthrough
  properties:
  - type: OpenAPI
    url: openapi/best-practice-sql-passthrough-api-openapi.yml
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: GettingStarted
    url: https://docs.haloconnect.io/halo-cloud/getting-started/
  - 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/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/examples/
  - type: ImplementationGuide
    url: https://kb.bpsoftware.net/au/bppremier/devportal/Content/Halo/HaloResources.htm
- aid: best-practice:best-practice-tokens-api
  name: Best Practice Software Tokens API
  description: Obtain authorization tokens for desktop applications to authenticate API requests.
  humanURL: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  baseURL: https://api.haloconnect.io
  tags:
  - Tokens
  properties:
  - type: OpenAPI
    url: openapi/best-practice-tokens-api-openapi.yml
  - type: APIReference
    url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/overview/
  - type: GettingStarted
    url: https://docs.haloconnect.io/halo-cloud/getting-started/
  - 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/
  - type: Documentation
    url: https://docs.haloconnect.io/halo-cloud/fhir-api/examples/
  - type: ImplementationGuide
    url: https://kb.bpsoftware.net/au/bppremier/devportal/Content/Halo/HaloResources.htm
common:
- type: CapabilityMap
  url: capabilities/best-practice-capability-edges.yml
  name: Best Practice Software Business Capability Map
- type: AgenticAccess
  url: agentic-access/best-practice-agentic-access.yml
- type: DomainSecurity
  url: security/best-practice-domain-security.yml
- type: Authentication
  url: authentication/best-practice-authentication.yml
- type: Website
  url: https://bpsoftware.net/
- type: DeveloperPortal
  url: https://docs.haloconnect.io/
- type: Documentation
  url: https://docs.haloconnect.io/halo-cloud/overview/
- type: APIReference
  url: https://docs.haloconnect.io/api-reference/integrator-openapi.html
- type: GettingStarted
  url: https://docs.haloconnect.io/halo-cloud/getting-started/
- type: Blog
  url: https://haloconnect.io/blog
- type: StatusPage
  url: https://status.haloconnect.io/
- type: Support
  url: https://bpsoftware.net/contact/
- type: TermsOfService
  url: https://bpsoftware.net/terms-of-use/
- type: PrivacyPolicy
  url: https://bpsoftware.net/privacy-policy/
- type: Conventions
  url: conventions/best-practice-conventions.yml
- type: ErrorCatalog
  url: errors/best-practice-problem-types.yml
- type: Lifecycle
  url: lifecycle/best-practice-lifecycle.yml
- type: Deprecation
  url: lifecycle/best-practice-lifecycle.yml
- type: Conformance
  url: conformance/best-practice-conformance.yml
- type: DataModel
  url: data-model/best-practice-data-model.yml
- type: WellKnown
  url: well-known/best-practice-well-known.yml
- type: Sandbox
  url: sandbox/best-practice-sandbox.yml
- type: ChangeLog
  url: changelog/best-practice-changelog.yml
- type: Webhooks
  url: asyncapi/best-practice-webhooks.yml
- type: X-MCPServerCandidate
  url: mcp/best-practice-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/best-practice-llms.txt
- type: Overlay
  url: overlays/best-practice-integrator-overlay.yaml
- type: Overlay
  url: overlays/best-practice-desktop-overlay.yaml
- type: AgentSkill
  url: skills/_index.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

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/best-practice"

All providers

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

Every operation they expose

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

How their score was established

curl "https://apis.io/api/v1/providers/best-practice/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

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.