New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Provide the following details in a test report and email to integration@health.govt.nz.
Tester details
a. Organisation Name
b. Application name and version
c. HPI IG Version
d. Test Script version
e. FHIR release version
f. Testing start date and time and end date and time
g. Tester name and contact details
h. List of operations included in your integration (eg Get Practitioner, Get Location, Search Location)
Not all compliance tests in this implementation guide will be appropriate for every application. If there are tests that do not apply please discuss this with the integration team and where appropriate write a description in the compliance test submission why the particular test does not apply.
Mandatory vs Optional tests
To request a template for the compliance tests either add a comment to your onboarding request form or reach out using the Enquiry form.
Reference | Purpose | Input values | Expected outcome | Mandatory |
---|---|---|---|---|
Security 1 | Credentials match those issued to the testing organisation and their orgID and appID are auditing correctly |
Checked against all tests | Te Whatu Ora will check internal logs | Mandatory |
Security 2 | Sending user ID is an end user ID or a hpi-person-id | Checked against all tests | Te Whatu Ora will check internal logs | Mandatory |
Security 3 | Sending user ID changes when different end users are initiating the request (Please make sure a seperate user creates a request) | Checked against all tests | Te Whatu Ora will check internal logs | Mandatory |
Security 4 | Each request has a unique request id in the X-Correlation-Id field If present this will be returned in the response |
Checked against all tests | Te Whatu Ora will check internal logs | Recommended |
Reference | Purpose – Demonstrate that the | Input values | Expected outcome | Mandatory / Optional / Recommended |
---|---|---|---|---|
General-1 | Application can handle an HTTP 429 error in a graceful way | The application reaches its usage plan limit and is returned an HTTP 429 error. See Usage plans | The application will retry several times with an exponentially increasing delay | Recommended |
General-2 | Application can present the HPI terms of use to individual user's when the integrating application first goes live for an Organisation. A reference terms of use is supplied, or the HPI terms of use can be included as part of the application's terms of use. | See Terms Of Use | Recommended |