My Health Record FHIR Gateway Conformance Artefacts
0.0.1 - draft Australia flag

My Health Record FHIR Gateway Conformance Artefacts, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/mcv/ and changes regularly. See the Directory of published versions

Home

Official URL: http://ns.electronichealth.net.au/fhir/ImplementationGuide/au.digitalhealth.r4.mhr-fhir-gw Version: 0.0.1
Draft as of 2024-09-11 Computable Name: MHRGatewayFHIR

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

This guide is a collection of HL7™ FHIR® Release 4 (R4) artefacts authored and maintained by the Agency. It supplements the My Health Record FHIR Gateway technical specifications that support developers connect apps and other products to the My Health Record system. The artefacts in this publication describe the data structure of the payload in the API response messages.

MORE CONTENT TO BE PROVIDED.

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.
  • MHR Gateway API: This page provides the introduction and scope for this guide.
  • Conformance: This page describes the expectations for Must Support elements in the profiles in this guide.
  • Artefacts: This page lists the FHIR artefacts that are 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 NPM package.
  • Disclaimers: This page lists the licensing, copyright, and disclaimers under which this guide is issued.

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
.. My Health Record FHIR Gateway Conformance Artefactsau.digitalhealth.r4.mhr-fhir-gw#0.0.1R4
... 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.mhr-fhir-gw.r4) and R4B (au.digitalhealth.r4.mhr-fhir-gw.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.