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

Development Guide

Overview

The Helix FHIR API is still under active development and subject to change as the project progresses.

Your feedback is a critical part of the development process. You can provide feedback to our support team via Telstra Health Partner Portal.

Helix Staging Environment

It is recommended to use the Helix staging area to execute and test Helix FHIR Hub workflows and verify the resulting resources aligh with the requirements. If you have specific resource creation requirements, please contact Telstra Health support via Telstra Health Partner Portal for assistance.

FHIR API Access

You can find details at Home page.

Authoring Key

The Authoring Key is a unique identifier for each resource. It enables Helix to maintain synchronization between FHIR resources and corresponding Helix data records.

When storing an ID to reference a Helix FHIR resource, the Authoring Key should be used, as it is directly linked to the related Helix data record. The FHIR resource ID may change under certain conditions, such as during data resynchronisation.

The Authoring Key can be used to look up a specific resource. For example:

https://<fhir-server>/<tenant>/Patient?identifier=http://medicaldirector.com/fhir/id/authoring-key|AcmePatient~123456

Use the FHIR resource ID to retrieve resources in subsequent queries. However, it should not be treated as a stable identifier for storage in other systems. Instead, the Authoring Key represents the business identity of a resource within Helix, regardless of the FHIR resource ID assigned by the FHIR server.

You can use _include parameter in your request to include the related resources in the response from the server. It is useful when the client is searching for a clinical resource but also needs the associated patient resource that it refers to.

You can find more information at: search documentation.

A search example: You can send request to get the encounter information together with patient detail.

https://<fhir-server>/<tenant>/Encounter?identifier=<AuthoringKey>&_include=Encounter:patient

Helix Version

FHIR resources are generally stable but may evolve as new features are introduced in Helix. Changes are typically made in a backward-compatible manner to ensure existing integrations continue to work without interruption.

You can find the Helix version in a metadata extension on each resource. In most scenarios, direct access to the version number is not necessary. However, if your integration relies on version-specific behaviour, contact the Helix support team to discuss your use case.

"meta": {
    "extension": [
        {
            "url": "http://medicaldirector.com/fhir/helix-base/StructureDefinition/helix-version",
            "valueString": "96.1.1.0"
        }
    ]
}

Search Parameters

Contact the Helix support team via Telstra Health Partner Portal for requests to include additional search parameters.

Tip: Provide your workflow context to help our team better understand and assess the request.

SMART on FHIR

You can find information at SMART on FHIR

Helix Blob URLs

When accessing FHIR resources that reference file or binary content (DocumentReference or DiagnosticReport), a URL to the content in the tenant's blob storage will be provided. To retrieve this content:

  1. Get a SAS (Shared Access Signature) token:

    Request:

    https://r4.hub.medicaldirector.com/tst1/DiagnosticReport/$requestSasToken?url=https://tst1storage.blob.core.windows.net/ehealth-2025-01-10/a992f90a-0a22-4537-a092-4b2ddbb0055f

    Response:

    sv=2021-08-06&se=2025-09-25T00%3A24%3A01Z&sr=b&sp=r&sig=dOuqIqjMvnkjxGe8CYhfVVQC9wOn%2F62KGMxe%2BOmMp4U%3D`

    Note: The SAS token will expire after 1 minute.

  2. Attach the token obtained from step 1 to the URL and send the request:

    https://tst1storage.blob.core.windows.net/ehealth-2025-01-10/a992f90a-0a22-4537-a092-4b2ddbb0055f?sv=2021-08-06&se=2025-09-25T00%3A24%3A01Z&sr=b&sp=r&sig=dOuqIqjMvnkjxGe8CYhfVVQC9wOn%2F62KGMxe%2BOmMp4U%3D

    You will get the content in the reponse but in binary format. You can save it to get the human-readable content.

Note: The content cannot be loaded into a browser directly from the Helix tenant's blob storage URL.