Helix AU Core
0.1.0 - ci-build

Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Home

Official URL: http://medicaldirector.com/fhir/helix-au-core/ImplementationGuide/medicaldirector.helix-au-core Version: 0.1.0
Draft as of 2025-12-09 Computable Name: HelixAUImplementationGuide

Overview

This implementation guide provides instructions on how to use FHIR (Fast Healthcare Interoperability Resources) with Helix FHIR API in Australia.

Helix FHIR API supports the R4 version of the FHIR standard and builds on the AU Core (FHIR R4) implementation guide.

Telstra Health Partner Portal is your way of logging new requests, questions or incidents for Helix Hub.

How to read this guide

This guide is organised into several chapters which are listed in the Guidance drop-down menu in the navigation bar:

Development Guide
FHIR
Architecture
Binaries
Custom Operations
Subscriptions
SMART On FHIR
Writing Data Back To Helix
Appointments
Slots

Getting started with Helix FHIR API

When you make an access request, you will be provided with a client ID and client secret which can be used for OAuth2 client credential flow for authentication against the Helix FHIR authorisation server. You can find more details here: Client Credentials Flow.

Endpoints:

The following example shows an application making a request to the authorisation server to grant a new access token using the client credentials grant. This flow should not be used for insecure applications (such as single page web apps) as those clients are unable to secure the client secret.

POST /oauth/token
Accept: application/json
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=1234-5678
&client_secret=your-client-secret

An example using Postman can be found here. It illustrates the OAuth2 client credential flow.