New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Compliance Testing Important Information

### Compliance testing process

Provide the following details in a test report and email to integration@health.govt.nz.

1. Tester details
   a. Organisation Name
   b. Application name and version
   c. NHI IG Version
   d. Test Script version
   e. FHIR release version (Get(Endpoint)/metadata)
   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 Patient, Search(Match) Patient)

2. For each test supply screen shots of the user interface for:
   - the input data as entered in the integrating application (“the application”)
   - the output:
     - any error messages presented by the application
     - the confirmation or result of the request presented by the application
   - For update operations the state of the record pre-request should be included.
   - Note: If non-interactive, please provide JSON request (update / create) or response (get/search).
3. For each test supply a timestamp when each request is sent.

### Test Data

To access a list of NHI test identifiers follow this link. For a set of current formant identifiers and look for heading NHI Test identifiers and for new format NHI test identifiers see NHI records Mod23.

### Compliance tests

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

- If there are tests below that are labelled mandatory but do fit the application's use case then please let us know why.
- Some tests are labelled mandatory if. These tests are Mandatory only if you are using this piece of data for your use case.

To request a template for the compliance tests either add a comment to your onboarding request form or reach out using the Enquiry form.

#### Security and Audit Assessment

All test messages will be assessed against the security criteria in the table below
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 an hpi-person-id (CPN) | 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

#### General tests

These tests apply to all integrations
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 NHI 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 NHI terms of use can be included as part of the application's terms of use. | See Terms Of Use | The application will display terms of use to the end user The application must store the end users acceptance of the terms | Recommended

#### Extra Tests for New NHI number format

This set of tests allow you to self assess your readiness for the new NHI number format when interacting with the NHI and other HIP services. They can be used for FHIR, SOAP or the legacy HL7 interfaces.
Reference | Purpose | Input values | Expected outcome | Mandatory
--- | --- | --- | --- | ---
NHI-Extra-1 | Get new format NHI application behaves appropriately when a new format NHI number is produced | ZXE24NV ZUA48EH ZUT01RG | Output: Application does not error Minimum identity information is displayed for the patient | Optional
NHI-Extra-2 | Get dormant-1 application behaves appropriately when a request for a dormant new format NHI number returns a 'live' older format NHI number | ZNK28DJ | Input: user can enter new format NHI Output application should return live record 'ZKP3424' application does not error when an older format NHI is returned. Notification to the user that the requested NHI was dormant and the live NHI has been returned | Optional
NHI-Extra-3 | Get dormant-2 application behaves appropriately when a request for a dormat older format NHI number returns a 'live' new format NHI number | ZWX5200 | Input: user can enter the older format NHI Output application should return live record 'ZXE24NV' application does not error when an older format NHI is returned. Notification to the user that the requested NHI was dormant and the live NHI has been returned | Optional
NHI-Extra-4 | Search / Match new format NHI application behaves appropriately when a new format NHI number is returned in a search response | Use an NHI Search / Match request to retrieve patients below ZXE24NV Family Name: Federstein Given Name: Franklin Date of birth:1999-04-04 Gender: male ZUA48EH Family Name: Brady Given Names: Thomas, James Date of birth:1971-11-11 Gender: male ZUT01RG Family Name: Sparrow Given Names: James Date of birth:2000-11-12 Gender: male | Input: Search criteria can be entered Output: Application does not error when new formt NHI returned Minimum identity information is displayed for the patient | Optional
NHI-Extra-5 | Create new format NHI application can create a patient with a new format NHI number | Family Name: NEWNHI Add all other relevant ficticious data | Input: Create a new format NHI with Family name above Output: Application can create a patient successfully Application does not error | Optional
NHI-Extra-6 | Update new format NHI application can update a patient with a new format NHI number | Use NHI created above and update relevant attributes depending on use case Birthdate Birthplace Gender Ethnicity Name Address NZ Citizenship status | Input: User can input information to update Output: Application can update a new format NHI successfully Application does not error | Optional
NHI-Extra-7 | Get enrolment for new format application can return enrolment information for a new format NHI | ZXE24NV | Input: user can enter new format NHI Output: application can display enrolment information for new format NHI | Optional
NHI-Extra-8 | Create enrolment for new format application can create an enrolment for a new format NHI number | ZTL39SK ZWB84LW ZQF54PV | Input: user can create an enrolment for a new format NHI Output: enrolment created successfully | Optional
NHI-Extra-9 | Update enrolment for new format application can update an enrolment for a new format NHI number | update one of the enrolments created above, do all relevant tests: Service Practitioner Re-enrolment date Qualified encounter date Termination Reason | Input: user can update an enrolment for a new format NHI Output: enrolment updated successfully | Optional
NHI-Extra-10 | Get Medical Warning for new format application can return Medical Warning information for a new format NHI | ZAK21MS ZYC49PX | Input: user can enter new format NHI Output: application can display Medical Warning information for new format NHI | Optional
NHI-Extra-11 | Create Medical Warning for new format application can create a Medical Warning for a new format NHI number | ZTL39SK ZWB84LW ZQF54PV | Input: user can create a Medical Warning for a new format NHI Output: Medical Warning created successfully | Optional
NHI-Extra-12 | Update Medical Warning for new format application can update a Medical Warning for a new format NHI number | update one of the Medical Warnings created above | Input: User can update a Medical Warning for a new format NHI Output: Medical Warning updated successfully | Optional
NHI-Extra-13 | Get Health Care Event for new format NHI application can return Health Care Events for a new format NHI | ZDP92ZR ZVE74QH | Input: user can enter new format NHI Output: application can display Health Care Events for new format NHI | Optional