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
This operation is used to search for a specific facility using known facilities demographics.
Search Facility by name processing steps:
The user of the integrating application searches for a Facility by entering the Facility name
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
The request is validated - ALT: Validation failure. Operation Outcome resource returned
The matching facilities are retrieved from the HPI
The response containing a bundle of matching facilities is returned to the integrating application
The integrating application displays the matching locations to the user
The user of the integrating application searches for a list of facilities by entering the facility type
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
The request is validated - ALT: Validation failure. Operation Outcome resource returned
The first 10 matching facilities are retrieved from the HPI
The response containing a bundle of matching facilities is returned to the integrating application
The integrating application displays the matching locations to the user