Go to top of page

The Australian Digital Health Agency aims to increase adoption of the My Health Record by individuals as well as healthcare professionals by connecting the My Health Record platform to mobile healthcare applications (apps) via industry standard Application Programming Interfaces (APIs). To support that, the Agency is providing relevant technical information and resources for developers who might be new or established in the mobile healthcare application space.

The Agency mobile enablement program is using the Fast Healthcare Interoperability Resources (FHIR®) Draft Standards in creating the mobile APIs. Mobile application developers can use various high level architecture approaches to integrate with the FHIR® Gateway of the My Health Record system.

What's the difference between the B2B and Mobile approaches?

The mobile enablement program has made use of the FHIR® Draft Standards in creating the mobile APIs. There is also a higher amount of granularity in the mobile solution in terms of the scope of the APIs – the APIs that have been developed for the mobile program are more detailed than the CDA which is extracted for B2B.

Access and Integration

The integration approach currently supported by the My Health Record System Operator is shown below.

For consumer access a consumer, must first log into my.gov.au and grant access to the application. This is done by redirecting to the my.gov.au login. Once the consumer has logged and granted access the token can be retrieved. 

Secure Messaging Diagram

Consumer accesses their own data without intermediate infrastructure handling the data.

Feature specifications

Getting Started:

For developers, getting started is easy. The Australian Digital Health Agency can assist developers to connect with My Health Record by providing information about registering your organisation and access to specifications. The Agency can also provide support with development and testing including declaring your app’s conformance to mandatory requirements. 

For any questions about the process, please do not hesitate to reach out to our team at [email protected]. 

The following specifications enable developers to connect applications to the My Health Record system via the FHIR® Gateway.

Videos

Introduction to HL7 FHIR

Roadmap

The Australian Digital Health Agency aims to increase adoption of the My Health Record by individuals as well as healthcare professionals by connecting the My Health Record platform to healthcare applications (apps) through industry standard APIs. To support this the Agency provides a number of resources for developers in the mobile healthcare application space and provides a comprehensive view of the engagement possibilities with My Health Record.

Roadmap: 
June, 2018
Completed
Version 1.3.0 released. In this version, workloads for selected APIs were streamlined by reducing the number of back end service calls which optimised API performance through orchestrating services underpinned by the REST protocol.
June, 2017
Completed
Release of FHIR Gateway API specification v1.2.0
July, 2016
Completed
Release of FHIR Gateway API specification v1.0.0. The initial APIs were prioritised based on the interest of an initial set of co-design developers. It is expected that this list of APIs will grow and evolve over time.
June, 2012
Completed
Founded in 2012 as the Personally Controlled Electronic Health Record (PCEHR), the My Health Record system has undergone a transformation that has seen it expand its services for individuals and healthcare providers alike.