My Health Record FHIR Gateway v2.0.0

Technical specifications to enable developers to connect applications to the My Health Record system via the FHIR® Gateway. It describes API requests and responses, Data Mapping between CDA Implementation Guide fields and Fast Healthcare Interoperability Resources (FHIR®), and the error scenarios and associated error codes for all APIs. It is intended for use by FHIR® API consumers to understand the API signature exposed by the My Health Record system.

Identifier: 
EP-2748:2018
Date: 
17-06-2019
Type: 
application/zip
SHA256 Checksum: 
571c57d24ee6ee6188fddd0732647f6bcd0e0f48182a3d82877d0a5789a4869b
Size: 
2.27 MB

Product Components

Product component
Identifier: 
DH-2751:2018

This document provides an overview of the API specifications required by developers to connect applications (apps) to the My Health Record system. This document describes API requests, API responses, OperationOutcome details, and error conditions that apply to application transactions.

Product component
Identifier: 
DH-2752:2018

Version 2.0.0 of the FHIR® Gateway leverages the myGov authentication hub which allows mobile app users to use their email address or mobile number to sign in to My Health Record.

Product component
Identifier: 
DH-2749:2018

This document defines the error scenarios and the associated error codes for all APIs except the Medicines View API.

Product component
Identifier: 
DH-2750:2018

This document contains the mapping between CDA Implementation Guide fields and Fast Healthcare Interoperability Resources (FHIR®) (Version 1.4.0 of standard).

Release history

By operation of the Public Governance, Performance and Accountability (Establishing the Australian Digital Health Agency) Rule 2016, on 1 July 2016, all the assets and liabilities of NEHTA will vest in the Australian Digital Health Agency. In this website, on and from 1 July 2016, all references to "National E-Health Transition Authority" or "NEHTA" will be deemed to be references to the Australian Digital Health Agency. PCEHR means the My Health Record, formerly the "Personally Controlled Electronic Health Record", within the meaning of the My Health Records Act 2012 (Cth), formerly called the Personally Controlled Electronic Health Records Act 2012 (Cth).

Back to Top