My Health Record is a secure online summary of an individual’s health information and is available to all Australians.
Through the Business to Business (B2B) Gateway, healthcare providers can access timely information and clinical documents about their patients, such as shared health summaries, discharge summaries, prescription and dispense records, pathology reports, diagnostic imaging reports and other clinical documents.
Updates to My Health Record Connecting Systems – Security Conformance Profile
The Agency published the My Health Record Connecting Systems Security Conformance Profile v1.0 on the Agency’s Developer Portal in September 2024. Learn more.
Registration Overview
Integration with My Health Record is carried out through a two-step process:
- Integrate with the HI Service,
- Integrate with the My Health Record system.
Pre-requisites
To begin, you must have completed the following:
Important
Please initiate the registration processes for both HI and the My Health Record system immediately, as there will be some turnaround time for responses, and you will require Test C.
Prepare for development
If you are interested in integrating your software with the My Health Record system, we recommend starting by reviewing our Getting started education modules.
Pre-Reading
- Welcome Pack materials
- Software Vendor Guide to the Connection Process
- Software Vendor Support Contacts
Read through My Health Record B2B Developer Guides
- Find whether a My Health Record exists
- Gain access to a My Health Record
- Get Documents and View Document
- Get Views
- Upload Document
- Supersede Document
- Remove Document
To continue reading, go to My Health Record B2B Gateway – Registration Developer Guide below.
Related content
Gateways
Discover our API gateways
Getting started education modules
If you are interested in integrating your software with the My Health Record system, we recommend starting by reviewing our education modules.
Services Australia advice: Availability for Christmas and New Year 2024/2025
Due to scheduled maintenance, there will be an outage to the vendor environment between approximately 8.00pm-10.00pm on Tuesday 26 November 2024 (AEDT).
Updates to My Health Record Connecting Systems – Security Conformance Profile
The Agency published the My Health Record Connecting Systems Security Conformance Profile v1.0 (Security Profile) on the Agency’s Developer Portal in September 2024.
Developer guides
My Health Record B2B Gateway - Registration
My Health Record integration is typically done in two steps. Connecting to the HI Service and the My Health Record system.
My Health Record B2B Gateway - Find whether a My Health Record exists
This developer guide helps you to verify whether a My Health Record exists for a patient using their Individual Healthcare Identifier (IHI)
My Health Record B2B Gateway - Gain access to a My Health Record
This guide walks through the steps to access a patient’s My Health Record using the GainPCEHRAccess web service
My Health Record B2B Gateway - Get Patient Document List and View Document
This guide will walk through the process to get patient clinical documents from the My Health Record system and display them to your users using a generic style sheet
My Health Record B2B Gateway - Get Views
This guide will use the My Health Record getView web service to download collated information from a My Health Record in a ‘View’
My Health Record B2B Gateway - Upload document
This guide will walk through the steps to create and upload clinical documents
My Health Record B2B Gateway - Supersede document
This guide describes the steps to supersede a Clinical Document in the My Health Record system
My Health Record B2B Gateway - Remove document
This guide will describe the steps to remove a Clinical Document
Open Source Sample Code Directory - GitHub and NuGet
The Agency provides sample code directly on GitHub, NuGet, and Maven.
HI Service - Search for HPI-I
It is highly recommended that your software conduct HPI-I searches for users of your system.
My Health Record Document Types
The My Health Record system uses document class codes and type codes as critical metadata elements to enhance the search and discovery of clinical documents.
Pharmacist Shared Medicines List (PSML)
The Pharmacist Shared Medicines List (PSML) is a clinical document type supported by the My Health Record system.
What are the test endpoints?
HI Service and My Health Record test endpoint access information:
HI Service - IHI Lookup
Your software will need to conduct lookups for Individual Healthcare Identifiers (IHIs) for patients.
HI Service - IHI Lookup - Test Cases
After successfully executing the IHI Lookup, it is important to modify your implementation to meet the Test Cases for the Use Cases we have built to UC.010 and UC.015.