New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
The search Practitioner operation allows a user to search the HPI for a Practitioner record with known demographics
name,
gender, and
birthdate
Matching Practitioner resources include APC history by default when history is available. It is returned as repeated apc-history extensions on the corresponding Practitioner.qualification; no additional search parameter or _include is required. The latest APC period also remains available in Practitioner.qualification.period.
The user of the integrating application searches for a Practitioner by entering the name
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
The request is validated - ALT: Validation failure. OperationOutcome resource returned
The matching Practitioners are retrieved from the HPI
The response containing a bundle of matching Practitioners is returned to the integrating application
The integrating application displays the matching Practitioners to the user
Search Practitioner using name and birth date
Search Practitioner using name and birth date processing steps:
The user of the integrating application searches for a Practitioner by entering the name and birth date
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
The request is validated - ALT: Validation failure. OperationOutcome resource returned
The matching Practitioners are retrieved from the HPI
The response containing a bundle of matching Practitioners is returned to the integrating application
The integrating application displays the matching Practitioners to the user