The Australian Digital Health Agency's Implementer Hub offers guides to assist software developers connecting digital health solutions to each other and to the national infrastructure. Find guides using the search bar by keywords, service, or topic. Guide search Keywords Service - Any -Health Connect AustraliaHealthcare Identifiers (HI) ServiceNational Authentication Service for Health (NASH)My Health Record-My Health Record B2B Gateway-My Health Record FHIR® Gateway-My Health Record - Clinical Information System (CIS) to National Provider Portal (NPP)Healthcare Information Provider Service (HIPS)Provider Connect Australia™ (PCA™)Electronic PrescribingSecure MessagingNational Clinical Terminology Service (NCTS) Topic - Any -Advance careAged careClinical documentsClinical governanceClinical Information System StandardsCoordinated careSecure development practicesTesting and conformance Status - Any -Active (stable)DraftRetiredTrialActiveSupersededWithdrawnArchived Healthcare Identifiers Integration Toolkit Category Guidance Document Services Healthcare Identifiers (HI) Service Organisation ADHA ID DG-3106 Type Guide Created date 10/07/2025 The Healthcare Identifiers Integration Toolkit contains libraries for B2B connectivity to the HI Service, used to search for IHI, HPI-Is and HPI-Os.The sample code and integration tools provided here should only be used in conjunction with the Agency's detailed specifications for the HI Service and, where appropriate, by working with technical and other connectivity instruction provided by the System Operator of the Healthcare Identifiers Service. Health Connect Australia – FAQs Services Health Connect Australia Type Guide Status Active FAQs - Health Connect Australia Provider Directory FHIR IG (HCAPD FHIR IG) Kick-off Meeting Clinical Information System Standards - Frequently asked questions (FAQs) Topics Clinical Information System Standards Type Guide PCA™ - Code Samples Services Provider Connect Australia™ (PCA™) ID DG-3049 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The following code samples are written in Python and provided as samples only. Security resources Topics Secure development practices ID DG-3122 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Security resources from our Cyber Security Awareness team. My Health Record B2B Gateway - Registration Services My Health Record B2B Gateway ID DG-3072 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 My Health Record integration is typically done in two steps. Connecting to the HI Service and the My Health Record system. HI Service - IHI Lookup Services Healthcare Identifiers (HI) Service My Health Record B2B Gateway ID DG-3068 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 Your software will need to conduct lookups for Individual Healthcare Identifiers (IHIs) for patients. HI Service - IHI Lookup - Test Cases Services Healthcare Identifiers (HI) Service My Health Record B2B Gateway ID DG-3069 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 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. HI Service - Search for HPI-I Services Healthcare Identifiers (HI) Service My Health Record B2B Gateway ID DG-3092 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 It is highly recommended that your software conduct HPI-I searches for users of your system. My Health Record B2B Gateway - Find whether a My Health Record exists Services My Health Record B2B Gateway ID DG-3056 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3057 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3063 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3066 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3104 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide will walk through the steps to create and upload clinical documents Electronic Prescribing - Mobile Intermediary System - Conformance Process Services Electronic Prescribing Topics Testing and conformance ID DG-3077 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 10/03/2025 A mobile intermediary system is a software product that a mobile application uses to connect to, and interact with, the National Prescription Delivery Service (NPDS) and/or Active Script List Registry (ASLR). Electronic Prescribing - Mobile Applications - Conformance Process Services Electronic Prescribing Topics Testing and conformance ID DG-3076 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 31/01/2024 A mobile application or web-based application can be used by a subject of care or carer to manage prescriptions and to present an electronic prescription token to a pharmacy. My Health Record B2B Gateway - Supersede document Services My Health Record B2B Gateway ID DG-3101 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide describes the steps to supersede a Clinical Document in the My Health Record system My Health Record B2B Gateway - Remove document Services My Health Record B2B Gateway ID DG-3091 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide will describe the steps to remove a Clinical Document My Health Record CIS to NPP - Registration, Testing Requirements Services My Health Record - Clinical Information System (CIS) to National Provider Portal (NPP) ID DG-3079 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Before you can begin development, you are required to register for access to the My Health Record system My Health Record CIS to NPP - Complete Implementation Services My Health Record - Clinical Information System (CIS) to National Provider Portal (NPP) ID DG-3078 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In this guide, we will cover; How to implement CIS to NPP into your software, Solution overview and Conformance Test Requirements HI Service - Additional requirements for Electronic Prescribing Services Electronic Prescribing Healthcare Identifiers (HI) Service ID DG-3041 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide discusses potential changes required in your software. PCA™ - API Reference Services Provider Connect Australia™ (PCA™) ID DG-3042 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Outlines the API calls available to developers who wish to connect software to PCA™ PCA™ - Authorise publication Services Provider Connect Australia™ (PCA™) ID DG-3043 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Currently, the only channel to authorise publication of service offerings is through the PCA™ Portal. PCA™ - Update business partner identifier Services Provider Connect Australia™ (PCA™) ID DG-3103 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In cases when a publisher submits a business partner identifier and the business partner identifies that an incorrect identifier has been provided the business partner can patch the identifier provided in PCA™. Current page 1 Page 2 Page 3 Page 4 Next page ›› Last page Last »
Healthcare Identifiers Integration Toolkit Category Guidance Document Services Healthcare Identifiers (HI) Service Organisation ADHA ID DG-3106 Type Guide Created date 10/07/2025 The Healthcare Identifiers Integration Toolkit contains libraries for B2B connectivity to the HI Service, used to search for IHI, HPI-Is and HPI-Os.The sample code and integration tools provided here should only be used in conjunction with the Agency's detailed specifications for the HI Service and, where appropriate, by working with technical and other connectivity instruction provided by the System Operator of the Healthcare Identifiers Service.
Health Connect Australia – FAQs Services Health Connect Australia Type Guide Status Active FAQs - Health Connect Australia Provider Directory FHIR IG (HCAPD FHIR IG) Kick-off Meeting
Clinical Information System Standards - Frequently asked questions (FAQs) Topics Clinical Information System Standards Type Guide
PCA™ - Code Samples Services Provider Connect Australia™ (PCA™) ID DG-3049 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The following code samples are written in Python and provided as samples only.
Security resources Topics Secure development practices ID DG-3122 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Security resources from our Cyber Security Awareness team.
My Health Record B2B Gateway - Registration Services My Health Record B2B Gateway ID DG-3072 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 My Health Record integration is typically done in two steps. Connecting to the HI Service and the My Health Record system.
HI Service - IHI Lookup Services Healthcare Identifiers (HI) Service My Health Record B2B Gateway ID DG-3068 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 Your software will need to conduct lookups for Individual Healthcare Identifiers (IHIs) for patients.
HI Service - IHI Lookup - Test Cases Services Healthcare Identifiers (HI) Service My Health Record B2B Gateway ID DG-3069 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 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.
HI Service - Search for HPI-I Services Healthcare Identifiers (HI) Service My Health Record B2B Gateway ID DG-3092 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 It is highly recommended that your software conduct HPI-I searches for users of your system.
My Health Record B2B Gateway - Find whether a My Health Record exists Services My Health Record B2B Gateway ID DG-3056 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3057 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3063 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3066 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 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 Services My Health Record B2B Gateway ID DG-3104 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide will walk through the steps to create and upload clinical documents
Electronic Prescribing - Mobile Intermediary System - Conformance Process Services Electronic Prescribing Topics Testing and conformance ID DG-3077 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 10/03/2025 A mobile intermediary system is a software product that a mobile application uses to connect to, and interact with, the National Prescription Delivery Service (NPDS) and/or Active Script List Registry (ASLR).
Electronic Prescribing - Mobile Applications - Conformance Process Services Electronic Prescribing Topics Testing and conformance ID DG-3076 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 31/01/2024 A mobile application or web-based application can be used by a subject of care or carer to manage prescriptions and to present an electronic prescription token to a pharmacy.
My Health Record B2B Gateway - Supersede document Services My Health Record B2B Gateway ID DG-3101 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide describes the steps to supersede a Clinical Document in the My Health Record system
My Health Record B2B Gateway - Remove document Services My Health Record B2B Gateway ID DG-3091 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide will describe the steps to remove a Clinical Document
My Health Record CIS to NPP - Registration, Testing Requirements Services My Health Record - Clinical Information System (CIS) to National Provider Portal (NPP) ID DG-3079 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Before you can begin development, you are required to register for access to the My Health Record system
My Health Record CIS to NPP - Complete Implementation Services My Health Record - Clinical Information System (CIS) to National Provider Portal (NPP) ID DG-3078 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In this guide, we will cover; How to implement CIS to NPP into your software, Solution overview and Conformance Test Requirements
HI Service - Additional requirements for Electronic Prescribing Services Electronic Prescribing Healthcare Identifiers (HI) Service ID DG-3041 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide discusses potential changes required in your software.
PCA™ - API Reference Services Provider Connect Australia™ (PCA™) ID DG-3042 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Outlines the API calls available to developers who wish to connect software to PCA™
PCA™ - Authorise publication Services Provider Connect Australia™ (PCA™) ID DG-3043 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Currently, the only channel to authorise publication of service offerings is through the PCA™ Portal.
PCA™ - Update business partner identifier Services Provider Connect Australia™ (PCA™) ID DG-3103 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In cases when a publisher submits a business partner identifier and the business partner identifies that an incorrect identifier has been provided the business partner can patch the identifier provided in PCA™.