Skip to main content

The Healthcare Identifiers Service (HI Service) is a national system for uniquely identifying individuals, healthcare provider individuals and healthcare provider organisations.

Healthcare identifiers provide confidence that the correct information is associated with the correct individual at the point of care.

The HI Service is required for many aspects of digital health, including electronic prescribing, secure messaging and My Health Record. Get started below. 

Overview

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 individual, 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 these identifiers. 

The three identifiers used in the HI Service are:

  • Individual Healthcare Identifier (IHI) An IHI identifies an individual healthcare recipient for healthcare purposes. Each individual enrolled in Medicare (or the Department of Veteran Affairs) gets an IHI automatically. IHIs are also available on request to other healthcare consumers (including permanent residents and visitors to Australia).
  • Healthcare Provider Identifier–Individual (HPI–I) An HPI-I identifies an individual healthcare provider who provides healthcare, such as a general practitioner, allied health professional, specialist, nurse, dentist and pharmacist. A provider gets an HPI-I automatically when they register with the Australian Health Practitioner Regulation Agency (Ahpra). Members of other professional associations with certain characteristics can also apply for an HPI-I.
  • Healthcare Provider Identifier–Organisation (HPI–O) An HPI-O identifies a healthcare provider organisation where healthcare is provided, such as a hospital, medical practice, pathology laboratory, radiology laboratory and pharmacy. Organisations must register with the HI Service to obtain an HPI-O.
     
my-health-record-b2b-hi-services

If you are new to the HI Service and wish to register and begin development, then please follow our developer guides below. To understand more about the Test and Go Live process, please see: HI Service - Test and Go Live

Developer Guides

Refer below to access all developer guides including: 

If you are connecting your software to the My Health Record system, please refer to the combined developer guides here:  

Healthcare Identifiers Integration Toolkit

The Healthcare Identifiers Integration Toolkit is a collection of sample code available in both .NET and Java. This toolkit is available for download via this website, GitHub and NuGet. In the HI Service Developer Guides, you will be provided direction to download the .NET NuGet package in Guide 1. The Healthcare Identifiers Integration Toolkit contains libraries for B2B connectivity to the Healthcare Identifiers service, used to search for IHI, HPI-Is and HPI-Os. For more information refer to:   

Sample Code available from GitHub

Java based sample code equivalent to the dotnet code base. We are working on providing updates to the 'clinical-document-library' for existing and new CDA document types. Other clients are deemed sufficient as there have been no API changes.

Content

Getting started education modules

If you are interested in integrating your software with the My Health Record system, we recommend starting by reviewing our education modules.

Healthcare Identifiers Integration Toolkit v1.0

ID
EP-1634:2014
Type
Product
Version
1.0
Status
Active
The eHealth integration toolkits are a collection of integration tools and sample code resources available in both .NET and Java. The sample code and integration tools are used within the eHealth Reference Platform, forming part of the code library for tools and simulators. Access to sample code and the eHealth Reference Platform’s online simulator…

Healthcare Identifiers Integration Toolkit v1.1

ID
EP-1941:2014
Type
Product
Version
1.1
Status
Active
The eHealth integration toolkits are a collection of integration tools and sample code resources available in both .NET and Java. The sample code and integration tools are used within the eHealth Reference Platform, forming part of the code library for tools and simulators. Access to sample code and the eHealth Reference Platform’s online…

Healthcare Identifiers Integration Toolkit v1.2

ID
EP-2610:2018
Type
Product
Version
1.2
Status
Active
The Healthcare Identifiers Integration Toolkit contains libraries for B2B connectivity to the HI Service, used to search for IHI, HPI-Is and HPI-Os. The sample code and integration tools provided here should only be used in conjunction with the Agency's detailed specifications for the HI Service and, where appropriate, by working with technical and other…

Healthcare Identifiers Service - Support Documents v1.2

ID
EP-1826:2014
Type
Product
Version
1.2
Status
Active
The supporting documents on this page provide background and guidance for healthcare provider organisations, and conformance, compliance and accreditation requirements for vendors. For more information, please see the Healthcare Identifiers section on our My Health Record system page, or visit the DHS Medicare website for more information on the Healthcare…

Healthcare Identifiers Service - Support Documents v1.3

ID
EP-3362:2020
Type
Standard
Product
Version
1.3
Status
Active
This release of the end product formalises the transition of HI Service CCA testing to the Australian Digital Health Agency and introduces one new conformance requirement.   The supporting documents on this page provide background and guidance for healthcare provider organisations, and conformance, compliance and accreditation requirements for vendors…

Healthcare Identifiers Service - Support Documents v1.4

ID
EP-3503:2021
Type
Standard
Product
Version
1.4
Status
Active
This release of the end product contains a reorganisation of worksheets to provide for requirement #22000 and Electronic Prescribing has been introduced.   The supporting documents on this page provide background and guidance for healthcare provider organisations, and conformance, compliance and accreditation requirements for vendors. For more…

Healthcare Identifiers Service - Support Documents v1.5

ID
EP-3921:2024
Type
Product
Version
1.5
Status
Active
The HI Service support documents on this page provide background and guidance for healthcare provider organisations, and conformance and accreditation requirements for software developers.   For more information, refer to the documents and specifications listed below and to:    Use of Healthcare Identifiers in Health Software Systems - FAQs…

Healthcare Identifiers Service v1.1

ID
EP-1382:2013
Type
Product
Version
1.1
Status
Active
One of the key foundations for a national approach to eHealth is a standard process across the health sector to consistently identify everyone involved in a healthcare event: Individual Healthcare Identifier (IHI) for individuals receiving healthcare services Healthcare Provider Identifier – Individual (HPI-I) for healthcare providers and other…

Healthcare Identifiers Service v1.1.1

ID
EP-1472:2013
Type
Product
Version
1.1.1
Status
Active
One of the key foundations for a national approach to eHealth is a standard process across the health sector to consistently identify everyone involved in a healthcare event: Individual Healthcare Identifier (IHI) for individuals receiving healthcare services Healthcare Provider Identifier – Individual (HPI-I) for healthcare providers…

Healthcare Identifiers Service v1.1.2

ID
EP-1645:2014
Type
Product
Version
1.1.2
Status
Active
One of the key foundations for a national approach to eHealth is a standard process across the health sector to consistently identify everyone involved in a healthcare event: Individual Healthcare Identifier (IHI) for individuals receiving healthcare services Healthcare Provider Identifier – Individual (HPI-I) for healthcare providers and…

Healthcare Identifiers Service v1.1.3

ID
EP-1653:2014
Type
Product
Version
1.1.3
Status
Active
One of the key foundations for a national approach to eHealth is a standard process across the health sector to consistently identify everyone involved in a healthcare event: Individual Healthcare Identifier (IHI) for individuals receiving healthcare services Healthcare Provider Identifier – Individual (HPI-I) for healthcare providers and other…

Victoria IHI Pre-Implementation Project v1.0

ID
EP-1344:2011
Type
Product
Version
1.0
Status
Active
The primary objective of the Victorian IHI Pre-Implementation project is to develop a suite of system design artefacts to support integration of the national Individual Healthcare Identifier into health services’ patient administration systems. The project was conducted by the Department of Health, Victoria, under the HealthSMART program, and NEHTA…