Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/robeastwood-agency/test-fhir-ig-2/ and changes regularly. See the Directory of published versions

Home

Official URL: http://ns.electronichealth.net.au/fhir/ImplementationGuide/au.digitalhealth.r4 Version: 1.2.0-ci-build
Draft as of 2024-10-04 Computable Name: ADHAFHIR

Copyright/Legal: Copyright © 2023 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/.

This material is under active development and content may be added or updated on a regular basis.

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.

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.

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 set of rules to claim conformance to this guide including the support obligations for elements labelled MustSupport in the profiles in this guide, referred to as ADHA (Australian Digital Health Agency) profiles.
  • Policy: This page describes the policies for definition, use, implementation and management of FHIR.
  • Guidance: This page provides guidance on using the profiles 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 set of pages describes the profiles and extensions that are defined in this guide to exchange quality data. Each profile page includes a narrative description and guidance, formal definition and a "Quick Start" guide which summarises the supported search transactions for each profile. Although the guidance typically focuses on the profiled elements, it may also may focus on un-profiled elements to aid with implementation.
    • Capability Statements: This set of pages describes the expected FHIR capabilities of the various actors.
    • NamingSystems: This set of pages describes the identifier systems defined in this guide as formal artefact enabling inclusion in a registry for other systems to find and understand an identifier.
    • Search Parameters and Operations: This page page lists the defined Operations and Search Parameters that are used in transactions.
    • Terminology: This page lists the value sets and code system defined for profiles.
    • Maps: This page lists the concept maps and structure maps defined for profiles.
  • Downloads: This page provides links to downloadable artefacts including the Agency FHIR NPM package.
  • Disclaimers: This page lists the licensing, copyright, and disclaimers under which this guide is issued.

Future of this guide

The content published in this guide are designed to be a base set of requirements for FHIR implementation.

This guide undergoes cycles of development to introduce new capabilities such as new record types, implementation contexts, or interactions. At the completion of each cycle of development a new version of this guide is published.

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
.. Australian Digital Health Agency FHIR Implementation Guideau.digitalhealth.r4#1.2.0-ci-buildR4
... 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#currentR4

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.