Display native or embedded My Health Record data within clinical software, or develop consumer apps to allow end-users to view their My Health Record. Get started below.
The My Health Record system is a secure online summary of an individual’s health information and is available to all Australians. Healthcare providers authorised by their healthcare organisation can access My Health Records to view and add patient health information.
My Health Record has now been natively integrated into over 110 software products and is used broadly across many sectors of healthcare. The Agency provides a register of conformant products, allowing healthcare providers to ensure they are acquiring software with the highest level of My Health Record functionality.
The Digital Health Agency provides several mechanisms for software to interact with the My Health Record system. The four connection methods are outlined in our Developer Guides section below. Familiarise yourself with these connection methods to begin developing your My Health Record functionality today.
Business to Business
(B2B) Gateway
This is the most common mechanism for connecting Clinical Information Systems to the My Health Record system. The B2B Gateway SOAP-based APIs allow the most comprehensive read & write functionality for healthcare providers. Desktop and cloud systems can connect and your customers authenticate using their NASH certificate.
Clinical Information System to
National Provider Portal
CIS to NPP allows you to easily embed read-only My Health Record functionality in your product using a Browser Control which receives patient context from your interface. This is a fast way to implement My Health Record for healthcare providers, although it has some limitations such as requiring all end-users to have a HPI-I which is linked to an organisation. Desktop and cloud systems can connect and your customers authenticate using their NASH certificate
Fast Healthcare Interoperability Resources
This method is most commonly used for mobile or web-based applications. It is currently only available for consumer use. The FHIR Gateway is also currently read-only. If you are creating consumer apps and wish to access some My Health Record content, then the FHIR Gateway would likely be your preferred method to connect. Users authenticate using their MyGov credentials.
Open Source Middleware provided
by the ADHA
HIPS is middleware which you run within your own infrastructure to provide read & write functionality. It conducts some of the orchestration of the Healthcare Identifiers (HI) Service and My Health Record system for you. If you are a large healthcare organisation (such as a hospital) looking to integrate My Health Record functionality then HIPS may be your preferred method.
The eHealth integration toolkits are a collection of integration tools and sample code resources available in both .NET and Java. The sample code and integration tools are used within the eHealth Reference Platform, forming part of the code library for tools and simulators.
Consumer provided information is a way for consumers to capture information about their health which they believe will assist when dealing with health care.
Context in digital health
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).
From 25 May 2022, software systems and any application using interaction model 4 and provider apps to connect to the My Health Record Software Vendor Test (SVT) environment must trust the new My Health Record public SSL certificates.
The My Health Record SVT environment allows software vendors to build and test the B2B Gateway web services for interactions with the My Health Record system.
Technical specifications to enable developers to connect applications to the My Health Record system via the FHIR® Gateway.
The Australian Digital Health Agency has updated the My Health Record FHIR Gateway specification.
The My Health Record integration toolkit contains libraries for business-to-business (B2B) connectivity to the My Health Record system. The toolkit provides sample code for all operations, schemas used and sample SOAP request and response messages.
The My Health Record Integration Toolkit contains sample code for B2B connectivity to the My Health Record system.
The My Health Record Mobile Developer Welcome Pack is a collection of forms and guides to help new app developers connect to the My Health Record system for the first time.
The My Health Record Software Vendor Welcome Pack is a collection of forms and guides to help new software vendors connect to the My Health Record system for the first time. Some of these documents are also used by existing software vendors to connect their updated software to the My Health Record system.
The Business-to-Business (B2B) Gateway services allow a range of systems to access the My Health Record system, such as clinical systems, systems integrated via a gateway, and contracted service providers acting on behalf of healthcare organisations.
Audience
Notice of changes: Changes are coming for National Authentication Service for Health (NASH) PKI Certificates and the Healthcare Identifiers (HI) Service. Make sure your work plan includes: Transition from SHA-1 to SHA-2 NASH PKI certificates and using a NASH PKI Certificate to access the HI Service. Learn more
The National Consumer Portal (NCP) is the front-end for participating individuals to access My Health Record via desktop or mobile devices.
Consumer functions
Access to:
The high level system architecture is a critical deliverable for the My Health Record system and describes the fundamental organisation of the My Health Record system, embodied in its components, their relationships to each other and the environment, and the principles governing its design and evolution.
This product seeks to assist software vendors with implementing the Clinical Information System to National Provider Portal (CIS to NPP) interface implementation.
The Clinical Package Validator (Validator) provides software developers with enhanced capabilities to achieve a greater degree of automation and depth of their conformance tests of clinical documents.
This guide explains how a requesting clinician can communicate to a pathology or diagnostic imaging provider that they should not upload a report to the patient’s My Health Record.
The Health Record Overview provides a summary of an individual’s My Health Record and is intended to serve as the “home screen” displayed when an individual’s record is first opened.
My Health Record Document Types
Technical specifications to enable developers to connect applications to the My Health Record system via the FHIR® Gateway.
This form is for mobile app developers to enable you to:
For further information about connecting with the My Health Record system, please refer to the App Vendor Guide to the Connection Process, which is distributed as part of the Welcome Pack for developers using the FHIR®[1] Gateway of the My Health Record system.
Expired testing certificates can be resolved by contacting Services Australia Developer Support at:
Overviews, guides and conformance material relating to the My Health Record system.
Can we search for a HPI-I using a doctor's provider or prescriber number?
No, To retrieve a providers HPI-I you will require the following,
1. Clinician demographics (name, sex, dob)
2a. Identifier (AHPRA number, HPI-I)
...
HI Service and My Health Record test endpoint access information:
A contracted service provider (CSP) in the My Health Record system is an organisation that provides technology services or health information management services relating to the My Health Record system to a healthcare provider organisation, under contract to that organisation...
On 25 May, the Australian Digital Health Agency changed the endpoints to the My Health Record Software Vendor Test (SVT) environment and the My Health Record public SSL certificate.
Services Australia advises that there will be a change in the availability of the Developer Support and Online Technical Support (OTS) teams on the upcoming Reconciliation Day Public Holiday on Monday 30 May 2022.
NOTE DATE CHANGE: The upgrade will now take place on Saturday 25 June 2022.
Verizon Australia is a third party organisation who manages the issuance of both Medicare and NASH PKI certificates that are used by Healthcare Organisations to undertake electronic business with Services Australia.
The Australian Digital Health Agency is upgrading Australia’s digital health platform to ensure it continues to meet the needs of Australians into the future. The first key upgrade is a new Health API Gateway that will provide a secure and scalable digital platform for exchanging and accessing health information.
The Australian Digital Health Agency has released the HIPS Provider Application (HPA) v1.0.
The Australian Digital Health Agency provides an introduction to integrating software with the My Health Record system via a one hour webinar recording.
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).
