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 Create PractitionerRole operation is initiated by a user who needs to create a PractitionerRole record for a person not found on the HPI.
The user has sourced the required information, searched PractitionerRole to make sure the role doesn't currently exist, and initiates the request to create a new PractitionerRole record.
Create new PractitionerRole processing steps:
The user initiates creating a new PractitionerRole in the integrating application
The integrating application sends an HTTP POST request (a FHIR create) containing the PractitionerRole details E.g. Post<Endpoint>/PractitionerRole
The request is validated - ALT: Validation failure. OperationOutcome resource returned
A PractitionerRole record is created and a hpi-practitionerrole-id issued
The HPI FHIR API confirms a successful update – HTTP 201 Created status code
The integrating application indicates to the user the create has been successful
The integrating application retains the hpi-practitionerrole-id and version number for future requests relating to this record
A contact point value must have a valid format (HISO recommends)
Valid mobile phone number format
International ITU-T E.164 numbers are variable length numeric strings without punctuation, composed of country code, area code or mobile network code and subscriber number
Numbers should be entered, validated and displayed as separate components, eg: 64 4 232nnnn, 64 20 412nnnnn
Valid email format
an email address must have a local-part@domain-part format
the address length must not exceed 256 characters
can contain any UTF-8 characters except control characters.
Contact period must be formatted YYYY-MM-DD
Contact period start date must be less than, or equal to end date
Rank may be supplied for contactpoints, Gaps in the sequence of rank are allowed, 1 is the highest rank, Rank 0 is invalid, When rank is not supplied it will be assigned the next lowest rank within the PracRole telecom contactpoints.
Create PractitionerRole - Contact errors
The contact point you are creating is a duplicate of another on this record
The mobile phone format is invalid
The email format is invalid
Contact period is invalid; format must be yyyy-mm-dd
Contact period start date must be less than or equal to a contact point period end date