Skip to main content

Introduction

My Health Record is a secure online summary of an individual’s health information and is available to all Australians. Integrating with My Health Record allows healthcare providers to exchange a wide range of Clinical Documents.

My Health Record has now been natively integrated into over 110 software products and is used broadly across many sectors of healthcare. 

This page provides an overview of the three connection methods to My Health Record Services, and provides a gateway to the resources and guides necessary for software developers to achieve connection to them. 

The Australian Digital Health Agency provides several mechanisms for software to interact with the My Health Record system.

My Health Record B2B Gateway

A connection method that can be used if a developer wishes to provide the full capabilities of the My Health Record system such as uploading clinical content and retrieving clinical data utilising the Clinical Information Systems

My Health Record - Clinical Information System (CIS) to National Provider Portal (NPP)

The My Health Record National Provider Portal (NPP) is a portal which can be accessed by healthcare providers using a browser to view their patients’ My Health Records. 

My Health Record FHIR® Gateway

A connection method utilising Fast Healthcare Interoperability Resources (FHIR®) that can be used by developers who wish to build mobile apps targeted towards consumers

Related content

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.

Developer guides

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.

 

Resources

Clinical Package Validator v3.4.1

Services
ID
EP-4003:2024
Type
Product
Version
3.4.1
Status
Active
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, SMD messages and HL7 v2 messages. Before formally declaring conformance of a software product, developers need to perform additional tests to ensure full…

eHealth Architecture Principles v1.0

Services
ID
EP-1022:2012
Type
Product
Version
1.0
Status
Active
This document describes eHealth architecture principles that can be used to guide architecture developments and solution implementations in the Australian eHealth environment. The main objective is to support delivery systems that are interoperable, flexible and fit for purpose while supporting established rules and processes for communication and use of…

Health Record Overview v1.2

Services
ID
EP-3023:2020
Type
Standard
Product
Version
1.2
Status
Active
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. The Health Record Overview can now be downloaded to clinical information systems for display in whole or part and is an enhancement to the My Health…

HIPS v8.3

ID
EP-3598:2022
Type
Standard
Product
Version
8.3
Status
Active
Software downloads: https://collaborate.digitalhealth.gov.au/display/HIPSP/HIPS+Releases+-+Downloads+and+Documentation For access to the Collaborate Portal please email [email protected] or call 1300 901 001. Online documentation: https://collaborate.digitalhealth.gov.au/display/HIPSP/HIPS+Documentation+Online For access to the Collaborate…

Information Quality Rules v1.6

Services
ID
EP-2895:2019
Type
Product
Version
1.6
Status
Active
The Information Quality Rules (IQ Rules) is a tool that helps developers, testers and analysts determine the quality of clinical documents including the conformance of clinical documents to the My Health Record system conformance requirements. Use of the IQ Rules commenced within the Australian Digital Health Agency (the ‘Agency’) in January…

Interoperability Framework v2.0

Services
ID
EP-1144:2007
Type
Product
Version
2.0
Status
Active
The Agency Interoperability Framework (IF) is a common reference point that provides guidance to business and IT experts in delivering interoperable eHealth systems in Australia.

My Health Record - Data Centre Rehosting - SVT Certificates v1.1

Services
ID
EP-3644:2022
Type
Product
Version
1.1
Status
Active
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.   This is required because the Agency is moving the endpoints for SVT from the current Global Switch data centre to…

My Health Record Integration Toolkit v1.2.2

Services
ID
EP-2603:2018
Type
Standard
Product
Version
1.2.2
Status
Active
The My Health Record Integration Toolkit contains libraries for B2B connectivity to the My Health Record system, providing sample code for all operations, as well as the schemas used and sample SOAP request and response messages. The sample code and integration tools provided here should only be used in conjunction with the Agency’s detailed…

My Health Record Software Vendor Welcome Pack v20231213

ID
EP-3877:2023
Type
Standard
Product
Version
20231213
Status
Active
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. This version includes updated contact details along…

PCEHR Architecture v1.35

Services
ID
EP-1001:2011
Type
Product
Version
1.35
Status
Active
The high level system architecture 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. An effective architecture for the My Health Record system will provide a vehicle for communicating how the system…
My Health Record