# Halaxy Patient API

**Canonical:** https://apis.io/apis/halaxy/halaxy-patient-api/  
**Provider:** Halaxy — https://apis.io/providers/halaxy/  
**Base URL:** https://au-api.halaxy.com  
**Documentation:** https://developers.halaxy.com/

Halaxy Patient API is one of 18 APIs that [Halaxy](https://apis.io/providers/halaxy/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Patient. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and 6 JSON Schemas.

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

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/main/Patient` | List Patients |
| POST | `/main/Patient` | Create Patient |
| GET | `/main/Patient/$export-ids` | Export a list of patient references |
| GET | `/main/Patient/{id}` | Get Patient |
| PATCH | `/main/Patient/{id}` | Update Patient |
| PUT | `/main/Patient/{id}` | Replace Patient |

## Machine-readable artifacts (11)

- **OpenAPI** — https://artifacts.apis.io/halaxy/openapi/halaxy-patient-api-openapi.yml
- **Documentation** — https://developers.halaxy.com/docs/about-this-guide
- **APIReference** — https://developers.halaxy.com/reference/patient
- **Authentication** — https://developers.halaxy.com/docs/authentication
- **Webhooks** — https://developers.halaxy.com/docs/webhooks
- **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 Halaxy APIs (12)

- [Halaxy Appointment API](https://apis.io/apis/halaxy/halaxy-appointment-api/)
- [Halaxy Charge Item Definition API](https://apis.io/apis/halaxy/halaxy-chargeitemdefinition-api/)
- [Halaxy Coverage API](https://apis.io/apis/halaxy/halaxy-coverage-api/)
- [Halaxy Invoice API](https://apis.io/apis/halaxy/halaxy-invoice-api/)
- [Halaxy Invoice Line API](https://apis.io/apis/halaxy/halaxy-invoiceline-api/)
- [Halaxy Organization API](https://apis.io/apis/halaxy/halaxy-organization-api/)
- [Halaxy Payment Transaction API](https://apis.io/apis/halaxy/halaxy-paymenttransaction-api/)
- [Halaxy Practitioner API](https://apis.io/apis/halaxy/halaxy-practitioner-api/)
- [Halaxy Referral API](https://apis.io/apis/halaxy/halaxy-referral-api/)
- [Halaxy Referral Definition API](https://apis.io/apis/halaxy/halaxy-referraldefinition-api/)
- [Halaxy Schedule API](https://apis.io/apis/halaxy/halaxy-schedule-api/)
- [Halaxy Slot API](https://apis.io/apis/halaxy/halaxy-slot-api/)

## Tags

Patient

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/halaxy/halaxy-patient-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/halaxy/.