The Australian Digital Health Agency's Developer Portal (this site) provides developer guides to assist software developers connecting digital health solutions to each other and to the national infrastructure.
PCA™ - Code Samples
The following code samples are written in Python and provided as samples only.
Security resources
Security resources from our Cyber Security Awareness team.
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.
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.
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 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
Electronic Prescribing - Mobile Intermediary System - Conformance Process
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
A mobile application or web-based application is 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
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
My Health Record CIS to NPP - Registration, Testing Requirements
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
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
This guide will discuss potential changes which are required in your software.
PCA™ - API Reference
Outlines the client registration operations available through the API.
PCA™ - Authorise publication
Currently, the only channel to authorise publication of service offerings is through the PCA™ Portal.
PCA™ - Update business partner identifier
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™.
Electronic Prescribing - CIS to NPDS or ASLR
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
The following steps will assist Clinical Information System (CIS) software developers with a direct Prescription Delivery Service (PDS), declare software conformance with the Agency’s Electronic Prescribing technical framework.
PCA™ - Client registration
Register our system as a client with the PCA™ Identity and Access Manager as per OAuth 2.0 Dynamic Client Registration Protocol – RFC 7591.