New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Organisation Compliance Testing

HPI Organization GET

Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
HPI-O-Get-1 System behaves appropriately when a dormant hpi-organisation-id is requested GZZ995-A System does not error
System returns appropriate messaging to user
*mandatory if appropriate for use case
HPI-O-Get-2 System behaves appropriately when the organisation requested is no longer active GZZ903-C System returns appropriate messaging to user *mandatory if appropriate for use case
HPI-O-Query-1 System behaves appropriately when a dormant hpi-organisation-id is requested
  • NZBN - 9999999999003
  • Legacy agency code (NZHIS) - 9002
System returns appropriate messaging to user *mandatory if appropriate for use case
HPI-O-Query-2 System behaves appropriately when the organisation requested is no longer active
  • NZBN - 9999999999072
  • Legacy agency code (NZHIS) - 9975
System returns appropriate messaging to user *mandatory if appropriate for use case

HPI Organization SEARCH

Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
HPI-O-Search-1-name Minimum search criteria are included Search for ‘New Zealand Army’
Search for ‘Hosptial Pharmacy’
Organisation name is supplied and returns results *mandatory if appropriate for use case
HPI-O-Search-2-name Search results are presented to user in order provided by the HPI
if not please provide a reason
Use search results from above Results presented in order provided *mandatory if appropriate for use case
HPI-O-Search-3-name System behaves appropriately when the name search criteria better matches an alias than the name Search for ‘Discount Pharmaceuticals Limited’ System allows user to view aliases before selecting a result
Name= TryNSave Discount Pharmacy
Alias= Discount Pharmaceuticals Limited
HPI-O= GZZ869-G
*mandatory if appropriate for use case
HPI-O-Search-3-name System behaves appropriately when the name search criteria better matches an alias than the name Search for ‘Discount Pharmaceuticals Limited’ System allows user to view aliases before selecting a result
Name= TryNSave Discount Pharmacy
Alias= Discount Pharmaceuticals Limited
HPI-O= GZZ869-G
*mandatory if appropriate for use case
HPI-O-Search-4-partof System can retrieve organisatons that are 'part of' another organisation Search for organisatons that are 'part of' GZZ836-C System can display the organisations that are 'part of'GZZ836-C *mandatory if appropriate for use case
HPI-O-Search-5-type System can retrieve all organisatons of a specific type
Click here for more information on additional search parameters
Search for organisatons that are of a type appropriate to the use case e.g. 009 Primary Health Organisation (PHO) System can retireve all organisations of specific type *mandatory if appropriate for use case