My Health Record FHIR IG
1.3.0 - active Australia flag

My Health Record FHIR IG - Local Development build (v1.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Home

Official URL: http://ns.electronichealth.net.au/fhir/ImplementationGuide/au.digitalhealth.r4 Version: 1.3.0
Active as of 2024-10-25 Computable Name: ADHAFHIR

Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

Introduction

The Australian Digital Health Agency FHIR Implementation Guide contains HL7™ FHIR® Release 4 (R4) artefacts authored and maintained by the Agency to support the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

It also supplements the My Health Record FHIR Gateway technical specifications that support developers connect apps and other products to the My Health Record system. The artefacts in this publication describe the data structure of the payload in the API response messages.

Wherever possible, material in this specification is based on existing standards. All efforts have been made to minimise divergence from the HL7 Australia profiles of HL7 International standards to provide for system interoperability and compatibility with other profiles.

Scope

This guide is limited to the FHIR conformance artefacts (i.e. Profiles and Extensions) that define the data structure of FHIR resources for the following record types:

  • Medical Conditions View (MCV)
  • Australian Immunisation Register (AIR) information
  • Australian Organ Donor Register (AODR) information
  • Pharmaceutical Benefits Scheme (PBS) / Repatriation Pharmaceutical Benefits Scheme (RPBS) claims information
  • Medicare Benefits Schedule (MBS) / Department of Veterans' Affairs (DVA) claims information
  • MyMedicare registered practice information
  • ADHA Patient Emergency Contact

The FHIR conformance artefacts are published in a FHIR NPM package for use with FHIR and FHIR-aware tools.

The FHIR package contains the validation form (JSON + SCH) of the conformance artefacts for direct use in validation operations and example resource instances that demonstrate use cases and conformance requirements. This release of the implementation guide is scoped to the content of the Agency FHIR NPM package v1.1.0 and is provided to assist readers and users in understanding the content of that package.

How to read this guide

This guide is divided into several pages which are listed at the top of each page in the menu bar.

  • Home: This page provides the introduction and scope for this guide.
  • Conformance: This page describes the expectations for Must Support elements in the profiles in this guide.
  • Guidance: This page provides guidance about various artefacts that are defined in this guide.
  • FHIR Artefacts: These pages provide detailed descriptions and formal definitions for all the FHIR artefacts defined in this guide.
    • Profiles and Extensions: This page lists the FHIR profiles and extensions that are defined in this guide.
    • Terminology: This page lists the FHIR terminology that are defined in this guide.
    • Actor Definitions: This page lists the Actor Definitions that are defined in this guide.
  • Examples: This page lists all the examples used in this guide.
  • MHR Gateway API: This page provides technical specifications for the My Health Record FHIR Gateway.
  • Downloads: This page provides links to downloadable artefacts including the NPM package.
  • Disclaimers: This page lists the licensing, copyright, and disclaimers under which this guide is issued.
  • Change Log: This page lists the changes between various My Health Record FHIR IG releases.

Relationships with other work

This implementation guide builds on other specifications, helping ensure a consistent approach to data sharing that should ease adoption. The specific guides used, and the portions relevant from each of them are as follows:

IGPackageFHIRComment
.. My Health Record FHIR IGau.digitalhealth.r4#1.3.0R4
... HL7 Terminology (THO)hl7.terminology.r4#6.0.2R4Automatically added as a dependency - all IGs depend on HL7 Terminology
... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.1.0R4Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
... AU Core Implementation Guidehl7.fhir.au.core#1.0.0-ballotR4
... AU Base Implementation Guidehl7.fhir.au.base#4.2.2-ballotR4

Cross version analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (au.digitalhealth.r4.r4) and R4B (au.digitalhealth.r4.r4b) are available.

Global profiles

There are no Global profiles defined

Intellectual property considerations

This implementation guide and the underlying FHIR specification are licensed as public domain under the FHIR license. The license page also describes rules for the use of the FHIR name and logo.

This publication includes IP covered under the following statements.