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
The Get Facility use case describes how a user can find an HPI facility record.
HPI Facilities are returned using the HL7 FHIR Location resource.
Get facility using an hpi-facility-id
Get facility (Location) processing steps:
The user supplies a hpi-facility-id for the Facility to be looked up
The integrating application sends an HTTP GET request for the Location resource using the hpi-facility-id to identify the Location whose information is being requested. E.g. GET<Endpoint>/Location/FZZ999-B
The request is validated - ALT: Validation failure. Operation Outcome resource returned
The Location resource is retrieved from the HPI - ALT: Location not found. Operation Outcome resource returned
The response containing the Location resource is returned
A Facility read request must include a valid hpi-facility-id
Invalid ID: <>
404 Not found
Query Facility using the Location the NZHIS (Legacy) identifier
To query a Facility with the NZHIS (Legacy) identifier, the integrating application sends an HTTP Get request for the Location resource using the NZHIS (Legacy) identifier and the identifier system.
The user supplies the system (https://standards.digital.health.nz/ns/nzhis-facility-id) and identifier (NZHIS-id) for the facility.
The integrating application sends an HTTP Get request for the Location resource using the NZHIS identifier to identify the facility whose information is being requested. E.g. GET<Endpoint>/Location?identifier=https://standards.digital.health.nz/ns/nzhis-facility-id|Z997
The request is validated - ALT: Validation failure. OperationOutcome resource returned
The Location resource is retrieved from the HPI - ALT: Location reource not found. OperationOutcome resource returned
The response containing a bundle with a single facility record is returned
The integrating application displays the facility details to the user