Go to top of page

Healthcare Identifiers licensed materials and software requirements for the use of Healthcare Identifiers

The Healthcare Identifiers specifications you will require for your development are hosted in 2 different locations:

  • System Interface Specifications (SIS) for connecting to the Healthcare Identifiers web services are licensed materials hosted on the Services Australia web portal. Suggested document relevant for your implementation are listed below.
HI Service - Developers Guide.pdf Health Systems Developer Portal
HI Service - IHI Searching Guide.pdf
TECH.SIS.HI.06 - IHI Inquiry Search via B2B v10.0.pdf
TECH.SIS.HI.31 - Search for Provider Individual Details – v7.0.pdf
  • Healthcare Identifiers Service - Support documents which provide background and guidance for healthcare provider organisations, and conformance, compliance and accreditation requirements for vendors are hosted in the Australian Digital Health Agency Developer Centre.

Suggested reading

Use of HIs in Health Software Systems - Conformance Requirements v3.1  https://developer.digitalhealth.gov.au/specifications/national-infrastructure/ep-1826-2014/nehta-1732-2014 
Healthcare Identifiers - Implementation Conformance Statement Proforma v3.2 https://developer.digitalhealth.gov.au/specifications/national-infrastructure/ep-1826-2014/nehta-1879-2014 
Use of HIs in Health Software Systems - Business Use Cases v3.1  Refer below

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.

Your software will also be required to connect to the HI Service if it is participating in Electronic Prescribing. UC.010, UC.015 and UC.131 will be relevant to your development.

It is important to understand that each HI Service use case may be fulfilled by one or more HI Service web service. You need to determine which web service and use case you require in your product. We recommend that you also familiarise yourself with the use cases outlined in the table below. (If you do not need to access the My Health Record system, participate in Electronic Prescribing, or be listed in the Digital Health Incentive Product Register, then you can implement whichever HI use cases are appropriate.)

Use of HIs in Health Software Systems - Business Use Cases v3

The Table of Contents lists all of the HI use cases. This summary can be used to identify relevant sections of the document to read.

https://developer.digitalhealth.gov.au/specifications/national-infrastructure/ep-1826-2014/nehta-1733-2014 

Use of HIs in Health Software Systems - Conformance Requirements v3.1

Address conformance requirements associated to the following use cases (UC)

UC.010 - Register patient 
UC.015 - Update patient health record
UC.025 - Bulk update of IHI details 
UC.035 - Merge patient health records 
UC.131 - Search for HPI-Is in the HI Service

https://developer.digitalhealth.gov.au/specifications/national-infrastructure/ep-1826-2014/nehta-1732-2014

Healthcare Identifiers - Implementation Conformance Statement Proforma v3.2

Address proforma elements associated to the following use cases (UC)

UC.010 - Register patient 
UC.015 - Update patient health record 
UC.025 - Bulk update of IHI details 
UC.035 - Merge patient health records 
UC.131 - Search for HPI-Is in the HI Service

https://developer.digitalhealth.gov.au/specifications/national-infrastructure/ep-1826-2014/nehta-1879-2014

You will need test certificates to access the HI Service Software Vendor Test environment. Please see the National Authentication Service for Health (NASH) PKI organisation certificate page for certificate application and development guidance. 

For testing information, please see the HI Test and Go Live page.