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

Practitioner Role Compliance Testing

HPI PractitionerRole minimum data requirements Get and Search

Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
HPI-PR-MD-1 application can Get a record using the hpi-practitionerrole-id
  • Get: R00000055-Q
  • Search: NA
  • Input:
    • Get: HPI-PractitionerRole-id
    • Search: NA
  • Output:
    • Record returned and appropriate parts displayed correctly (use case dependent).
 Mandatory - use case dependent
HPI-PR-MD-2 application allows the user to search using the minimum search criteria and displays the search results in order appropriate to use case
  • Get:N/A
  • Search: Search criteria (practitioner).
    		•
    • Input:
      • 97ZABV
    • Output:
      • - Search results displayed in appropriate order (use case dependent).
    		 Mandatory - use case dependent
    HPI-PR-MD-3 application allows the user to search using other search criteria depending on the use case.
    Make sure the search criteria you are using is relevant for the use case (Reference to Health Information Privacy Code 2020, Rule 1).
    • Get:N/A
    • Search:
      • Practitioner - 97ZABV
      • Organisation - GZZ998-G
      • Facility - FZZ961-K
      • Role code - 542114
      • Active - True / False
    • Input:
      • hpi-person-id (CPN) an,
      • other search criteria can be included
    • Output:
      • - Search results displayed in appropriate order (use case dependent).
    		 Mandatory - depdending on use case
    HPI-PR-MD-4 application will show the correct error when attempting to search without a Practitioner
    • Get:N/A
    • Search: using one of the other criteria only
      • Organisation
      • Location
      • Role
      • Active(status)
    • Input:
      • other search criteria provided
    • Output:
      • - Error EM07201: Display Required value missing
    		 Mandatory - depdending on use case
    HPI-PR-MD-5 application does not error, and can provide relevant information for each of the following scenarios.
    A PractitionerRole record with:
    1. Practitioner, Facility, Role code
    2. Practitioner, Organisation, Role code
    3. Practitioner, Organisation, Facility, Role code
    4. Practitioner, Organisation, Facility, Role code, period
    		 Do all
      • Get:R00000161-P
      • Search: practitioner:97ZABV, location:FZZ961-K, role:542111
      • Get:R00000160-M
      • Search: practitioner:97ZABV, organization:GZZ998-G, role:542111
      • Get:R00000162-R
      • Search: practitioner:97ZABV, location:FZZ961-K, organization:GZZ998-G, role:512211
      • Get:R00000167-B
      • Search: practitioner:97ZABV, location:FZZ961-K, organization:GZZ998-G, role:521111
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • Record returned and appropriate parts displayed correctly (use case dependent).
    		 Mandatory - use case dependent
    HPI-PR-MD-6 application can make appropriate use of the facility messaging address and / or PractitionerRole messaging address. Do both
    1. PracRole without messaging address
      • Get:PracRole-ID (withoutEDI)
      • Search: Search criteria (withoutEDI).
    2. PracRole with messaging address
      • Get:PracRole-ID (withEDI)
      • Search: Search criteria (withEDI).
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • application makes appropriate use of messaging address.
    		 Mandatory - if using messaging address.
    HPI-PR-MD-7 application can make appropriate use of contact details
    A PractitionerRole record with:
    • an email address
    • a phone number
    • contact rank
  • Get:Pracrole-ID (with email and phone).
  • Search: Search criteria (with email and phone).
    		•
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • application makes appropriate use of contact details.
    		 Mandatory - if using contact details
    HPI-PR-MD-8 application can make appropriate use of contact details where record has multiple sets, including contact rank.
    A PractitionerRole record with:
    • 2 email addresses
    • 3 phone number's
    • mixture of temp and work
    • contact rank
  • Get:Pracrole-ID (with 2email and 3phone).
  • Search: Search criteria (with 2email and 3phone).
    		•
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • application makes appropriate use of contact details.
    		 Mandatory - if using contact details
    HPI-PR-MD-9 application makes appropriate use of a PractitionerRole record that is not active (has period end date and end reason).
  • Get:Pracrole-ID (not active).
  • Search: Search criteria (not active).
    		•
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • application makes appropriate use of PractitionerRole record that as ended.
    		 Mandatory
    HPI-PR-MD-10 application makes appropriate use of a PractitionerRole record without a period.
  • Get:Pracrole-ID (no period).
  • Search: Search criteria (no period).
    		•
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • application makes appropriate use of PractitionerRole record without a period.
    		 Mandatory
    HPI-PR-MD-11 application behaves appropriately when confidentiality settings have been set for a practitioner
  • Get:Pracrole-ID (practitioner with c).
  • Search: Search criteria (practitioner with c).
    		•
    • Input:
      • Get: HPI-PractitionerRole-id
      • Search: Criteria provided
    • Output:
      • application returns appropriate messaging to user.
    		 Mandatory

    HPI Create PractitionerRole

    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    HPI-PR-Create-1 application can create a PractitionerRole record with the minimum criteria provided
    • hpi-person-id
    • hpi-facility-id or hpi-org-id
    • role code
    		 Select required identifiers from the test dataset
    • Input:
      • User can input minimum data to create a PractitionerRole record
    • Output
      • PractitionerRole record is created with minimum dataset.
    		 mandatory
    HPI-PR-Create-2 application can create a PractitionerRole record with additional items provided
    • hpi-person-id
    • hpi-facility-id and/or hpi-org-id
    • role code
    • contact points (as many as required)
    • period
    • messaging address
    		 Create record with identifiers from the test dataset
    Use all information required by use case
    • Input:
      • User can create a PractitionerRole record with the additional items
    • Output
      • PractitionerRole record is created with additional items included.
    		 mandatory - use case dependent
    HPI-PR-Create-3 describe the business process used if a health provider asks for their record to be labelled confidential Create record with identifiers from the test dataset
    Use all information required by use case
    		Description of business process to request Te Whatu Ora to set confidential security label optional
    HPI-PR-Create-error-1 application will show the correct error when attempting to create a PractitionerRole without a Practitioner CPN (hpi-person-id) Create record with only an hpi-organisation-id or hpi-facility-id Error: EM07201
    Display "Required value missing"
    Text: PractitionerRole.Practitioner    		 Mandatory
    HPI-PR-Create-error-2 application will show the correct error when attempting to create a PractitionerRole without an organisation or facility. Create record with only an hpi-person-id (CPN) Error: EM07201
    Display "Required value missing"
    Text: PractitionerRole.Facility, PractitionerRole.Organisation    		 Mandatory
    HPI-PR-Create-error-3 application will show the correct error when attempting to create a PractitionerRole without a role code. Create record without a role code Error: EM07201
    Display "Required value missing"
    Text: PractitionerRole.code    		 Mandatory
    HPI-PR-Create-error-4 aapplication will show the correct error when attempting to create a duplicate PractitionerRole record Create a duplicte Practitionerrole See duplicate definition Error: EM07201
    Display "Required value missing"
    Text: PractitionerRole    		 Mandatory

    HPI PractitionerRole Update

    Reference Purpose – Demonstrate that the Input values Expected outcome Mandatory
    HPI-PR-Update-1 application can replace the contact details on a PractitionerRole record Update PracRole xxx with multiple contact details e.g.
    • system-phone
      • use - work
      • rank -1
      • value-ficticious
    • system-phone
      • use - work
      • rank -2
      • value-ficticious
    • system-phone
      • use - temp
      • rank - 2
      • value-ficticious
    • Input
      • User can input new contact information
    • Output:
      • Contact details are added to the HPI record correctly
      • Contact information displayed to the user
    		 mandatory - use case dependent
    HPI-PR-Update-2 application can replace just the phone number on a PractitionerRole record Update PracRole used above with:
    • Replace this contact:
      • system-phone
        • use - work
        • rank -1
        • value-ficticious
    • With this contact information
      • system-phone
        • use - work
        • rank - 5
        • value-ficticious
    • Input
      • User can input new contact information
    • Output:
      • Contact details are added to the HPI record correctly, other contact details remain unchanged
      • Contact information displayed to the user
    		 mandatory- use case dependent
    HPI-PR-Update-3 application can remove a contactpoint on a PractitionerRole record Update PracRole used above and remove:
  • This contact information
    • system-phone
      • use - temp
      • rank - 2
      • value-ficticious
    		•
    • Input
      • User can update contact information
    • Output:
      • Output: temp phone is removed from the HPI record, other contact details remain unchanged
      • Contact information displayed to the user
    		 mandatory- use case dependent
    HPI-PR-Update-4 application can update the contact rank on a PractitionerRole record
    • Replace this contact rank:
      • system-phone
        • use - work
        • rank -2
    • With this contact information
      • system-phone
        • use - work
        • rank - 1
    • Input
      • User can update contact rank only
    • Output:
      • Output: Contact rak is updated, other contact details remain unchanged
      • Contact information displayed to the user
    		 mandatory- use case dependent
    HPI-PR-Update-5 application can add / replace the messaging address on a PractitionerRole record update PractitionerRole used above with Messaging address
    • provider - heathlink
    • value “ficticious value”
    • Input
      • User can input messaging address
    • Output:
      • Output: Messaging address added to the HPI PractitionerRole record correctly
      • Contact information displayed to the user
    		 mandatory- use case dependent
    HPI-PR-Update-6 application can end a PractitionerRole record Use role created above
    add an end date an end reason
    • Input
      • user can add an end date and end reason
    • Output:
      • Output: Details displayed to user
    		 mandatory
    HPI-PR-Update-6 application can remove an end date on a PractitionerRole record Use PractitionerRole above
    remove the end date an end reason
    • Input
      • user can remove an end date and end reason
    • Output:
      • Output: Details displayed to user
    		 mandatory
    HPI-PR-Update-error-1 application will show the correct error when attempting to update a PractitionerRole record with an end date and no reason Use PractitionerRole above
    add an end date only     		Error: EM07201
    Display "Required value missing"
    Text:PractitionerRole.statusReason    		 mandatory
    HPI-PR-Update-error-2 application will show the correct error when attempting to update a PractitionerRole record with an end reason and no end date Use PractitionerRole above
    add an end date only     		Error: EM07201
    Display "Required value missing"
    Text:PractitionerRole.period.end    		 mandatory