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
The update Practitioner operations allow an authorised user to update a person's details on the HPI. The operations are broken down into four custom update operations:
Update-core processing steps:
Parameter name | Mandatory / Optional | Description |
---|---|---|
cpn | Mandatory | The hpi-person-id (cpn) |
version-id | Mandatory | The current Practitioner record version number |
ra-identifier | * Mandatory for an RA update | The RA identifier |
name | Optional | An update replaces the full set of name attributes (use, prefix, given, family) |
death-date | Optional | The date of death, can only be set by an admin user |
birth-date | Optional | The birthdate, can only be set by an admin user |
{
"resourceType":"Parameters",
"parameter":[
{
"name":"cpn",
"valueString":"99ZZRT"
}, {
"name":"version-id",
"valueString":"29450"
},
{
"name":"ra-identifier",
"valueString":"998877"
},
{
"name":"name",
"valueHumanName":
{
"use":"official",
"family":"FhirClientPractitionerUpdateIntegrationTest",
"given":
["updateNrPractitioner"]
}
},
{
"name":"death-date",
"valueDate":"2021-11-11"
},
{
"name":"birth-date",
"valueDate":"1990-12-31"
}
]
}
For Request rules and errors click here
Practitioner update errors
Practitioner update-core 'name' errors
Practitioner update-core 'birthdate' errors