Helix FHIR API
Use the Helix FHIR API to send requests in FHIR (Fast Healthcare Interoperability Resources) formats to create, update, and delete (in some circumstances) various resources such as patient, practitioner, appointment and other clinical data.
The Helix FHIR API Implementation Guide provides information about integrating other products with Helix using the Helix FHIR API interface. This guide is intended for technical teams, including developers, integration specialists, and system architects. Each chapter describes key features of the system, including how appointments are managed, how data is exchanged with other platforms using FHIR, and how custom operations are supported. You can find information on system architecture, integration workflows, and subscriptions to updates and changes.
You can find more details here: Implementation Guide.
Development Guide
Your development team can use the Helix staging environment to
integrate and test FHIR workflows, including the use of Helix
Authoring Keys. The staging environment supports version tracking,
custom search parameters, and secures access to binary content via SAS tokens.
You can find more details here: Development Guide
FHIR
FHIR is a modern, web-based standard for electronic healthcare data exchange that builds on HL7 standards using technologies like RESTful APIs, JSON, and XML. This chapter introduces the core principles and resources of FHIR and should be read before using the implementation guide.
You can find more details here: FHIR and Au Core FHIR.
Architecture
Introduction to Helix FHIR API architecture including rate limiting, HTTP errors, and change notifications. All the data written via Helix FHIR API is written back to Helix application, which serves as the single source of truth.
You can find more details here: Architecture.
Binaries
Binary resources in FHIR are used to represent non-FHIR content, typically raw binary data, such as PDF files, images, audio recordings, and other file types. For optimal performance, binaries are stored outside of the FHIR resources using Azure Blob Storage. This chapter describes the typical process with both binary read and write operation examples.
You can find more details here: Binaries.
Custom Operations
Custom operations in FHIR are extensions to standard RESTful interactions that allow implementation of complex logic or business rules, such as appointment booking, structured data submission, or patient matching. This chapter describes the syntax to use custom operations and different levels to execute it.
You can find details here: Custom Operations.
Subscriptions
The subscription publish and subscribe pattern enables FHIR clients to receive data from a server without performing more expensive periodic polling queries. This chapter provides detailed guidance on subscriptions.
You can find details here: Subscriptions and FHIR Subscription.
SMART on FHIR
SMART on FHIR (Substitutable Medical Applications, Reusable Technologies on Fast Healthcare Interoperability Resources) is a healthcare interoperability standard that provides a consistent, secure, and efficient method to exchange healthcare data between applications and Electronic Health Record (EHR) systems. This chapter describes key features of SMART on FHIR, development workflows and launch context.
You can find details here: SMART on FHIR.
Writing Data Back to Helix
Writing data back to Helix allows secure, efficient transfer of FHIR resources from Helix Hub to Helix application, ensuring accuracy, traceability, and regulatory compliance. This chapter explains the authoring key structure and processes for writing various resources back to the Helix application via Helix Hub.
You can find details here: Writing Data Back to Helix.
Appointments
An appointment resource is created and associated with a valid slot, patient, and practitioner resources using FHIR values. This chapter provides a detailed description of writing appointment data back into Helix with examples and constraints.
You can find details here: Appointments.
Slots
Slot resources are used to provide time-slots that can be booked using an appointment. Slot resources provide specific time intervals on a schedule in which to book an appointment. This chapter explains the slots resource and its related operations, which are used to provide available time slots for booking appointments.