New Zealand HPI Implementation Guide
1.5.0 - Release
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 HPI has HealthLink addresses recorded against HPI Facilities (Location). These can be extracted from Location.telecom EDI extension.
Yes, use a query practitioner with another identifier. See here for more details
A Practitioner’s Practising Certificate (also known as an Annual Practising Certificate or APC) is returned in the HpiPractitioner.qualification.period attribute. It is the most recent practising period supplied by the RA. The APC period may be in the past or start in the future. The registration status as well as the APC should be assessed when determining a practitioner’s authority to practice. The registration status should be current and todays date should lie within the qualification.period. Registration status of inactive, removed or suspended should be treated as exceptions.
If a practitioner has retired and asked to be removed from the register their registration status will be ‘removed’.
There is no bulk operation supported at this time. However, the Practitioner Read by Id has a good response time and the HPI is designed to cope with high loads. If you need to send bulk requests or process high volumes, please contact us to discuss.
These details are supplied when a practitioner is added and maintained by their Responsible Authority and are used in non-identifiable analysis eg workforce planning. They are withheld on a Get Practitioner response and only available to users with admin permissions and only if they have a specific need for these details.
When checking that a practitioner is currently licenced, systems should check that the Registration Status Code is current and that todays date falls within the Practitioner.qualification.period.
The Practitioner.qualification.period is the start and end dates of the most recently issued Annual Practicing Certificate (APC).
There is also a registration-status-code period that is part of the registration details for a practitioner. This is the start date that this status was applied. If the status is ‘removed’ then this is the date the practitioner was removed from the register.
About 90% of facilities have eSAM validated addresses. The facilities with unvalidated addresses are • Government or Council land that do not have valid addresses eg sports buildings on public reserves. • Historic facilities with incomplete address details • Facilities in the process of being set up where the address has not yet been supplied • New addresses – that have not yet been added to the NZ Post address database
When the HPI access team find a facility that is no longer operating they add a disestablishment date making the facility inactive on the HPI.
In FHIR this is represented in two ways. The facility will have:
Inactive facilities are returned via the API, either by searching for a facility or by doing a read on the resource (providng the hpi-facility-id).
The ability to exclude inactive facilites when searching for a facility is a requirement on the HPI FHIR backlog. Until this is delivered integrators wanting to view only active facilities will need to filter the search results to exclude facilites with a 'status of inactive' or with the 'estabished period end dated'.