Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) - Local Development build (v2.0.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Compliance Testing Base API Tests

Compliance Testing Important Information

Compliance Testing Process

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

1. Tester Details
   • Organisation Name
   • Application name and version
   • Application HSAPP ID (if applicable)
   • AIR FHIR IG Version
   • Test Script Version
   • Testing Start Date and Time and End Date and Time
   • Tester Name and Contact Details
   • List of Operations Included in Your Integration (e.g., AIR Read, AIR Write)
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)
3. For each test supply a timestamp when each request is sent.

Test Data

AIR uses test identifiers from the NHI UAT environment. Do not update/change any of the immunisation data or NHI records in the table below. These consumers and related data are reserved for these compliance tests.

Vendors integrating with Write APIs (Create, Update, Upsert) will be provided NHI numbers for their testing.

To access a list of NHI test identifiers follow this link and search for text NHI Test Data. To specifically test the new NHI number format, go to Upcoming Changes to the NHI and download the spreadsheet under the heading 'Change to the check digit algorithm'.

Links

Compliance Test Structure

Test Specifications are grouped as follows.

Base API Compliance Testing (below)

• Base tests apply to all types of request to AIR APIs.

Search and Read Compliance Testing

• These tests apply to all applications accessing immunisation data.

Write Compliance Testing

• Write API tests apply to all requests that change immunisation data in the AIR.

Notifications Compliance Testing

• The National Event Management System (NEMS) is used by applications that hold immunisation data locally, namely Practice Management Systems (PMS), to receive update and duplicate resolution event notifications.

Terminology Service Compliance Testing

• The NZHTS provides standard codes, value sets and concept maps used by all applications that present or create immunisation data. Any application sending data to the AIR shall use terms and concept properties specified in the NZHTS to avoid validation failures. Subscriber applications shall synchronise terms with NZHTS on a regular cadence (typically nightly) using the NZHTS APIs.

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 (conditional). These tests apply only if you are using this data or functionality for your use case.

• ​A template for reporting compliance test results is available here: AIR_Compliance - Template v1.2.docx

• For further information, either add a comment to your onboarding request form or reach out using the Enquiry form.

Base Tests

Base API tests apply to all types of request to AIR APIs. For server end points refer to the Open API Specification available under the Support menu in this IG. Use the UAT end points for Compliance Testing.

        {
          "userIdentifier":"pms-user-id-123",
          "userRole":"PROV",
          "secondaryIdentifier":{
              "use":"official",
              "system":"https://standards.digital.health.nz/ns/medical-council-id",
              "value":"RA99Z"
          },
          "purposeOfUse":[
              "POPHLTH"
          ],
          "userFullName":"Beverly Crusher"
        }