New Zealand HPI Implementation Guide - Local Development build (v1.3.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Search PractitionerRole by Practitioner (hpi-person-id)
Search PractitionerRole by Practitioner (hpi-person-id) Processing steps
The user initiates searching a PractitionerRole in the integrating application.
The integrating application sends an HTTP GET request (a FHIR search) for the list of PractitionerRole resources that reference the Practitioner resource for the supplied hpi-person-id E.g. GET<Endpoint>/PractitionerRole?practitioner=99ZZZZ
The request is validated - ALT: Validation failure. OperationOutcome resource returned
The PractitionerRole resources related to the supplied hpi-person-id are retrieved from the HPI - ALT: No PractitionerRole resources found. OperationOutcome resource returned
The response containing a bundle of PractitionerRole resources is returned
The consuming application displays the matching Practitioner Role details to the user
Using _ include parameter
When specified by _ include, the Practitioner, Organization and Location records are included in the response Note: This requires read permission on the included resource
E.g. GET<Endpoint>/PractitionerRole?practitioner=99ZZZS&_include=PractitionerRole:practitioner