Halaxy

Halaxy Referral API

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

GitHub OpenAPI

Operations 4

GET /main/Referral List Referrals #
POST /main/Referral Create Referral #
GET /main/Referral/{id} Get Referral #
PATCH /main/Referral/{id} Update Referral #

Documentation

📖
Documentation
https://developers.halaxy.com/docs/about-this-guide
📖
APIReference
https://developers.halaxy.com/reference/patient
📖
Authentication
https://developers.halaxy.com/docs/authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/halaxy/openapi/halaxy-referral-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-search-parameter-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-search-parameter-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-capability-statement-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-capability-statement-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-referral-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-referral-schema.json

Other Resources

🔗
Webhooks
https://developers.halaxy.com/docs/webhooks

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/halaxy:halaxy-referral-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

OpenAPI Specification

halaxy-referral-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Halaxy Referral API
  description: A FHIR API for Halaxy based on R4 of the FHIR specification
  termsOfService: https://www.halaxy.com/article/terms/practitioner
  contact:
    name: Halaxy Developers
    url: https://www.halaxy.com
    email: community@halaxy.com
  version: '1.104'
servers:
- url: https://au-api.halaxy.com
  description: Production AU
- url: https://eu-api.halaxy.com
  description: Production EU
security:
- oauth: []
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://artifacts.apis.io/halaxy/openapi/halaxy-referral-api-openapi.yml