Healthcare Identifiers Service for software developers

Registered healthcare providers must use software specifically developed to connect to the Healthcare Identifiers (HI) Service.


Developing software for the HI Service

You need to use the HI licensed material and undertake product testing if you want to:

  • develop new products, or
  • update existing products that connect to the HI Service

Access to the HI licensed material

To get access to the HI licensed material you need to read and accept the terms and conditions of the Licence Agreement - Use of the Healthcare Identifiers licenced material for Notice of Connection.

We’ll email you a logon ID and password, usually within 2 working days. You’ll need to use this when downloading material from the Current Version (n) Healthcare Identifiers licensed material page.

Software development environment

Once you have access to the HI licensed material you’ll receive information about our vendor environment, and how to access it. You can use this environment to help with product development and some of the required product testing.

Testing requirements

All products developed or updated to connect with the HI Service need to be tested before we’ll give you production access.

There are 2 types of mandatory testing:

  1. Notice of Connection (NOC) - confirms your product connects successfully with the HI Service.

    This isn’t a certification process and doesn’t certify any products.

    Once you've completed NOC testing for each version of your products, you must keep the following B2B header fields until production access is granted:
    • vendor ID
    • product name
    • product version

    Contact the Online Technical Support (OTS) for information about how to begin the NOC testing process.

  2. Australian Digital Health Agency (ADHA) Compliance, conformance, and accreditation (CCA) - makes sure the software supports the safe implementation and use of healthcare identifiers in clinical environments.

    These requirements were developed by AHDA (formerly the National E-Health Transition Authority) in consultation with the eHealth industry. Go to the ADHA website or email for more information about how to begin the CCA testing process.

We strongly recommend that products not directly connecting to the HI Service, but still using healthcare identifiers, undergo CCA testing. This will ensure the products use and manage healthcare identifiers in a way that supports clinical safety. We recommend you complete NOC testing before CCA testing.

Production access to the HI Service

When you’ve successfully completed both the NOC and CCA testing for your product, we’ll let you know your product has been granted access to the HI Service production environment. We’ll send you the URL address to access it.

With your consent, AHDA will publish your product on the eHealth Register of Conformity. For more information go to the ADHA website.

Email the HI Vendor Operations Team:

  • for further information about being granted access to the HI Service, or
  • to find out the status of your production access

Support in developing your product

We can support you in developing your product.

HI Vendor Operations Team

The HI Vendor Operations Team can help you to understand HI Service business processes, including B2B web services and using the HI Service licensed material.

The HI Vendor Operations Team is responsible for giving you access to the HI Service once you have completed both the NOC and CCA testing requirements.

Online Technical Support (OTS)

The Online Technical Support (OTS) team can help you develop products for the department's health professional online businesses.

Feedback about the HI licensed material

If you wish to give feedback about the HI licensed material website or the HI licensed material, email the HI Vendor Operations Team with your comments. Your feedback is important to us and will help improve the quality of our services.

Support for your customers

Your customers can contact the HI Service Operations Team if they have any questions about accessing the HI Service and using healthcare identifiers.

eHealth support

Go to the My Health Record website for information about the My Health Record system.

The Australian Digital Health Agency (ADHA) provides software vendors with information and support for compliance, conformance and accreditation (CCA) testing and other eHealth information.


Australian technical specifications

For secure messaging you should read the 2 Australian technical specifications:

  • Web Service Profiles specification (ATS 5280-2010)
  • XML Secured Payload specification (ATS 5281-2010)

The PDF specifications are free and available online at the Standards Australia e-health website. You need to register with Standards Australia to access these specifications.

Licensed Materials

Current Version (n) Healthcare Identifiers licensed material

A complete current version of HI licensed material for software developers.

Read more about Current Version (n) Healthcare Identifiers licensed material

Licence Agreement for Healthcare Identifiers Service software developers

Software developers must accept the conditions of the Licence Agreement.

Read more about the Licence Agreement

Draft versions

You can provide feedback on draft versions of our Licence Agreements.

When available, the next draft version of the material is provided for comment and feedback before being released as the final version.

There is currently no draft version available for comment.

Archived versions

You can get archived versions of licensed material by emailing the HI Vendor Operations Team.

Archived material should be referred to for information only.


Software vendor implementation guide

Information about NASH PKI certificates to software vendors or software development teams that work in healthcare provider organisations.

The National Authentication Service for Health (NASH) allows healthcare providers and supporting organisations to securely communicate and exchange electronic health (eHealth) information.

NASH Public Key Infrastructure (PKI) certificates are used to access the My Health Record system, provide confidence in the integrity of information transmitted and facilitate the secure exchange of eHealth information with other healthcare providers.

Read more about NASH PKI certificates for software vendors and developers, for software vendors or software development teams that work in healthcare provider organisations.

Page last updated: 20 September 2018