This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Home

Official URL: http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core				Version: 0.2.2-preview
IG Standards status: Draft			Maturity Level: 0	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.

Page standards status: Informative

Introduction

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 associated with a patient. Applications that conform to AU Core can access the following information about the patient:

• Basic patient details
• Problems / Conditions
• Medication orders, dispense, administration and usage
• Immunization history
• Allergies and intolerances
• Diagnostic orders, report, and results
• Vital signs, and other clinical observations
• Clinical notes & other patient documents

AU Core provides FHIR profiles to support conformance and implementation in systems. This uses AU Base representations as the basis of typical use for many purposes.

AU Core uses AU Base representations 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 patient data. AU Core promotes interoperability and adoption through common implementation and SHOULD be built on top of for standards development for specific use cases. There are two different ways to implement AU Core:

1. Systems may support only AU Core Profiles to represent digital health information (Profile Only Support).
2. Systems may support both AU Core Profiles and the RESTful interactions defined for a resource (Profile + Interaction Support).

In this regard it is similar in nature to other international FHIR specifications such as US Core FHIR Implementation Guide.

For a detailed description of these different usages of AU Core, see the Conformance Requirements and Must Support pages.

Dependencies

Package hl7.fhir.uv.extensions.r4#1.0.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Mar 26, 2023 08:46+1100+11:00)

Package hl7.fhir.au.base#4.1.2-preview This implementation guide is provided to support the use of FHIR®© in an Australian context. (built Wed, Nov 15, 2023 15:57+1100+11:00)

In addition, the following FHIR implementation guides are referenced:

• Bulk Data Export
• International Patient Access
• SMART Application Launch Framework
• Structured Data Capture

Usage

AU Core is particularly useful in defining:

• A testable level of system conformance
• Assumed support by client applications
• As the basis of downstream implementation guides

Assuming capabilities defined in AU Core are implemented allow specifications, applications and business logic to be developed generally with confidence that systems can readily supply this capability.

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.

AU Core Actors

The following actors are part of the AU Core IG:

AU Core Requestor

An application that initiates a data access request to retrieve patient data. The AU Core Requestor is the client in a client-server interaction. The terms “requester”, “client”, and “app” are used interchangeably throughout this guide and are not meant to limit this actor to patient and provider apps. Payers and other users can use the same technology. Consider these terms a short-hand notation for a “user application”.

AU Core Responder

A system that responds to the data access request providing patient data. The AU Core Responder is the server in a client-server interaction. The terms “server”, “AU Core FHIR server”, “FHIR server” and “EHR” are used interchangeably throughout this guide and are not meant to limit this actor to electronic health record systems. HIEs, care coordination platforms, population health systems, etc., can use the same technology. Consider these terms a short-hand notation for an “interoperable healthcare platform”.

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 expectations for must support elements in AU Core profiles.
  • General Requirements: This page defines requirements common to all actors and profiles used in this guide including how CapabilityStatements are used to claim conformance.
  • Must Support: This page defines the expectations for mandatory and must support elements in AU Core Profiles.
• Guidance: This set of pages lists the guidance for this guide.
  • General Guidance: This page provides guidance on using the profiles defined in this guide.
  • Comparison with other national and international specifications: This page provides comparison between AU Core profiles and other national, or international implementation guides.
• 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.
  • Search Parameters: This set of pages lists the search parameters extended for use in this guide for use in AU Core operations.
  • Terminology: This set of pages lists the value sets and code systems defined in this guide.
  • Capability Statements: This set of pages define the expected FHIR capabilities of AU Core Servers and Clients.
• Examples: This page lists all the examples used in this guide.
• Downloads: This page provides links to downloadable artefacts that developers can use to help them implement 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