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 Practitioner

Search Practitioner Overview

The search Practitioner operation allows a user to search the HPI for a Practitioner record with known demographics

  • name,
  • gender, and
  • birthdate

For more information of available search parameters click here

Search Practitioner using name

Search Practitioner with name sequence diagramIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> HPI<FHIR API> HPIHPI MDMHPI MDMSearch with nameGET<Endpoint>/Practitioner?name=[]Validate[]Search[name]Return (bundle)Display list of matchingPractitioners

Search Practitioner using name processing steps:

  1. The user of the integrating application searches for a Practitioner by entering the name
  2. The integrating application sends an HTTP GET request for the Practitioner resource using the name attribute as search parameter E.g. GET<Endpoint>/Practitioner?name=walter o'reilly
  3. The request is validated - ALT: Validation failure. OperationOutcome resource returned
  4. The matching Practitioners are retrieved from the HPI
  5. The response containing a bundle of matching Practitioners is returned to the integrating application
  6. The integrating application displays the matching Practitioners to the user

Search Practitioner using name and birth date

Search Practitioner with name and birth date sequence diagramIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> HPI<FHIR API> HPIHPI MDMHPI MDMSearch with name and birthdateGET<Endpoint>/Practitioner?name=[]&birthdate=[]Validate[]Search[name]&[birthdate]Return (bundle)Display list of matchingPractitioners

Search Practitioner using name and birth date processing steps:

  1. The user of the integrating application searches for a Practitioner by entering the name and birth date
  2. The integrating application sends an HTTP GET request for the Practitioner resource using the name and birthdate elements as search parameters E.g. GET<Endpoint>/Practitioner?name=walter o'reilly&birthdate=1943-05-24
  3. The request is validated - ALT: Validation failure. OperationOutcome resource returned
  4. The matching Practitioners are retrieved from the HPI
  5. The response containing a bundle of matching Practitioners is returned to the integrating application
  6. The integrating application displays the matching Practitioners to the user

Search Practitioner Rules and errors

For Request rules and errors click here
Rule Error code Error description Error text / expression Http code
A search Practitioner request must include a name at minimum
  • EM07201
  • Required value missing
  • Practitioner.SearchParam.name
  • 422 Unknown
A search Practitioner request may include birthdate and gender
  • No error