Healthcare Identifiers Pre-Requisites

Complete the following steps in this section to start developing new products that connect to the Healthcare Identifiers Service, or to modify existing ones.

PCEHR means the My Health Record, formerly the "Personally Controlled Electronic Health Record", within the meaning of the My Health Records Act 2012 (Cth), formerly called the Personally Controlled Electronic Health Records Act 2012 (Cth).

By operation of the Public Governance, Performance and Accountability (Establishing the Australian Digital Health Agency) Rule 2016, on 1 July 2016, all the assets and liabilities of NEHTA will vest in the Australian Digital Health Agency. In this website, on and from 1 July 2016, all references to "National E-Health Transition Authority" or "NEHTA" will be deemed to be references to the Australian Digital Health Agency.

Accept the Licence Agreement – Use of the Healthcare Identifiers Licensed Material for Notice of Connection

A licence agreement establishing the terms and conditions must be in place between you and the Department of Human Services before you can access the official Healthcare Identifiers (HI) Licensed Material and vendor environment.

To accept the Licence Agreement you must complete the following webform:

You can find further information on the Human Services’ software developer website:

When you have accepted the terms and conditions, the Online Technical Support (OTS) Liaison Team will email you a logon ID and password (usually within two working days), and more information on how to access the vendor environment.

Download the Healthcare Identifiers Licensed Materials

You can access these materials if you have accepted the terms and conditions in the Licence Agreement – Use of the Healthcare Identifiers Licensed Material for Notice of Connection, and received your login ID and password (see step 1).

The HI Licensed Material contains approximately 40 documents for developers interested in creating products for the HI Service. It is unlikely that you will need to read all these documents. We recommend that you start with:

  • HI Service – Developers Guide
  • HI Service - IHI Searching Guide

The other documents each relate specifically to an individual web service of the HI Service. Most developers will only be interested in a subset of these services, so will only need to read the documents relevant to the services of interest.

Receive your Healthcare Identifiers certificates and familiarise yourself with the Healthcare Identifiers Software Vendor Test (HI SVT) environment

When you receive credentials for the HI Licensed Material, the Department of Human Services will ask for your software name and version number so that they can generate your testing certificates. Once you receive these certificates, you will be able to access the HI SVT environment for help with product development and to test for a Notice of Connection (NOC).

The SVT can help you:

  • Develop and test business-to-business (B2B) web services for the HI Service
  • Develop and test access to the Department of Human Services’ technical infrastructure using Public Key Infrastructure (PKI)
  • Conduct NOC testing
  • Conduct conformance testing

If you have access to the HI Licensed Materials, but do not have certificates to access the HI SVT environment, please contact the HI Service OTS Liaison Team on [email protected], or 1300 550 115.

Plan the scope of your Healthcare Identifiers Implementation

If you are connecting to the HI Service as a pre-requisite to connecting to the My Health Record system, there are particular requirements that you will need to meet in order to be given production access to the My Health Record system. These requirements are explained in section 3.4.1 of the PCEHR Connecting Systems Conformance Assessment Scheme. We recommend that you also familiarise yourself with the following use cases:

  • IHIs: UC.010, UC.015
  • Batch search IHIs: UC.025
  • HPI-Is: UC.130, UC.131, UC.240
  • HPI-Os: UC.241, UC.305, UC.306

It is important to understand that each HI Service web service maps to a HI Service use case. You need to determine which web service and use case you require in your product.

If you do not need to either access the My Health Record system or be listed in the Digital Health Incentive Product Register, then you can implement whichever HI use cases are appropriate.

GP desktop software

This section is applicable if your software will be used by general practitioners (GPs). The Practice Incentives Program (PIP) provides financial incentives for GPs to improve the way they use technology in their practice. Some of these improvements relate to the use of the HI Service and the My Health Record system. For more information about PIP, see:

The Practice Incentives Program (PIP) Digital Health Incentive Product Registeris a listing of software products containing information supplied by the software vendor. It helps GPs identify which vendors offer software that meets PIP requirements. Your software product is eligible for inclusion on this register if you declare conformance with the requirements for each product by completing and submitting a Declaration of Conformity.

See for more information. If you want your software to be included on this register, you will need to declare its conformance with the requirements by completing and submitting a Conformance Vendor Declaration form.

If you do not need to connect to the My Health Record system or be listed in the Practice Incentives Program (PIP) Digital Health Incentive Product Register, then you can implement whichever HI use cases are appropriate.

Familiarise yourself with other Healthcare Identifiers licensed materials and other resources

While you await the HI Licensed Material and certificates to access the HI SVT environment, you can familiarise yourself with the other documentation and resources which you will need to complete your development.

The Healthcare Identifiers-related end products are listed below. We recommended that you start with:

Familiarise yourself with the testing requirements

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:

6.1 HI Notice of Connection (NOC)

We recommend completing HI NOC testing first. This testing:

Confirms that your product connects successfully with the HI Service

Is conducted by the HI System Operator – Department of Human Services

Contact the OTS Liaison Team to begin testing.

6.2 National Association of Testing Authorities (NATA) HI Compliance, Conformance and Declaration

Ensures the software supports the safe implementation and use of healthcare identifiers in clinical environments, developed by the Agency in consultation with the digital health industry.

Conducted by a National Association of Testing Authorities, Australia (NATA) accredited testing laboratory. There is a charge for this. Please contact the lab directly for information on the process or estimated costs.

Read the FAQ HI Service Vendor Q and A sheet for more information.

If your product makes use of healthcare identifiers, we recommend conformance testing to make sure it uses and manages identifiers in a way that supports clinical safety.

We recommend you successfully complete HI NOC testing before conducting conformance testing.

6.3 Testing Resources

The first document below is the HI Conformance Requirements. Please start by viewing pages 57-58 to understand which requirements are relevant for your development.

Refer to Healthcare Identifiers Sample Code Resources

The most useful resource below is the HI Integration Toolkit, which is sample code provided in both .net and Java.

Healthcare Identifiers sample code:

Healthcare Identifiers resources: