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

Search Facility

Search Facility Overview

The Search facility use case describes how a user can search for:

  • a specific facility using known facility demographics (e.g. name, address),
  • all facilities in a specific DHB catchment area
  • all facilities of a specific type in the HPI e.g. all pharmacy records in the HPI
  • all facilities with a given Managing Organisation

For all the facility search parameters click here

Search Facility by name

This operation is used to search for a specific facility using known facilities demographics.

Search Facility by demographics sequence diagramIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> HPI<FHIR API> HPIHPI MDMHPI MDMSearch location with nameGET<Endpoint>/Location?name=[]Validate[]Search[name]Return(bundle)Return list of matchinglocations

Search Facility by name processing steps:

  1. The user of the integrating application searches for a Facility by entering the Facility name
  2. The integrating application sends an HTTP GET request for the Location resource using the name as a search parameter E.g. GET<Endpoint>/Location?name=Pukekohe Diamond Doctors
  3. The request is validated - ALT: Validation failure. Operation Outcome resource returned
  4. The matching facilities are retrieved from the HPI
  5. The response containing a bundle of matching facilities is returned to the integrating application
  6. The integrating application displays the matching locations to the user

For all the facility search parameters click here

Search Facility by type

This search operation allows a user to search for all facilities of a specific type e.g. return all pharmacies in the HPI. The API defaults to return only 10 records. To learn more about searching and get more than the default 10 records see additional search information.

Search Facility by type sequence diagramIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> HPI<FHIR API> HPIHPI MDMHPI MDMEnters HPI type e.g.PharmacyGET<Endpoint>/Location?type=[]Validate[]Search[type]Return(bundle)Return list of matchinglocations

Search Facility by type processing steps:

  1. The user of the integrating application searches for a list of facilities by entering the facility type
  2. The integrating application sends an HTTP GET request for the Location resource using type as a search parameter E.g. GET<Endpoint>/Location?type=pharm
  3. The request is validated - ALT: Validation failure. Operation Outcome resource returned
  4. The first 10 matching facilities are retrieved from the HPI
  5. The response containing a bundle of matching facilities is returned to the integrating application
  6. The integrating application displays the matching locations to the user
  7. To get more than the default 10 records see additional search information to learn about the _count and _offset parameters

For all the facility search parameters click here