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

Facility Compliance Testing

HPI Location/Facility GET

Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
HPI-L-Get-1 System behaves appropriately when a dormant hpi-facility-id is requested FZZ997-J System does not error
System returns appropriate messaging to user		 *Mandatory if appropriate for use case
HPI-L-Get-2 System behaves appropriately when the location requested is no longer active FZZ754-E
FZZ753-C		 System returns appropriate messaging to user *Mandatory if appropriate for use case
HPI-L-Get-3 System behaves appropriately when more than one contact point is present FZZ968-B Where appropriate all contact points are displayed to user *Mandatory if appropriate for use case
HPI-L-Get-4 System behaves appropriately when using the contact point rank FZZ065-D When rank is present it is presented to user in an meaningful way *Optional
HPI-L-Get-5 System presents the address parts appropriately FZZ961-K
FZZ960-H
FZZ959-A
FZZ958-K
FZZ065-D		 All address formats are displayed appropriately *Mandatory if appropriate for use case
HPI-L-Query-1 System behaves appropriately when a dormant hpi-facility-id is requested NZHIS (Legacy) identifier Z999 System does not error
System returns appropriate messaging to user		 *Mandatory if appropriate for use case
HPI-L-Query-2 System presents the address parts appropriately NZHIS (Legacy) identifier 9987 Address is displayed appropriately *Mandatory if appropriate for use case

HPI Location/Facility Search

Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
HPI-L-Search-1-name Minimum search criteria are included Name = “Red Diamond”
    Output:
  • Facility name is supplied and returns results
  • Search results are presented to user in order provided by the HPI, if not please provide a reason
 *Mandatory if appropriate for use case
HPI-L-Search-2-name System behaves appropriately when the name search criteria better matches an alias than the name Name = “Red Diamond Pukekohe”
    Output:
  • System allows user to view aliases before selecting a result
  • Alias= Red Diamond Pukekohe
  • "Red Diamond Generic Medical Centre- Pukekohe
 *Mandatory if appropriate for use case
HPI-L-Search-3-address System cn search for facility using the address Address = "133 molesworth”
    Output:
  • System allows user to search for facility by address
  • Results used appropriately
 *Mandatory if appropriate for use case
HPI-L-Search-4-name and address System can search for facility using name and address
  • Name = Acupuncture
  • Address = 133 molesworth
    Output:
  • System allows user to search for facility by name and address
  • Results used appropriately
 *Mandatory if appropriate for use case
HPI-L-Search-5-organization System can search for facility using managing organization
  • organization = GZZ018-B
    Output:
  • System allows user to search for facility by managing organization
  • Results used appropriately
 *Mandatory if appropriate for use case
HPI-L-Search-6-type System can retrieve all facilities of a spcific type
Click here for more information on additional search parameters		 Search for all facilities that are of a type appropriate to the use case e.g. pharm (pharmacies)
    Output:
  • System allows user to search for facility by type
  • Results used appropriately
 *Mandatory if appropriate for use case
HPI-L-Search-6-dhb System can retrieve all facilities in a DHB catchment area
Click here for more information on additional search parameters		 Search for all facilities that are in a DHB of interest for the use case e.g. G00011-K (Auckland District Health Board)
    Output:
  • System allows user to search for facilities by DHB
  • Results used appropriately
 *Mandatory if appropriate for use case
HPI-L-Search-7-name and dhb System can search for facilities with a specific name in a DHB catchment area
Click here for more information on additional search parameters		 Search for name = Plunket Clinic in DHB G00011-K (Auckland District Health Board)
    Output:
  • System allows user to search for facilities by name and DHB
  • Results used appropriately
 *Mandatory if appropriate for use case