Go to top of page

Quick Intro

Before building Digital Health functionality (such as Electronic Prescribing, Secure Messaging or My Health Record) your software must first be able to identify the three participants in a healthcare event; the patient, the healthcare provider individual, and the healthcare provider organisation. The HI Service stores identifiers for these three participants. The HI Service Business to Business (B2B) Gateway exposes SOAP based web services which allow your software to search for identifiers for these parties.

If you are new to the HI Service and wish to register and begin development then please follow our developer guides below. If you would like to understand more about the Test and Go Live process then please view our overview <here>.

There are three recent changes for HI Service development which may be of interest to new and returning developers;

  • HI Service Conformance Testing is now conducted by the Digital Health Agency at no cost, previously it was conducted by a 3rd party testing laboratory with associated costs.
  • HI Service requirement 22000 is now mandatory. More information can be found in our <FAQ below>.
  • Software will now use NASH certificates to connect to the HI Service, previously your customers would use their Medicare Site Certificates to connect to the HI Service. More information can be found at: https://developer.digitalhealth.gov.au/products/national-authentication-service-health-nash

Developer Guides

Start with the Registration and Introduction below - this includes mandatory registration requirements and reading.

Introduction:  Registration and Introduction to the HI Service
Guide 1: IHI Lookup
Guide 2: IHI Lookup - Test Cases
Guide 3: Search for HPI-I
Guide 4: Additional HI Service requirements for Electronic Prescribing

If you are connecting your software to the My Health Record system then you may wish to follow our combined developer guides here:
https://developer.digitalhealth.gov.au/developer-guide/my-health-record-b2b-developer-guides

Resources

News

Apr
19

Healthcare Identifiers (HI) Service Vendor environment - Notifications

Services Australia advice: ANZAC Day Public Holiday - OTS and Developer Support availability & Notice of changes: Changes are coming for National Authentication Service for Health (NASH) PKI Certificates and the Healthcare Identifiers (HI) Service. Make sure your work plan includes: Transition from SHA-1 to SHA-2 NASH PKI certificates and using a NASH PKI Certificate to access the HI Service. Learn more

Dec
17

Issue identified with the Healthcare Identifiers (HI) Service IHI Inquiry web services, affecting the date of birth field

An issue was identified with the Healthcare Identifiers (HI) Service IHI Inquiry web services, affecting the date of birth field. This issue resulted in a timezone to the consumer date of birth value in the IHI search response. 

Dec
16

Changes coming for National Authentication Service for Health (NASH) PKI Certificates and the Healthcare Identifiers (HI) Service

Make sure your workplan includes: Transition from SHA-1 NASH PKI certificates to SHA-2 NASH PKI certificates and Using a NASH PKI Certificate to access the HI Service. Learn more....

Nov
04

Transitioning HI CCA Testing to the Australian Digital Health Agency

From the 1st of November 2020, the Australian Digital Health Agency (the Agency) will be conducting Healthcare Identifier (HI) Conformance testing.