My Health Record FHIR Gateway API v1.3.0 Released



The Australian Digital Health Agency is pleased to announce that My Health Record version 9.4 was released on Monday 25 June, 2018. Included in version 9.4 is the:

My Health Record FHIR® Gateway API v1.3.0

This release will provide the following updates:

  • Performance improvements to the following APIs:
    • Get Patient Details (GET) Consumers
    • Get PBS Items (GET)
    • Get MBS Items (GET)
    • Get Document (GET)
    • Search Document List (GET)
    • Get Personal Health Summary - Medications (GET)
    • Get Personal Health Summary - Allergies (GET)
  • It also resolves various production issues and known defects.

The My Health Record FHIR® Gateway API v1.3.0 will be deployed to the Software Vendor Test (SVT) environment on 30th of June 2018, henceforth no further changes will be made to API v1.2.0.

The FHIR® Gateway API specification v1.3.0 is available for direct download from:

Who will this affect?

  • Developers of mobile applications with products currently in production using the FHIR® Gateway API v1.2.0 or earlier.
  • Developers of mobile applications who are currently using the FHIR® Gateway API v1.2.0 or earlier in the SVT environment.

What versions of APIs will be supported?

  • FHIR® Gateway API v1.0.0 will continue to be supported along with v1.3.0 when v1.3.0 is released to the production and SVT environments.
  • To allow for migration, FHIR ® Gateway API v1.2.0 will remain available in the production and SVT environments for a period of six months upon production and SVT release of v1.3.0. However, no further changes will be made to v1.2.0 during that six month period.

What is the impact?

  • Vendors currently using FHIR ® Gateway v1.2.0 in production will have a period of six months to migrate to v1.3.0 and perform smaller scale observed testing with the National Infrastructure Operator (NIO). After the six month period, v1.2.0 will cease to be available from production and SVT environments.
  • Vendors currently developing against FHIR ® Gateway v1.2.0 will be required to migrate to v1.3.0 and undertake My Health Record Notice of Connection (NOC) testing before going live in production.
  • Some resolved known defects may entail changes in the service response, and therefore application codes handling the response may need to be amended.

More Information

Please refer to the Release Note for a more detailed list of changes. The end products, associated release notes and specifications are available from:
Additional information about the FHIR® Gateway is available at:

We value your feedback and encourage questions, comments or suggestions about our products. Please email [email protected] or call 1300 901 001.

You can join the Australian Digital Health Agency Software Development Community by registering on the Developer Centre Website.

FHIR® is a trademark of Health Level Seven International, registered with the United States Patent and Trademark Office.

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