AU Base Implementation Guide
4.2.1-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Home

Official URL: http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base Version: 4.2.1-preview
IG Standards status: Trial-use Computable Name: AUBaseImplementationGuide

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

AU Base 4.2.1-preview for testing

This June 2024 preview snapshot of AU Base supports testing of AU Core prior to Ballot of AU Core R1.

Testing plays a crucial role in the development of AU Core. It helps to build an AU Core that is aligned with its intended purpose and is practical, and responsive to the diverse needs of various stakeholders.

Testing AU Core helps identify issues, challenges, or gaps in the specification, enabling its improvement. During testing, implementers test their FHIR resources, software products, and/or proof of concepts with AU Core and provide essential feedback.

This testing period ends 08 September 2024.

To learn more about testing AU Core or express your interest in participating, see AU Core FHIR IG Testing.

Introduction

This implementation guide is provided to support the use of HL7® FHIR®© in an Australian context.

The AU Base implementation guide presents Australian use concepts defined via FHIR processable artefacts; these are collaborative outputs with agreed approaches to varied kinds of healthcare related information based on the core FHIR R4 specification as base profiles that can be further constrained in a separate implementation guide for a particular usage.

This guide alone does not constrain profiles sufficiently to ensure implementation use cases can be met.

For an implementation guide that has basic constraints to support many uses it is recommended that the AU Core implementation guide is used. The implementable AU Core specification references and uses AU Base profiles, this constrains elements further and defines an expected level of interface interaction support around profiles. If an implementation is AU Core conformant this allows a level of core capability to be assumed when using.

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.
  • Guidance:
    • Guidance: This page provides guidance on using the profiles defined in this guide.
    • Relationship with other IGs: This page provides guidance on the relationship between AU Base and other implementation guides.
    • Future of AU Base: This page outlines the yearly update cycle and approach to maturing AU Base.
  • 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 represent Australian local concepts using FHIR. Each profile page includes a narrative description, guidance, and formal definition. Although the guidance typically focuses on the profiled elements and seeks to provide a ‘how-to’ guide when representing concepts, it may also may focus on un-profiled elements to aid with implementation.
    • Search Parameters: This set of pages lists the search parameters defined in this guide for use in AU operations.
    • Terminology: This set of pages lists the value sets and code systems defined in this guide.
  • Examples: This page lists all the examples used in this guide.
  • Downloads: This page provides links to downloadable artefacts including the AU Base FHIR NPM package.
  • Change Log: This page documents the changes across versions of this guide.

Collaboration

This guide is the product of collaborative work undertaken with participants from:

  • Australian FHIR Implementers Community
  • HL7 Australia Working Groups
  • Australian Digital Health Agency
  • CSIRO Australian e-Health Research Centre
  • Secure Messaging Technical Working Group

FHIR®© connectathon events are key to the verification of the guide as being suitable for implementation. This implementation guide will be used as the basis for Australian connectathon events.

FHIR profiles are managed under HL7 Australia work groups and projects managed by the HL7 Australia FHIR Work Group

Some profiles indicate the responsible work group, or enquires can be directed to the Work Group Liaison Officer