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
An update on an HPI PractitionerRole resource allows an authorised user to update the contact details, messaging address (EDI) or add an end-date.
Prior to an update a user should have the hpi-practitionerrole-id and have the latest version of the record (the current version-id)
Processing steps:
The user initiates updating a PractitionerRole in the integrating application
The user selects a role to update and supplies new contact details or an end date
The API consumer sends an HTTP PUT request (a FHIR update) containing the previously returned Practitioner Role with the new details entered by the user. E.g. PUT<Endpoint>/PractitionerRole/R00000009-H
The request is validated - ALT: Validation failure. OperationOutcome resource returned
The supplied PractitionerRole is updated on the HPI
The HPI FHIR API confirms a successful update – HTTP 200 ok
The integrating application indicates to the user the update has been successful and retains the version number for future requests relating to this record