Go to top of page

My Health Record B2B Gateway

View all My Health Record B2B Gateway

Advance & End of Life Care

View all Advance & End of Life Care

Goals of Care v1.0

The Goals of Care clinical document type is used to capture advance care information in alignment with Western Australia’s Goals of Patient Care Summary documents.

Advance Care Planning

Advance care planning enables individuals to make choices about their future medical treatment in the event that they are cognitively impaired or otherwise unable to make their preferences known.

Advance Care Document Custodian

Advance care documents let individuals make choices about their future medical treatment in the event that they are cognitively impaired or otherwise unable to make their preferences known.

Clinical Documents

View all Clinical Documents

Goals of Care v1.0

The Goals of Care clinical document type is used to capture advance care information in alignment with Western Australia’s Goals of Patient Care Summary documents.

Specialist Letter v1.3

Specialist Letter documents are used in replying to a referral or reporting on a health event and contain information related to the event or the requested diagnosis or treatment by a specialist.

Clinical Documents - Health Programs

View all Clinical Documents - Health Programs

Pharmaceutical Benefits Report

The Medicare and Department of Veterans’ Affairs (DVA) benefits report records information about pharmaceutical items prescribed and dispensed to an individual that were partially or fully funded under the Pharmaceutical Benefit Schedule (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS)

Medicare DVA Benefits Report

The Medicare and DVA benefits reports records information about Medicare and Department of Veterans’ Affairs (DVA) funded services provided to an individual.

Medicare DVA Benefits Report in the Australian context

Australian Organ Donor Register

The Australian Organ Donor Register (AODR) is the national register for people to record their decision about becoming an organ and tissue donor.

Australian Immunisation Register

The Australian Childhood Immunisation Register (ACIR) was a national data register, established in 1996, that records details of vaccinations given to children under seven years of age who live in Australia and are enrolled in Medicare.

Clinical Informatics

View all Clinical Informatics

My Health Record CIS to NPP - Introduction

Reading 15 minutes, Registration 30 minutes. ​Learning objectives: In this guide, you'll learn, Introduction to CIS to NPP service, CIS to NPP Limitations, Register for CIS-to-NPP implementation, Testing, Vendor conformance process and Go Live requirements

Clinical Terminology

On this page find information on SNOMED® CT-AU, National Clinical Terminology Service and Open Source Software. 

Information Quality Rules v1.6

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.

Participation Data Specification

The participation data specification is a foundation document for the suite of data specifications that the Australian Digital Health Agency is developing for the Australian Health Informatics community across a range of health topics.

Clinical Package Validator

The Clinical Package Validator is a tool to automate some of the tests needed to assess conformance of clinical documents and clinical packages with the eHealth Specifications.

Data types in Agency specifications

This document defines the Australian Digital Health Agency’s required data types as a logical level profile that conforms directly to the draft ISO 21090 standard. The detail included in this specification is less than that specified in the ISO document and the technical detail becomes relevant within the scope of this profile, during construction/implementation of Agency information products.

eSignature v1.1

The Agency’s Electronic Signatures Recommendations document explores the legal context for eSignatures on clinical documents, explains key concepts relating to eSignatures, and analyses the clinical and business risks.

Continuity of Care

View all Continuity of Care

Referral

Referrals in the Australian context

Referrals are communications with the intention of initiating a transfer of responsibility for some aspects of a consumer’s ongoing management from one provider to another across a range of healthcare and human services fields.

Shared Health Summary

The aim of a shared health summary is to provide key pieces of information about an individual’s health status, facilitating care across their entire healthcare domain.

Shared health summary in the Australian context

Discharge Summary

A discharge summary is defined as "A collection of information about events during care by a provider or organisation." [AS4700.6(Int)2007].  It comprises a document produced during a patient's stay in hospital.

Discharge summaries in the Australian context

Developer Resources

View all Developer Resources

NASH SHA-2 Certificates - Developer Guide

This Developer Guide is for the use of developers whose products connect to the Healthcare Identifiers (HI) Service, My Health Record, Electronic Prescribing and Secure Messaging with a National Authentication Service for Health (NASH) PKI Certificate.

My Health Record CIS to NPP - Introduction

Reading 15 minutes, Registration 30 minutes. ​Learning objectives: In this guide, you'll learn, Introduction to CIS to NPP service, CIS to NPP Limitations, Register for CIS-to-NPP implementation, Testing, Vendor conformance process and Go Live requirements

Introduction to the Healthcare Identifier Service

In this guide, you will; Understand high level concepts regarding the HI Service, Register as a developer for the HI Service, Request Test Certificates and Test Environment Data, Install the Test Certificates locally and Import Certificates in CIS Software

Introduction - My Health Record B2B Developer Guides

My Health Record 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 Record to view and add patient health information.

Information Quality Rules v1.6

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.

Secure Messaging Integration Toolkit

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.

Clinical Package Validator

The Clinical Package Validator is a tool to automate some of the tests needed to assess conformance of clinical documents and clinical packages with the eHealth Specifications.

CIS to Open PDS - Electronic Prescribing Developer Guide

This process defines the steps for prescribing and/or dispensing Clinical Information System (CIS) software developers that connect to an open Prescription Delivery Service (PDS) to declare software conformance with the Agency’s Electronic Prescribing technical framework.

My Health Record Integration Toolkit

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.

Clinical Documents Integration Toolkit

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.

Diagnostic Services

View all Diagnostic Services

Pathology

Australian pathology services are provided by public and private laboratories and provide the foundations on which much of the science of medicine is based.

Pathology in the Australian context

Diagnostic Imaging

Diagnostic imaging services are provided by radiology providers in the public and private sectors.

eHealth Diagnostic Imaging Report View v1.1

eHealth diagnostic imaging reports containing one or more examinations or procedures may be uploaded by the diagnostic imaging provider to an individual's digital health record as a PDF. The eHealth Diagnostic Imaging Report View provides a mechanism to list, group and sort those reports in clinical information systems.

Electronic Prescribing

View all Electronic Prescribing

Electronic prescribing provides an option for prescribers and their patients to have a digital prescription as an alternative to a paper prescription. Electronic prescribing is not mandatory, and patients and prescribers will be able to choose an electronic or a paper version of their prescription.

Electronic Prescribing – Industry Offer

Further information about the Electronic Prescribing Industry Offer

The Electronic Prescribing Industry Offer- second round is now closed and all tenderers have been notified of the outcome.

Electronic Prescribing

Electronic prescribing provides an option for prescribers and their patients to have a digital prescription as an alternative to a paper prescription. Electronic prescribing is not mandatory, and patients and prescribers will be able to choose an electronic or a paper version of their prescription.

Electronic Prescribing Conformance Process

The following steps will assist software developers who wish to build products that support electronic prescribing. The Agency offers a range of support services including consultative support and scheduled information sessions. If you require any support to understand the Agency’s conformance requirements or other technical specifications please contact [email protected]. 

Electronic Prescribing – Frequently Asked Questions

The following Electronic Prescribing Frequently Asked Questions (FAQs) are categorised into the following topics: General, Dispensing and Technical Questions along with a Glossary and links to more information. 

eHealth Prescription Record v1.2.1

eHealth prescription record documents can be used to share information about prescribed medications via the individual’s digital health record. Documents of this type do not represent actual prescriptions, but merely support the sharing of information about medication prescriptions via the individual’s digital health record.

Electronic Transfer of Prescription

Electronic Transfer of Prescription (ETP) involves the creation of an electronic message (alongside a legal paper prescription) which is transmitted to a prescription exchange service (PES).

eHealth Prescription and Dispense View v1.2.2

eHealth Prescription and Dispense View documents represent an electronic summary of information about medication prescriptions and dispensations contained in an individual’s My Health Record.

CIS to Open PDS - Electronic Prescribing Developer Guide

This process defines the steps for prescribing and/or dispensing Clinical Information System (CIS) software developers that connect to an open Prescription Delivery Service (PDS) to declare software conformance with the Agency’s Electronic Prescribing technical framework.

Healthcare Identifiers Service

View all Healthcare Identifiers Service

Introduction to the Healthcare Identifier Service

In this guide, you will; Understand high level concepts regarding the HI Service, Register as a developer for the HI Service, Request Test Certificates and Test Environment Data, Install the Test Certificates locally and Import Certificates in CIS Software

Introduction - My Health Record B2B Developer Guides

My Health Record 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 Record to view and add patient health information.

HI Test and Go Live

All products developed, or updated, to connect with the HI Service are required to undergo testing before production access is granted.

There are two mandatory testing processes that you will need to complete:

Healthcare Identifiers Service (HI)

The Healthcare Identifiers Service (HI) is a national system for uniquely identifying individuals and healthcare providers. HIs help to ensure individuals and providers can have confidence that the correct information is associated with the correct individual at the point of care.

HIPS

View all HIPS

HIPS v8.2

The HIPS product enables the seamless integration of digital health systems with national digital health infrastructure services, such as the Healthcare Identifiers Service, the My Health Record system.

Medicines Management

View all Medicines Management

Electronic Prescribing

Electronic prescribing provides an option for prescribers and their patients to have a digital prescription as an alternative to a paper prescription. Electronic prescribing is not mandatory, and patients and prescribers will be able to choose an electronic or a paper version of their prescription.

Pharmacist Shared Medicines List (PSML)

The Pharmacist Shared Medicines List (PSML) is a new clinical document type supported by the My Health Record system. 

The PSML contains detailed information about medicines the consumer is known to be taking when the list was created.

eHealth Prescription Record v1.2.1

eHealth prescription record documents can be used to share information about prescribed medications via the individual’s digital health record. Documents of this type do not represent actual prescriptions, but merely support the sharing of information about medication prescriptions via the individual’s digital health record.

Electronic Transfer of Prescription

Electronic Transfer of Prescription (ETP) involves the creation of an electronic message (alongside a legal paper prescription) which is transmitted to a prescription exchange service (PES).

Dispense Records

Dispense Records are used to transfer details of a dispense record, in a format suitable for sharing within My Health Record.

Dispense Records in the Australian context

National Authentication Service for Health (NASH)

View all National Authentication Service for Health (NASH)

Transition to NASH SHA-2 Certificates - FAQs

The following frequently asked questions relate to the transition to NASH SHA-2 compliant certificates by 13 March 2022. NASH SHA-1 Certificates will no longer be issued after this date.

NASH SHA-2 Certificates - Developer Guide

This Developer Guide is for the use of developers whose products connect to the Healthcare Identifiers (HI) Service, My Health Record, Electronic Prescribing and Secure Messaging with a National Authentication Service for Health (NASH) PKI Certificate.

Transition to NASH SHA-2 Certificates

Australia’s Digital Health system is rapidly growing and evolving and as part of that evolution, the Agency is working closely with Services Australia, software developers, and healthcare organisations to implement enhancements to the National Authentication Service for Health (NASH). These enhancements will provide enhanced security protection for healthcare information and reduce the need for healthcare organisations to manage multiple certificates. 

Introduction - My Health Record B2B Developer Guides

My Health Record 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 Record to view and add patient health information.

National Authentication Service for Health (NASH)

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

Mobile Applications

View all Mobile Applications

Mobile integration with My Health Record

The Australian Digital Health Agency aims to increase adoption of the My Health Record by connecting the My Health Record platform to mobile applications through industry standard APIs. 

Included below is key information about getting started and key forms required to connect to My Health Record Mobile Gateway. Learn more....

FHIR Gateway (Mobile)

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).

My Health Record

View all My Health Record

My Health Record CIS to NPP - Introduction

Reading 15 minutes, Registration 30 minutes. ​Learning objectives: In this guide, you'll learn, Introduction to CIS to NPP service, CIS to NPP Limitations, Register for CIS-to-NPP implementation, Testing, Vendor conformance process and Go Live requirements

PCEHR Architecture v1.35

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.

Mobile integration with My Health Record

The Australian Digital Health Agency aims to increase adoption of the My Health Record by connecting the My Health Record platform to mobile applications through industry standard APIs. 

Included below is key information about getting started and key forms required to connect to My Health Record Mobile Gateway. Learn more....

National Consumer Portal

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:

National Authentication Service for Health (NASH)

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

FHIR Gateway (Mobile)

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).

Consumer Provided Information

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

My Health Record Integration Toolkit

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.

Clinical Documents Integration Toolkit

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.

Secure Messaging

View all Secure Messaging

Secure Messaging v1.1

The Agency’s Secure Messaging product provides software developers with information and tools to assist in the implementation of Secure Message Delivery (SMD) and the Australian Provider Directory Service FHIR Implementation Guide (AU-PD).

Secure Messaging Industry Offer

The Agency is providing developers of clinical information and secure messaging systems with a financial incentive to deliver enhanced functionality in an accelerated timeframe.

Secure Messaging Integration Toolkit

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.

Clinical Package Validator

The Clinical Package Validator is a tool to automate some of the tests needed to assess conformance of clinical documents and clinical packages with the eHealth Specifications.

Secure Messaging

As part of the Australian National Digital Health Strategy, the Agency aims to end dependence on paper based correspondence and the fax machine or postal services by 2022.

eSignature v1.1

The Agency’s Electronic Signatures Recommendations document explores the legal context for eSignatures on clinical documents, explains key concepts relating to eSignatures, and analyses the clinical and business risks.

Specialists Software

View all Specialists Software

Specialists Software Industry Offer

Latest: Specialists Software Industry Offer - 2nd Tranche - Industry Briefing - 8 April 2021. Refer Slide Pack, Webinar Recording and Q&A Panel Session. Learn more.

Second tranche for the Specialist Software Industry Offer

The Agency is pleased to announce a second tranche for the Specialist Software Industry Offer, for software developers whose clinical information systems are used by private specialists in Australia to enhance their systems to seamlessly and securely integrate with My Health Record.

eHealth Prescription Record v1.2.1

eHealth prescription record documents can be used to share information about prescribed medications via the individual’s digital health record. Documents of this type do not represent actual prescriptions, but merely support the sharing of information about medication prescriptions via the individual’s digital health record.

Specialist Letter

Specialist letters are used in replying to a referral or reporting on a health event. They contain information related to the event or the requested diagnosis or treatment by a specialist.

Event Summary

The aim of an event summary is to add significant health care information to an individual’s electronic health record, at the discretion of the clinician and with the consent of the individual.

Testing & Conformance

View all Testing & Conformance

Electronic Prescribing Conformance Process

The following steps will assist software developers who wish to build products that support electronic prescribing. The Agency offers a range of support services including consultative support and scheduled information sessions. If you require any support to understand the Agency’s conformance requirements or other technical specifications please contact [email protected]. 

HI Test and Go Live

All products developed, or updated, to connect with the HI Service are required to undergo testing before production access is granted.

There are two mandatory testing processes that you will need to complete: