New Zealand NHI IG
1.4.1 - Release

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

Get Match And Validate Patient Compliance Testing

NHI Patient GET tests

Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
NHI-GET-1 application displays the minimum patient information required to confirm identity:
  • Preferred name including Given Name(s), Family Name
  • Date of Birth
  • Gender
  • Primary Address - including the building name
    		•  ZJS7596 Output: Minimum identity information is displayed for the patient Mandatory
    NHI-GET-2 application can display the Date of Death ZAT2348 Output: The application alerts the user that the patient is deceased and provides the date of death Mandatory
    NHI-GET-3 application can display all other identity data returned by the NHI in a GET response including:
  • All patient names with all name parts
  • Name Information Source
  • Date of Birth Information Source
  • Ethnicity information
  • All patient addresses and address parts
  • NZ Citizenship status
  • Country of Birth
  • Country of Birth source
  • Place of Birth
    		•  ZAT2364 Output: All identity information is displayed for the patient. The patient:
  • Is alive
  • Has 4 names - no name use + preferred = true, no name use + preferred = false, one ‘baby of’, one maiden
  • The preferred name should have all name parts populated
  • Has two addresses, the primary resedential (physical) address is overseas and the mailing (postal) address is in NZ
  • Has three ethnicities
  • Is a NZ citizen
    		•  *Mandatory if the application is using the data
    NHI-GET-4 application can display all other identity data returned by the NHI in a GET response including:
  • A non validated primary address
  • A year of birth and a year and month of death (partial dates)
  • Unknown citizenship
    		•  ZAT2496 Output: All identity information is displayed for the patient. This is for a patient record that has partial information in some fields. The patient has:
  • A not validated physical address
  • Partial date of death
  • Partial date of birth
    		•  Mandatory
    NHI-GET-5 application alerts the user that a requested NHI is dormant, and that the live NHI has been returned. ZAT2518 Outout: Notification to the user that the requested NHI was dormant and the live NHI has been returned
    Output: Patient Live NHI returned should be ZAT2496
    Output: Minimum identity information for the live NHI is displayed for the patient    		 Mandatory
    NHI-GET-6 application can receive and display NHI responses that have fields populated with the maximum allowable sizes (e.g. A given name of 50 characters, Other given name(s) of 100 characters, Family Name of 100 characters). ZBE4905 Output: Patient information supplied is displayed without loss of data
    This is for a patient record that has attribute values which are the maximum allowed field length in some fields
    The patient has the following fields fully populated in the test record (field lengths in parentheses):
  • Given name (50)
  • Other Given Name(s) (100)
  • Family Name (100)
  • Address line 1 (100)
  • Address lines 2-5 (50)
  • Building name/additional details (255)
    		•  Mandatory
    NHI-GET-7 application behaves appropriately when a new format NHI number is produced
    • ZXE24NV
    • ZUA48EH
    		 Output: Application does not error Mandatory
    NHI-GET-8 application can synchronize with local system in response to the NHI version changing ZCX7065
  • Do a GET
  • Update the patient details (to simulate a 3rd party updating the NHI info)
  • Do another GET
  • Demonstrate how end user can view the difference then synchronize
    		•  Mandatory
    NHI-GET-9 application presents the address parts appropriately, including multiple addresses. ZJM9567 Output: All address formats are displayed appropriately Mandatory
    NHI-GET-10 application can handle a response when a patient has
    only a family name;
    only a given name;
    multiple names    		 Do all
    ZAU8023
    ZAV8657
    ZHS7524     		Output:
  • application does not error
  • application returns all name parts when present
  • order of name parts is clear to the user
    		•  mandatory

    NHI Patient GET tests - Enrolled GP

    Only complete these if you have permission to vew a patient's enrolled GP
    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    NHI-GET-11 application can display the patients's enrolled General Practice details returned by the NHI in a GET response including:
    • The NES enrolment id
    • enrolment.startDate
    • enrolment.expiryDate
    • Practitioner identifier (CPN) and name
    • enrolling organisation ID and name
    • Facility ID and name
    1. ZKC4641
      • Practitioner
      • Organisation
      • Facility
    2. ZKC4633
      • Practitioner
      • Organisation
      • Facility
    3. ZAN5358
      • Organisation
      • Facility
    		 Output:
    • application does not error
    • application returns all General Practice details when present
    		 Mandatory

    NHI Patient GET tests - Contact details

    Only complete these if you have permission to vew a patient's contact details
    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    NHI-GET-12 application can display the patients's contact details returned by the NHI in a GET response including:
    • Home phone
    • Mobile phone
    • Email address
    1. ZKC4650
      • Home phone
      • Mobile phone
      • Email address
    2. ZKC4633
      • Home phone
      • Mobile phone
      • Email address
  • Output:
    • application does not error
    • application returns all Contact details when present
    		•  Mandatory

    NHI Patient Match tests

    If the Match tests are being completed in the absence of Patient Get tests then please complete the section below NHI Patient Match tests (Minimum data requirements).
    This is not a common use case so please discuss with the integration team prior to implementing
    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    NHI-Match-1 application allows the user to search using the following attributes:
    • Name
      • First name (Given Name)
      • Middle name (Other given name)
      • Last name (Family Name)
    • Date of birth (Full or partial)

    And to show that the application can present the minimum details to allow for adequate confirmation of identity.
    • Name
      • First name (Given Name)
      • Middle name (Other given name)
      • Last name (Family Name)
    • Date of birth (Full or partial)
    • Gender
    • Primary Address
    • Date of Death
    • NHI Identifier
    • Match Score
    • Display a flag/indicate when a patient in the search result has multiple names

    Note:
    • The application must display multiple results if they are returned.
    • Results must be presented in descending order of the match score.
    • Name
      • Given Name: Noah
      • Middle Name: James
      • Family Name: Owen
    • Gender: M
    • DOB: 1949-10-30 (30th October 1949)
    • Input: Minimum search criteria can be entered
    • Output:
      • The top result returned in the search should be NHI ZAT4626
      • Minimum search result identity attributes are all present in result list
    		 mandatory
    NHI-Match-2 (if applicable) application allows the user to search with additional match criteria
    If the application is populating any of these other parameters in your Match request then do this one too
    The additional criteria includes:
    • Address
    • Date of Death
    • Place of Birth
    • Country of Birth
    • Building name
    • Name
      • Given Name: Summer
      • Middle Name: Barbara
      • Family Name: MacKenzie
    • Gender: F
    • Date of Birth: 28-09-1954
    • Street: 167 Springfield Road
    • Suburb: St Albans
    • townOrCity: Christchurch
    • dateOfDeath: 1975-05
    • Place of Birth: Wellington
    • Country of Birth: India (Code ‘IN’)
    • Building name: Buildingnametest
    • Input: Additional Search Criteria can be populated
    • Output:First result returned in the search result list should be NHI ZAT4642
    		 mandatory (if applicable)
    NHI-Match-3 application can manage many NHI resources in the response bundle and that results are presented in descending order of the match score
    • Name
      • Given Name: Test
      • Middle Name:
      • Family Name: Test
    • Gender: M
    • DOB: 31-12-1999
    • Input: Above criteria can be entered
    • Output
      • 10 results are returned
      • The top result returned is NHI: ZAX6965 Score: 99
    		 mandatory
    NHI-Match-Error-1 application can return the appropriate error message to the user Use a Match request to try and retrieve a record with Given Name: Rhetoric Output: Expected error message: Date of Birth is a required mandatory
    NHI-Match-Error-2 application can return the appropriate error message to the user Use a Match request to try and retrieve a record with Date of Birth: 28-09-1954 Output: Expected error message: Name is required mandatory

    NHI Patient Match tests (Minimum data requirements)

    These tests are designed to prove minimum data requirements are met in the absence of doing the NHI Patient GET tests
    This is not a common use case so please discuss with the integration team prior to implementing
    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    NHI-Match-4 (NHI-Get-1) the application displays the minimum patient information required to confirm identity:
  • Preferred name including Given Name(s), Family Name
  • Date of Birth
  • Gender
  • Primary Address - including the building name
    		•  Use a Match request to retrieve ZJS7596 and demonstrate how you display the NHI details
    Family Name: Maraka
    Given Names: Jamie, Susan
    Date of birth:25-08-1977
    Gender: Female
    Address: 2 Tennyson Street, Napier South, Napier, 4110
    Use - Home
    Type - Physical     		Input: Above criteria can be entered
    Output: The top result returned is NHI: ZJS7596
    Output: Minimum identity information is displayed for the patient    		 Mandatory
    NHI-Match-5 (NHI-Get-2) application can display the Date of Death Use a Match request to retrieve ZAT2348 and demonstrate how you display the NHI details
    Family Name: Smith-Martin
    Given Names: Laura, Rose
    Date of birth:14-07-1970
    Gender: Female
    Address:
    Not validated-address-reason - No Fixed Abode,
    Domicile code - D091,
    Use - Home,
    Type - Physical     		Input: Above criteria can be entered
    Output: The top result returned is NHI: ZAT2348
    Output: The application alerts the user that the patient is deceased and provides the date of death    		 Mandatory
    NHI-Match-6 (NHI-Get-3) application can display all other identity data returned by the NHI in a GET response including:
    • All patient names with all name parts
    • Name Information Source
    • Date of Birth Information Source
    • Ethnicity information
    • All patient addresses and address parts
    • NZ Citizenship status
    • Country of Birth
    • Country of Birth source
    • Place of Birth
    		 Use a Match request to retrieve ZAT2364 and demonstrate how you display the NHI details
    Family Name: John
    Given Names: Levi, Sands
    Date of birth:26-02-1995
    Gender: Male     		Input: Above criteria can be entered
    Output: All identity information is displayed for the patient.
    The patient:
  • Is alive
  • Has 4 names - no name use + preferred = true, no name use + preferred = false, one ‘baby of’, one maiden
  • The preferred name should have all name parts populated
  • Has two addresses, the primary resedential (physical) address is overseas and the mailing (postal) address is in NZ
  • Has three ethnicities
  • Is a NZ citizen
    		•  Mandatory
    NHI-Match-7 (NHI-Get-4) application can display all other identity data returned by the NHI in a GET response including:
  • A non validated primary address
  • A year of birth and a year and month of death (partial dates)
  • Unknown citizenship
    		•  Use a Match request to retrieve ZAT2496 and demonstrate how you display the NHI details
    Family Name: Yossarian
    Given Names: John, Test
    Date of birth:01-01-1914
    Gender: Male     		Input: Above criteria can be entered
    Output: All identity information is displayed for the patient. This is for a patient record that has partial information in some fields. The patient has:
  • A not validated physical address
  • Partial date of death
  • Partial date of birth
    		•  Mandatory
    NHI-Match-8 (NHI-Get-6) application can receive and display NHI responses that have fields populated with the maximum allowable sizes (e.g. A given name of 50 characters, Other given name(s) of 100 characters, Surname of 100 characters) Use a Match request to retrieve ZBE4905 and demonstrate how you display the NHI details
    Family Name: SurnameVeryLongLongLongnamewithtoomanycharactersVeryVeryVeryLongLongLongnamewithtoomanycharacters
    Given Names: GivenVeryVeryLongLongLongnamewithtoomanycharacters, MiddleVeryLongLongLongnamewithtoomanycharactersVeryVeryVeryLongLongLongnamewithtoomanycharacters
    Date of birth:01-01-1974
    Gender: Female     		Input: Above criteria can be entered
    Output: The application can manage a patient record that has attribute values which are the maximum allowed field length in some fields
    The patient has the following fields fully populated in the test record (field lengths in parentheses):
  • Given name (50)
  • Other Given Name(s) (100)
  • Surname (100)
  • Address line 1 (100)
  • Address lines 2-5 (50)
  • Building name/additional details (255)
    		•  Mandatory
    NHI-Match-9 (NHI-Get-7) application behaves appropriately when a new format NHI number is produced Use a Match request to retrieve either ZZZ00AX or ZGT56KB and demonstrate how you display the NHI details
    1. ZZZ00AX
    Family Name: Newnhi
    Given Name: Format
    Date of birth:28-08-2020
    Gender: Female
    2. ZGT56KB
    Family Name: Kucharski
    Given Names: Markus, Christoff
    Date of birth:06-09-2013
    Gender: Male     		Input: Above criteria can be entered
    Output: Application does not error    		 Mandatory
    NHI-Match-10 (NHI-Get-8) application can synchronize with local system in response to the NHI version changing Use a Match request to retrieve ZCX7065, using details:
    Family Name: ALLEN
    Given Name: JOSEPH
    Date of birth:01-04-1950
    Gender: Female
  • Do a Match
  • Update the patient details (to simulate a 3rd party updating the NHI info)
  • Do another Match
  • Demonstrate how end user can view the difference then synchronize
    		•  Mandatory
    NHI-Match-11 (NHI-Get-9) application presents the address parts appropriately, including multiple addresses Use a Match request to retrieve ZJM9567 and demonstrate how you display the NHI details
    Family Name: MultipleAddress
    Given Name: Francis
    Date of birth:12-12-1982
    Gender: Male     		Input: Above criteria can be entered
    Output: All address formats are displayed appropriately    		 Mandatory
    NHI-Match-12 (NHI-Get-10) application can handle a response when a patient has
    only a surname;
    only a given name;
    multiple names    		 Use a Match request to retrieve all of the following and demonstrate how you display the NHI details
    1. ZAU8023
    Family Name: Magi
    Date of birth:01-01-2012
    Gender: Unknown
    2. ZAV8657
    Given Name: Cambridge
    Date of birth:12-04-1960
    Gender: Male
    3. ZHS7524
    Family Name: WILLIS
    Given Names: ELIZABETH, MARGARET
    Date of birth:15-06-2002
    Gender: Female     		Input: Above criteria can be entered for the 3 Match scenarios
    1. Output: The top result returned is NHI: ZAU8023
    2. Output: The top result returned is NHI: ZAV8657
    3. Output: The top result returned is NHI: ZHS7524
    Output: Application does not error
    Output: Application returns all name parts when present
    Output: Order of name parts is clear to the user     		Mandatory

    NHI Validate Patient tests

    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    NHI-Validate-1 application makes appropriate use or displays correct messaging for a positive Patient Validate with the minimum validate criteria
    • NHI number
    • Name
    • Birthdate
    • NHI: ZJS7596
    • Name
      • Given Name: Jamie
      • Middle Name: Susan
      • Family Name: Maraka
    • DOB: 1977-08-25 (25th August 1977)
    • Input: Minimum validate criteria can be entered
    • Output: The validate should return a successful result
    		 mandatory
    NHI-Validate-2 application makes appropriate use or displays correct messaging for a positive Patient Validate using other validate criteria
    • NHI: ZJS7596
    • Name
      • Given Name: Jamie
      • Middle Name: Susan
      • Family Name: Maraka
    • Gender: Female
    • DOB: 1977-08-25 (25th August 1977)
    • Address
      • Line: 2 Tennyson Street
      • Suburb: Napier South
      • City: Napier
      • Postcode: 4110
    • Input: Other validate criteria can be included
    • Output: The validate should return a successful result
    		 mandatory
    NHI-Validate-3 application makes appropriate use or displays correct messaging for a negative Patient Validate
    • NHI: ZJK9604
    • Name
      • Given Name: Jaime
      • Family Name: jones
    • Gender: Female
    • DOB: 1979-06-10 (10th June 1979)
    • Address
      • Line: "PO Box 525", "Whanganui 4541"
    • Input: Validate criteria can be entered
    • Output: The validate should return a negative result (Empty bundle)
    		 mandatory