james-ansley / python-nhi

Checks strings against the New Zealand Ministry of Health NHI Validation Routine

Python-NHI

A function to check strings against the New Zealand Ministry of Health NHI Validation Routine. Supports the old and new NHI number formats specified in HISO 10046:2023.

Install

pip install python-nhi

Usage

from nhi import is_nhi

print(is_nhi("WLD9413"))  # True
print(is_nhi("zsc21tn"))  # True
print(is_nhi("zzZ0044"))  # False
print(is_nhi("ZZZ00AA"))  # False

Checks are case-insensitive.

Note: This does not check that the NHI number has been assigned to a person, it merely checks the NHI is consistent with the HISO 10046:2023 standard.

Excluding Testcases

NHI numbers that begin with Z are reserved for testing. If you wish to exclude these values, you will need to manually check for a Z prefix:

from nhi import is_nhi

value = "zvb97xq"

print(is_nhi(value))  # True
print(not value.upper().startswith("Z") and is_nhi(value))  # False

Note: This check does not mean that the NHI number has been assigned to a person, it just means that the NHI value is not reserved for testing.

See Also

• https://www.tewhatuora.govt.nz/publications/hiso-100462023-consumer-health-identity-standard/
• https://www.tewhatuora.govt.nz/our-health-system/digital-health/health-identity/national-health-index/information-for-health-it-vendors-and-developers

python-nhi's Issues

For NHI numbers in the new format, the calculated sum modulo 23 is subtracted from 23

For NHI numbers in the new format, the calculated sum modulo 23 is subtracted from 23
to give an index number

documentation: https://www.tewhatuora.govt.nz/publications/hiso-100462023-consumer-health-identity-standard/
and https://en.wikipedia.org/wiki/NHI_Number