About this guide
Whether you're an experienced developer or practice owner, this is where you'll find the documentation you need.
π Our API framework
The Halaxy API empowers you to seamlessly integrate and share health information using the globally recognized Fast Healthcare Interoperability Resources (FHIR).
As the global standard for medical APIs, FHIR has been adopted by governments worldwide and simplifies interoperability between global vendors and partners.
π¦ About this guide
In this guide, we have the following resources to help you work with Halaxy:
- Guides: How our API works, set up, and best practices
- API Reference: All API resources organized by capabilities
- Recipes: Request templates for our most common use cases
- Changelog: All documentation on updates and new releases
βοΈ Examples
Our endpoint guides include options to let you:
- Test with your practice data by entering your token credentials. This is private only to you and does not affect your Halaxy data.
- Send test requests by entering values in the parameter tables.
- Preview request examples with the correct formats.
- Preview responses to your test payloads.

π¬ We're here to help!
If you get stuck, feel free to shoot us an email.
We're excited you're here! π
Updated 20 days ago