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 Electronic Prescribing - CIS to NPDS or ASLR Services Electronic Prescribing ID DG-3045 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 10/03/2025 The following steps will assist prescribing and dispensing Clinical Information System (CIS) software developers connect to the National Prescription Delivery Service (NPDS) and declare software conformance with the Agency’s Electronic Prescribing technical framework. Electronic Prescribing - CIS with a Direct PDS Services Electronic Prescribing ID DG-3046 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 10/03/2025 The following steps will assist Clinical Information System (CIS) software developers with a direct Prescription Delivery Service (PDS), declare software conformance with Australia Digital Health Agency (the Agency’s) Electronic Prescribing technical framework. PCA™ - Client registration Services Provider Connect Australia™ (PCA™) ID DG-3047 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Register our system as a client with the PCA™ Identity and Access Manager as per OAuth 2.0 Dynamic Client Registration Protocol – RFC 7591. My Health Record FHIR® Mobile Gateway - Clinical Document Service Category Guidance Document Services My Health Record FHIR® Gateway Topics Clinical documents Organisation ADHA ID DG-3048 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In this guide, we will be accessing Prescription and Dispense List and Allergies List contained in a patient’s clinical document service PCA™ - Count and paging Services Provider Connect Australia™ (PCA™) ID DG-3050 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The _count search parameter returns the number of requested resources per page (excluding the resources returned with _include search parameter) as requested by the client. PCA™ - Create healthcare service Services Provider Connect Australia™ (PCA™) ID DG-3051 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Now that we have created a Location we want to add one or more Healthcare services that are delivered at that Location. PCA™ - Create location Services Provider Connect Australia™ (PCA™) ID DG-3052 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 We have already created the Organization resource as part of the participation configuration process and now we need to create Locations for the Organisation. PCA™ - Create practitioner role Services Provider Connect Australia™ (PCA™) ID DG-3053 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Now that you have created an Organization and HealthcareService at a Location, and have found a Practitioner, you can create a PractitionerRole. My Health Record - Mobile integration Services My Health Record FHIR® Gateway ID DG-3121 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The Australian Digital Health Agency aims to increase the adoption of the My Health Record by connecting the My Health Record platform to mobile applications through industry-standard APIs. My Health Record FHIR® Mobile Gateway - Environment Setup and Authentication Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3054 Type Standard Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Within these guides we will demonstrate the functionality of the FHIR® Gateway using Xamarin.Forms in Visual Studio and the Android Emulator PCA™ - Generate JWT Services Provider Connect Australia™ (PCA™) ID DG-3059 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Before a client can interact with the PCA™, it needs to generate a JSON Web Token (JWT) - RFC7519 that will be used to authenticate the client to the PCA™ Identity and Access Manager. My Health Record FHIR® Mobile Gateway - Generic Document Services Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3060 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide will look at retrieving all clinical document data (including these 2, but excluding MBS documents) PCA™ - Get access token Services Provider Connect Australia™ (PCA™) ID DG-3061 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Once you have a signed authentication JWT, the client can request an access token. PCA™ - Get information use statement Services Provider Connect Australia™ (PCA™) ID DG-3062 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 When you have found a partner service (HealthcareService), you can download the information use statement to inform the publication authorise operation. PCA™ - Get service offerings Services Provider Connect Australia™ (PCA™) ID DG-3064 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Based on the criteria defined in the notification channel above and upon receipt of POST to https://sm-r-us.com.au/my-notification-channel2 the subscriber issues a search operation. PCA™ - Get status of matched records Services Provider Connect Australia™ (PCA™) ID DG-3065 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Once a business partner has attempted to match the service offerings that a publisher has authorised, it may provide the status of those matches back to the PCA™ for the publisher to download. This provides confirmation back to the publisher of the status of matched records. PCA™ - Getting started Services Provider Connect Australia™ (PCA™) ID DG-3067 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The developer guide is intended to get you up-and-running with using the PCA™ API. It covers everything you need to know from registration, authorisation, participation to publication and subscription. PCA™ - Implementation patterns Services Provider Connect Australia™ (PCA™) ID DG-3070 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This section outlines a common implementation pattern for writing (creating / updating) information with the PCA™. My Health Record FHIR® Mobile Gateway - Registration and Overview Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3073 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In this tutorial, you will; register as a developer for the Gateway, understand your testing obligations and more HI Service - Registration and Certificates Services Healthcare Identifiers (HI) Service ID DG-3074 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 In this guide, you will register as a developer for the HI Service, request test certificates and test environment data, install the test certificates locally, import certificates in CIS software. My Health Record FHIR® Mobile Gateway - Medicare and PBS Information Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3075 Type Standard Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 When a patient has an appointment with a healthcare provider, and that healthcare provider is eligible for a Medicare rebate, a Medicare Benefits Schedule (MBS) clinical document is sent to Medicare NASH SHA-2 Certificates - Developer Guide Services Electronic Prescribing Healthcare Identifiers (HI) Service National Authentication Service for Health (NASH) Secure Messaging Topics Secure development practices ID DG-3080 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This developer guide is for developers whose products connect to the HI Service, My Health Record, electronic prescribing and secure messaging using a NASH (National Authentication Service for Health) PKI certificate. PCA™ - Participation configuration Services Provider Connect Australia™ (PCA™) ID DG-3082 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Before using PCA™ as a publisher or subscriber, an organisation must, register, submit a participation agreement by an individual representative of the organisation, authorise a client for that organisation. My Health Record FHIR® Mobile Gateway - Patient Details and Record List Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3083 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 We will use the token received from MyGov to access the patient’s My Health Record First page « First Previous page ‹‹ Page 1 Current page 2 Page 3 Page 4 Next page ›› Last page Last »
Electronic Prescribing - CIS to NPDS or ASLR Services Electronic Prescribing ID DG-3045 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 10/03/2025 The following steps will assist prescribing and dispensing Clinical Information System (CIS) software developers connect to the National Prescription Delivery Service (NPDS) and declare software conformance with the Agency’s Electronic Prescribing technical framework.
Electronic Prescribing - CIS with a Direct PDS Services Electronic Prescribing ID DG-3046 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 10/03/2025 The following steps will assist Clinical Information System (CIS) software developers with a direct Prescription Delivery Service (PDS), declare software conformance with Australia Digital Health Agency (the Agency’s) Electronic Prescribing technical framework.
PCA™ - Client registration Services Provider Connect Australia™ (PCA™) ID DG-3047 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Register our system as a client with the PCA™ Identity and Access Manager as per OAuth 2.0 Dynamic Client Registration Protocol – RFC 7591.
My Health Record FHIR® Mobile Gateway - Clinical Document Service Category Guidance Document Services My Health Record FHIR® Gateway Topics Clinical documents Organisation ADHA ID DG-3048 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In this guide, we will be accessing Prescription and Dispense List and Allergies List contained in a patient’s clinical document service
PCA™ - Count and paging Services Provider Connect Australia™ (PCA™) ID DG-3050 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The _count search parameter returns the number of requested resources per page (excluding the resources returned with _include search parameter) as requested by the client.
PCA™ - Create healthcare service Services Provider Connect Australia™ (PCA™) ID DG-3051 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Now that we have created a Location we want to add one or more Healthcare services that are delivered at that Location.
PCA™ - Create location Services Provider Connect Australia™ (PCA™) ID DG-3052 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 We have already created the Organization resource as part of the participation configuration process and now we need to create Locations for the Organisation.
PCA™ - Create practitioner role Services Provider Connect Australia™ (PCA™) ID DG-3053 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Now that you have created an Organization and HealthcareService at a Location, and have found a Practitioner, you can create a PractitionerRole.
My Health Record - Mobile integration Services My Health Record FHIR® Gateway ID DG-3121 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The Australian Digital Health Agency aims to increase the adoption of the My Health Record by connecting the My Health Record platform to mobile applications through industry-standard APIs.
My Health Record FHIR® Mobile Gateway - Environment Setup and Authentication Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3054 Type Standard Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Within these guides we will demonstrate the functionality of the FHIR® Gateway using Xamarin.Forms in Visual Studio and the Android Emulator
PCA™ - Generate JWT Services Provider Connect Australia™ (PCA™) ID DG-3059 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Before a client can interact with the PCA™, it needs to generate a JSON Web Token (JWT) - RFC7519 that will be used to authenticate the client to the PCA™ Identity and Access Manager.
My Health Record FHIR® Mobile Gateway - Generic Document Services Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3060 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This guide will look at retrieving all clinical document data (including these 2, but excluding MBS documents)
PCA™ - Get access token Services Provider Connect Australia™ (PCA™) ID DG-3061 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Once you have a signed authentication JWT, the client can request an access token.
PCA™ - Get information use statement Services Provider Connect Australia™ (PCA™) ID DG-3062 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 When you have found a partner service (HealthcareService), you can download the information use statement to inform the publication authorise operation.
PCA™ - Get service offerings Services Provider Connect Australia™ (PCA™) ID DG-3064 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Based on the criteria defined in the notification channel above and upon receipt of POST to https://sm-r-us.com.au/my-notification-channel2 the subscriber issues a search operation.
PCA™ - Get status of matched records Services Provider Connect Australia™ (PCA™) ID DG-3065 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Once a business partner has attempted to match the service offerings that a publisher has authorised, it may provide the status of those matches back to the PCA™ for the publisher to download. This provides confirmation back to the publisher of the status of matched records.
PCA™ - Getting started Services Provider Connect Australia™ (PCA™) ID DG-3067 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 The developer guide is intended to get you up-and-running with using the PCA™ API. It covers everything you need to know from registration, authorisation, participation to publication and subscription.
PCA™ - Implementation patterns Services Provider Connect Australia™ (PCA™) ID DG-3070 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This section outlines a common implementation pattern for writing (creating / updating) information with the PCA™.
My Health Record FHIR® Mobile Gateway - Registration and Overview Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3073 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 In this tutorial, you will; register as a developer for the Gateway, understand your testing obligations and more
HI Service - Registration and Certificates Services Healthcare Identifiers (HI) Service ID DG-3074 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 18/07/2025 In this guide, you will register as a developer for the HI Service, request test certificates and test environment data, install the test certificates locally, import certificates in CIS software.
My Health Record FHIR® Mobile Gateway - Medicare and PBS Information Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3075 Type Standard Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 When a patient has an appointment with a healthcare provider, and that healthcare provider is eligible for a Medicare rebate, a Medicare Benefits Schedule (MBS) clinical document is sent to Medicare
NASH SHA-2 Certificates - Developer Guide Services Electronic Prescribing Healthcare Identifiers (HI) Service National Authentication Service for Health (NASH) Secure Messaging Topics Secure development practices ID DG-3080 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 This developer guide is for developers whose products connect to the HI Service, My Health Record, electronic prescribing and secure messaging using a NASH (National Authentication Service for Health) PKI certificate.
PCA™ - Participation configuration Services Provider Connect Australia™ (PCA™) ID DG-3082 Type Guide Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 Before using PCA™ as a publisher or subscriber, an organisation must, register, submit a participation agreement by an individual representative of the organisation, authorise a client for that organisation.
My Health Record FHIR® Mobile Gateway - Patient Details and Record List Category Guidance Document Services My Health Record FHIR® Gateway Organisation ADHA ID DG-3083 Type Guide Standard Version 1.0 Status Active Created date 02/06/2023 Updated date 05/06/2023 We will use the token received from MyGov to access the patient’s My Health Record