AU Core Implementation Guide
0.1.0-draft - Draft Australia flag

This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. 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.1.0-draft
IG Standards status: Draft Maturity Level: 0 Computable Name: AUCoreImplementationGuide

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

Page standards status: Informative

Introduction

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

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. In this regard it is similar in nature to other international FHIR specifications such as US Core FHIR Implementation Guide.

This includes defining in profiles:

  • Nomination of mandatory and ‘must support’ elements
  • Setting terminology binding strength appropriately
  • Nominating search parameter scope of support expectations
  • Other FHIR server requirements

This specification can be implemented as: a) Data Requirement - profile, element and terminology support in systems b) Interaction Requirement - API support, system, search and operations

Systems may nominate to implement the Data Requirement only; however this limits the assumptions connecting software may make when interacting with their FHIR API.

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.

Usage

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.

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 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.
    • 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 Core FHIR NPM package.

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