AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core | Version: 1.0.0-ci-build | |||
IG Standards status: Draft | Maturity Level: 1 | Computable Name: AUCoreImplementationGuide | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
AU Core is provided to support the use of HL7® FHIR®© in an Australian context. It sets the minimum expectations on FHIR resources to support conformance and implementation in systems.
AU Core defines the data model and RESTful API interactions that set minimum expectations for a system to record, update, search, and retrieve core digital health and administrative information.
AU Core uses AU Base representations, where available, as the basis for profiles that define the FHIR resources to be supported, and the elements, extensions, vocabularies, and value sets that SHALL be present are identified, and how they are used is defined. It also documents the minimum FHIR RESTful interactions for each resource type to access data. AU Core promotes interoperability and adoption through common implementation and SHOULD be the basis of further implementation guide development for specific use cases.
There are two different ways to implement AU Core:
In this regard it is similar in nature to other national core specifications such as US Core FHIR Implementation Guide and international FHIR specifications such as International Patient Access FHIR Implementation Guide.
For a detailed description of the different ways to implement AU Core see the Conformance Requirements page.
This implementation guide is under development through the AU Core project as part of the Sparked AU FHIR Accelerator. The Sparked AU FHIR Accelerator is a community comprising government, technology vendors, provider organisations, peak bodies, practitioners, and domain experts, to accelerate the creation and use of national FHIR standards in health care information exchange.
The AU Core Sparked project includes:
The Australian Core Data for Interoperability (AUCDI) aims to define requirements underlying the standardisation of the capture, structure, usage, and exchange of health data to counteract the current fragmentation of Australia’s health data systems. The AUCDI forms a basis for clinical data requirements for AU Core.
IG | Package | FHIR | Comment |
---|---|---|---|
AU Core Implementation Guide | hl7.fhir.au.core#1.0.0-ci-build | R4 | |
HL7 Terminology (THO) | hl7.terminology.r4#6.1.0 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology |
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.1.0 | R4 | Automatically added as a dependency - all IGs depend on the HL7 Extension Pack |
AU Base Implementation Guide | hl7.fhir.au.base#current | R4 | |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.1.0 | R4 | |
HL7 Terminology (THO) | hl7.terminology.r4#5.0.0 | R4 | |
International Patient Access | hl7.fhir.uv.ipa#current | R4 | |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.0.0 | R4 |
Package hl7.fhir.uv.extensions.r4#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00) |
Package hl7.fhir.au.base#current This implementation guide is provided to support the use of FHIR®© in an Australian context. (built Mon, Dec 2, 2024 04:08+0000+00:00) |
Package hl7.fhir.uv.ipa#current This IG describes how an application acting on behalf of a patient can access information about the patient from an clinical records system using a FHIR based API. The clinical records system may be supporting a clinical care provider (e.g. a hospital, or a general practitioner), or a health data exchange, including a national health record system. (built Wed, Dec 4, 2024 20:31+0000+00:00) |
AU Core is particularly useful in defining:
Implementation of capabilities defined in AU Core enables specifications, applications and business logic to be developed with confidence.
This document is a working specification that may be directly implemented by FHIR®© system producers.
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.
The following actors are part of AU Core:
AU Core Requestor
A system that creates and initiates a data access request to retrieve core digital health and administrative information. The AU Core Requestor is the client in a client-server interaction.
AU Core Responder
A system that responds to the data access request submitted by requesters, providing responses to requests for core digital health and administrative information. The AU Core Responder is the server in a client-server interaction.
For systems that support AU Core FHIR RESTful interactions (Profile Support + Interaction Support), the interaction requirements, such as read and search operations, are detailed in the AU Core Requester and AU Core Responder CapabilityStatements.
The following are simple examples of AU Core FHIR RESTful interactions between AU Core Requester and AU Core Responder actors:
Example of a FHIR RESTful read interaction
Figure 1: Read a Patient using the logical id
Example of a FHIR RESTful search interaction
Figure 2: Search for patients that match a family name
This guide is divided into several pages which are listed at the top of each page in the menu bar.
This guide is the product of collaborative work undertaken with participants from:
Primary Editors: Brett Esler, Danielle Tavares-Rixon, Dusica Bojicic.