### This page provides the master ruleset for the NHI FHIR API.

NHI Request Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Request BR RQ 100 Local Patient Record current A system must source the most recent Patient Record from the NHI before creating a request to update the Patient record (DR RQ 5000, DR RQ 5100) ??
Request BR RQ 200 Identity Confusion Definition Identity confusion occurs when:
- The identity information held for one patient is so similar to another patient, that the records may belong to the same patient OR
- The identity information held for a given patient is modified in such a way that the old and new identity information could belong to different patients		 ??
Request BR RQ 300 Duplication of identity A request must not create a record which is a duplicate of another Patient’s identity ?? WM02005 The patient identity information supplied may result in duplication of another identity. Are you sure this update is correct?
Request BR RQ 400 Identity divergence A request must not modify a record to the extent that the patient identity describes a different patient
Request BR RQ 500 Duplication of patient information A request must not result in duplication of information for a Patient
Request BR RQ 600 Adding deleted information A request must not result in information, removed from a Patient Record by the Ministry of Health, being added
Request BR RQ 700 Modification of registered information A request must not result in modification of information confirmed by authorised Agency (“registered” information)
Request BR RQ 800 Modification of information source A request must update the source of information only when the information is also provided.
Request BR RQ 900 Modification of verified information A request may modify active patient information for which evidence has been sighted (“verified” information)
Request BR RQ 1000 Modification of information which is not registered or verified A request may modify active patient information which is not ‘registered’ or verified’ information.
Request AR RQ 1000 Update to Registered value An update which results in an attribute Status of Registered must only be submitted via an authorised Agency update BR RQ 700 HTTP Error Error Code Error message
Request AR RQ 1100 Modify Registered Value An update must not modify or delete any information with a Status of Registered BR RQ 700 HTTP Error Error Code Error message
Request AR RQ 1200 Modify Source A request to update the value for a given information source for a core identity field must also include a value for that core identity field (e.g. if DOB information source is provided, the DOB must also be populated) BR RQ 800 HTTP Error Error Code Error message
Request DR RQ 5000 Local Patient Version A Patient Update request must contain the version number of the current Patient Record BR RQ 100 HTTP Error Error Code Error message
Request DR RQ 5100 NHI Status A Patient Update request must contain the live NHI number for the Patient Record BR RQ 100 HTTP Error Error Code Error message
Request DR RQ 5210 Requesting User Information Every request must include an http header item Userid that uniquely identifies the individual initiating the request Parent (Child) rule HTTP Error Error Code Error message
Request DR RQ 5220 Requesting User Information A UserID with format 99XXXX must be a valid HPI CPN (other formats for UserID are acceptable and will not be validated) Parent (Child) rule HTTP Error Error Code Error message
Request DR RQ 5230 Requesting User Information Userid supplied must be unique within the authenticated organisation. The organisation must be able to associate the userid with an individual user Parent (Child) rule HTTP Error Error Code Note: Rule applied in the integrating system
Request DR RQ 5300 Requesting Organisation Information The OAUTH2 token must contain identifiers for the requesting organisation and application Parent (Child) rule HTTP Error Error Code Error Message
Request DR RQ 5400 Request Information A web service request must contain Request Attributes:
- Correlation ID,
- Business Transaction ID,
- Creation Time,
- Service Version,
- Master Code Set Version		 Parent (Child) rule HTTP Error Error Code Error Message
Request DR RQ 5500 Delete mandatory Error A Patient identity update request cannot delete/inactivate mandatory data Parent (Child) rule HTTP Error Error Code Error Message

NHI Name Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Name BR NM 100 Patient Name A Patient must have at least one Active Name BR RQ 1000 HTTP Error Error Code Error Message
Name BR NM 200 Patient Preferred Name A Patient must have one Active Name which is preferred BR RQ 1000 HTTP Error Error Code Error Message
Name BR NM 300 Patient Active Names A Patient may have a maximum of 200 active Names BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 1000 Preferred Name Protection A Name which is the preferred name must be a name which is not protected BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 1100 Non Preferred Name Protection A non-preferred name may be protected (Name Protected Flag = 1) BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 1200 Adding Name Protection Name Protection Status must only be set to ‘protected’ by an authorised user BR RQ 900 HTTP Error Error Code Error Message
Name AR NM 1300 Removing Name Protection Name Protection Status must only be changed from ‘protected’ by an authorised user BR RQ 900 HTTP Error Error Code Error Message
Name AR NM 1400 Inactivate Name A non-preferred name may be made inactive (an inactive name is. not returned in web service responses) BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 1500 A non-preferred name may be deleted OOS HTTP Error Error Code Error Message
Name AR NM 1600 Selected Name Active An existing Name must be active to be updated BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 1700 Duplicate Name Definition A Name is a duplicate name for a given NHI number if all name identity attribute values match the values for an existing name for that NHI. Name identity attributes are:
- Name Prefix (Title),
- Given Name,
- Other Given Names,
- Family Name,
- Name Suffix 		BR RQ 500 HTTP Error Error Code Error Message
Name AR NM 1800 Duplicate Name Check A Name update request must not create a duplicate of an existing Name for an NHI number BR RQ 500 HTTP Error Error Code Error Message
Name AR NM 1900 Allow dormant NHI Name duplication An active Name for a Patient’s live NHI number may be a duplicate of a Name for a linked dormant NHI number: BR RQ 500 HTTP Error Error Code Error Message
Name AR NM 2000 Registered Name Definition A Registered Name is a name which has been verified by a Government Agency (Currently, a name which has a source of BREG, i.e. has been confirmed with a match to the Birth Register) BR RQ 700 HTTP Error Error Code Error Message
Name AR NM 2100 Registered Name Source A Name update which results in a Name Status of Registered Name must only be submitted via an authorised Agency update BR RQ 700 HTTP Error Error Code Error Message
Name AR NM 2200 Legacy Name Definition A Legacy Name is a name for which the most recent update:was requested via a Legacy HL7 request, OR was the automated database migration process from the Legacy NHI database to the IBM Initiate NHI database jump BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 2300 Legacy Name Source A 'Legacy Name' must only be submitted via a legacy HL7 update request BR RQ 1000 HTTP Error Error Code Error Message
Name AR NM 2400 Verified Name Definition A Verified Name is a name for which acceptable documentary evidence has been sighted by the person recording the name; i.e. Name Source is one of:
- BRCT Birth Certificate,
- NZCI NZ Certificate of Identity,
- NZCT NZ Citizenship Certificate,
- NZET NZ Emergency Travel Document,
- NZPV NZ Permanent Resident Visa (A New Zealand Permanent Resident Visa (not time bound) issued by Immigration New Zealand),
- NZTV NZ Resident Visa (A New Zealand Resident Visa (time bound) issued by Immigration New Zealand),
- NZRT NZ Refugee Travel Document, PPRT Passport 		BR RQ 1200 HTTP Error Error Code Error Message
Name AR NM 2500 Unverified Name Definition A Unverified Name is a name for which either no proof, or unacceptable documentary evidence, has been sighted by the person recording the name; i.e. Source is one of:
- NPRF No Proof Information provided (no proof) by patient/whanau,
- OTHR Other official document		 BR RQ 1200 HTTP Error Error Code Error Message
Name AR NM 2600 Partial Name Definition A Partial Name is a name which:
- contains only one of:{Given Name; Family Name}, AND
\ - is not Verified AND
- is not Registered 		BR RQ 1200 HTTP Error Error Code Error Message
Name AR NM 2700 Baby Of Name Source Baby Of Name must have source of NPRF BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5000 Mandatory Name Data A Patient Name Request must include the following information:
- At least one of {Given Name, Family Name}, AND
- Preferred Name Flag		 BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5100 Optional Name Data A Patient Name request may contain the following information:
Name Identity
- Name Prefix (title),
- Other Given Names,
- Name Suffix,
Name Quality
- Name Qualifier Code,
- Name Source
Name Usage
- Preferred Name Flag,
- Protected flag,
- Date effective from,
- Date effective to 		BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5200 Other Given Names Patient ‘Other Given Names’ are only allowed if the given name is populated BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5300 Name Excluded Characters A Patient Given Name, Other Given Names, and Family Name can include only the following characters:
Alphas (A-Z or a-z), hypens(-), spaces, apostrophes(', submitted in un-escaped form).
NHI Legacy HL7 messages cannot accept international characters.
Web services are expected to extend to support International characters once HL7 messaging is no longer in use.
International Language characters: Macrons (Maori) - â, â, Â, ç, Ç, î, Î, ô, Ô, û, Û, Umlauts (German) - ä ö ü ß Ä Ö Ü , l'accent aigu (French)- é, l'accent grave (French)- è à ù, l'accent circonflexe (French)- â ê î ô û, le tréma (French)- ë ï, la cedilla (French)- ç 		BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5400 Name First Letter The first character of a Patient First Name, and a Patient Family name must be one of:
- Alphas (A-Z or a-z),
- apostrophes(')		 BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5500 Name Minimum Alpha character A name field which is not null must contain at least one alphabetic character BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5600 Effective To Date A Patient Name Effective To Date must be greater than or equal to:
- the Patient Name Effective From Date, AND
- the Patient Date of Birth 		BR RQ 1000 HTTP Error Error Code Error Message
Name DR NM 5700 Name Version A Patient Name Update request must contain a valid, active Patient Name Set ID for the NHI record being updated.(i.e. the Name being updated is a current active name for the NHI ID being updated) BR RQ 1300 HTTP Error Error Code Error Message

NHI Address Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Address BR AD 100 Acceptable Patient Address An acceptable Patient Address must be:
- Validated by an Address Service; OR
- User Qualified as: {complete, unable to validate (address known but will not validate, validation service not available); OR
- not able to be validated (Unknown, No fixed Abode); OR
- an overseas address (Overseas)}		 HTTP Error Error Code Error Message
Address BR AD 200 Patient Primary Residential Address A Patient must have a single Primary Residential Address HTTP Error Error Code Error Message
Address BR AD 300 Patient Active Addresses A Patient may have up to 3 active Addresses HTTP Error Error Code Error Message
Address AR AD 1000 Adding Address Protection The Address Protection Status for an address must only be set to Yes (Protected) by an authorised user BR RQ 900 HTTP Error Error Code Error Message
Address AR AD 1100 Removing Address Protection Address Protection flag must only be changed from Protected to unprotected by an authorised user BR RQ 900 HTTP Error Error Code Error Message
Address AR AD 1200 Validated Primary Residential Address An validated Primary residential address must be a residential address i.e. Address Type must be 'Residential' i.e. it must be a physical address at which people can reside, Physical = Y, that is it is not a mailing only address. Note that an *unvalidated address* must also be residential. BR RQ 900 HTTP Error Error Code Error Message
Address AR AD 1300 Primary Address Protection A Patient Primary Residential Address must not be protected BR RQ 900 HTTP Error Error Code Error Message
Address AR AD 1400 Unvalidated Primary Residential Address A Patient Residential Address or Postal Address (alternate or secondary Address) may be Protected BR RQ 900 HTTP Error Error Code Error Message
Address AR AD 1500 Unvalidated Primary Residential Address An unvalidated Primary Residential Address must be a residential address BR RQ 900 HTTP Error Error Code Error Message
Address AR AD 1600 Selected Address Active Only an active address can be modified. In some cases an address is changed from inactive to active (e.g. an exact match on an existing inactive address for an add address request will result in the inactive address becoming active again) BR RQ 900,
BR RQ 1000		 HTTP Error Error Code Error Message
Address AR AD 1700 Duplicate Validated Address Definition A validated address is a duplicate address for a given NHI number if all NZ POST address line values match the values for an existing address for that NHI. BR RQ 500 HTTP Error Error Code Error Message
Address AR AD 1700 Duplicate unvalidated Address Definition An unvalidated address is a duplicate address for a given NHI number if all key address values match the values for an existing address for that NHI. Key address values:
- Address Type,
- Street Address / Address line 1,
- Additional street address / Address line 2,
- Suburb / Address line 3,
- Town/City / Address line 4,
- State or Province (Country) /Address Line 5,
- Address line 6 		BR RQ 500 HTTP Error Error Code Error Message
Address AR AD 1800 Duplicate Address Check An Address update request must not create a duplicate of an existing Address for an NHI number BR RQ 500 HTTP Error Error Code Error Message
Address AR AD 1900 Allow dormant NHI address duplication An active Address for a Patient’s live NHI number may be a duplicate of an Address for a linked dormant NHI number BR RQ 500 HTTP Error Error Code Error Message
Address AR AD 2000 Validated Residential Address must be Physical An Address which is validated by eSAM, and has a type ‘residential’, must be a Physical Address (i.e. is Physical = Y) BR RQ 1000 HTTP Error Error Code Error Message
Address AR AD 2100 Validated Mailing Address must be Deliverable An Address which is validated by eSAM, and has a type ‘mailing’, must be a deliverable Address (i.e. ‘Deliverable’ = Y) BR RQ 1000 HTTP Error Error Code Error Message
Address AR AD 2200 Residential Address must have domicile code A residential address must have at least one of:
- domicile code (source - eSAM domicile code),
- notional domicile code (source – web service call to location lookup file using address parameters),
- notional domicile code (source - optional web service request address parameter)}		 BR RQ 1000 HTTP Error Error Code Error Message
Address AR AD 2300 Address Type cannot change "An address type (residential or mailing) for an address cannot be modified. (i.e. to change type the address must be added with the required type)" HTTP Error Error Code Error Message
Address DR AD 5000 Address Mandatory Data An Address must include the following information:
- Street Address (line 1 of the customer provided address, AND
- Address Type, AND
- Primary Address Flag, AND
- UserValidationStatus choice 		BR RQ 1000 HTTP Error Error Code Error Message
Address DR AD 5200 Address Version A Patient Address Update request must contain a valid, active Patient Address Set ID for the NHI record being updated. BR RQ 900,
BR RQ 1000 		HTTP Error Error Code Error Message
Address DR AD 5300 Validated Address Match The result of an address service 'find address' request using the values provided for the first four lines of the Address Location must:
- result in a single validated address with a match score exceeding the match threshold, AND
- have a unique Address ID matching the unique ID provided in the request		 HTTP Error Error Code Error Message
Address DR AD 5500 Unvalidated Address Optional Data Rule: A Patient Address may include the following information:
- Building Name, Other Designation (Address Line 2),
- Suburb (Address Line 3),
- TownorCity (Address Line 4),
- Province (Address Line 5),
- Postal Code,
- Country Code (Address Line 6),
- latitude,
- longitude,
- Date Effective From,
- Date Effective To,
- Notional Domicile Code,
- Permanent Address Flag,
- Address protected Flag,
- Validated Address Unique ID		 BR RQ 1000 HTTP Error Error Code Error Message
Address DR AD 5600 Street Address Allowable Characters The street address:
- must contain at least one alphanumeric character, AND
- may contain any of [A-Za-z0-9 and these special characters - /',], AND
- the first character must be alphanumeric 		BR RQ 1000 HTTP Error Error Code Error Message

NHI Core Birth and Death Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Core - Birth and Death BR BD 100 Date of Birth A Patient must have a date of birth, which must be:
- After 1 January 1800, AND
- Not a future date		 AR BD 1100 HTTP Error Error Code Error Message
Core - Birth and Death BR BD 200 Date of Death A Patient may have a date of death, which must be:
- After 1 January 1800, AND
- On or after date of Birth, AND
- Not a future date		 AR BD 1100 HTTP Error Error Code Error Message
Core - Birth and Death BR BD 300 Place and Country of Birth A Patient may have:
- A Place of Birth,
- A Country of Birth		 AR BD 1100 HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1000 Registered DOB Status Definition A Registered Date of Birth is a date of birth which has been verified by a Government Agency (e.g. for Master Codeset 2.0, this would be a. DOB which has a source of BREG, i.e. has been confirmed with a match to the Birth Register) AR BD 1100 HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1100 Verified DOB Status Definition A Verified Date of Birth is a date of birth for which acceptable documentary evidence has been sighted by the person recording the name e.g. for Master Codeset 2.0, this would be a. DOB Source which is one of:
- BRCT Birth Certificate,
- NZCI NZ Certificate of Identity,
- NZCT NZ Citizenship Certificate,
- NZET NZ Emergency Travel Document,
- NZPV NZ Permanent Resident Visa A New Zealand Permanent Resident Visa (not time bound) issued by Immigration New Zealand,
- NZTV NZ Resident Visa A New Zealand Resident Visa (time bound) issued by Immigration New Zealand,
- NZRT NZ Refugee Travel Document, PPRT Passport		 HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1200 Unverified DOB Status Definition A Unverified Date of Birth is a date of birth for which either no proof, or unacceptable documentary evidence, has been sighted by the person recording the name e.g. for Master Codeset 2.0, this would be a. source is one of:
- NPRF No Proof Information provided (no proof) by patient/whanau,
- OTHR Other official document		 HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1300 Registered DOD Status Definition A Registered Date of Death is a date of death which has been verified by a Government Agency e.g. for Master Codeset 2.0, this would be a DOD which has a source of DREG, i.e. has been confirmed with a match to the Death Register HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1400 Provisional DOD status Definition A Provisional Date of Death is an unverified date of death for a death taking place in New Zealand. e.g. for Master Codeset 2.0, this would be a DOD which has a source of PROV, i.e. has been recorded, and not yet registered HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1500 Unverifiable DOD status Definition An unverifiable Date of Death is a date of death for a death taking place outside New Zealand, which will not appear on the death register. e.g. for Master Codeset 2.0, this would be a. DOD which has a source of OSEA, i.e. has been notified by a third party HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1600 Registered COB Definition A Registered Country of Birth is either a place and country of birth, or a country of birth only, which has been verified by a Government Agency e.g. for Master Codeset 2.0, this would be a COB which has a source of BREG, i.e. has been confirmed with a match to the Birth Register HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1700 Verified COB Definition A Verified Birthplace is either a place and country of birth, or a country of birth only, for which acceptable documentary evidence has been sighted by the person recording the birthplace. e.g. for Master Codeset 2.0, this would be a. COB Source which is one of:
- BRCT Birth Certificate,
- NZCI NZ Certificate of Identity,
- NZCT NZ Citizenship Certificate,
- NZET NZ Emergency Travel Document,
- NZPV NZ Permanent Resident Visa A New Zealand Permanent Resident Visa (not time bound) issued by Immigration New Zealand,
- NZTV NZ Resident Visa A New Zealand Resident Visa (time bound) issued by Immigration New Zealand,
- NZRT NZ Refugee Travel Document, PPRT Passport})		 HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1800 Unverified COB Definition A Unverified Country of Birth is either a place and country of birth, or a country of birth only, for which either no proof, or unacceptable documentary evidence, has been sighted by the person recording the birthplace HTTP Error Error Code Error Message
Core - Birth and Death AR BD 1900 Birth Information Source Update A request to populate the Date of Birth Information Source must also populate the Date of Birth BR RQ 800 HTTP Error Error Code Error Message
Core - Birth and Death AR BD 2000 Death Information Source Update A request to populate the Date of Death Information Source must also populate the Date of Death BR RQ 800
Core - Birth and Death AR BD 2100 COB Information Source Update A request to populate the Country of Birth Information Source must also populate the Country of Birth BR RQ 800
Core - Birth and Death AR BD 2200 Add Registered Birth Death Value A web service request must not add any birth and death information with a Status of Registered, i.e. Registered Date of Birth, Registered Date of Death, Registered Country of Birth BR RQ 700
Core - Birth and Death AR BD 2300 Modify Registered Birth Death Value An update request must not modify or delete any birth and death information with a Status of Registered, i.e. Registered Date of Birth, Registered Date of Death, Registered Country of Birth BR RQ 700
Core - Birth and Death AR BD 2400 Modify Verified Birth Death Value An update request must not modify or delete any birth and death information with a Status of Verified, i.e. Verified DOB, Verified COB BR RQ 900
Core - Birth and Death DR BD 5000 Partial DOB Definition When assessing data against rules, a partial date of birth will be interpreted as follows:
YYYYMM - the first day of the specified month in the year of birth (e.g July 2010 is interpreted as 1 July 2010);
YYYY - 1 January in the specified year of Birth (e.g. 2010 is interpreted as 1 January 2010)
Core - Birth and Death DR BD 5100 Partial DOD Definition When assessing data against rules, a partial date of death will be interpreted as follows:
YYYYMM - the last day of the specified month in the year of death (e.g. July 2010 is interpreted as 31 July 2010);
YYYY - 31 December in the specified year of death (e.g. 2010 is interpreted as 31 December 2010)
Core - Birth and Death DR BD 5200 DOB real The Date of Birth must be a date which is less than or equal to today’s date expressed in the same date format as the submitted date. i.e. if the date of birth format is:
YYYYMMDD - DOB less than or equal to the current date;
YYYYMM – less than or equal to the current month and year;
YYYY – less than or equal to the current year		 BR BD 100
Core - Birth and Death DR BD 5300 DOD real The Date of Death must be a date which is less than or equal to today’s date expressed in the same date format as the submitted date. i.e. if the date of death format is:
YYYYMMDD - DOD less than or equal to the current date;
YYYYMM – less than or equal to the current month and year;
YYYY – less than or equal to the current year		 BR BD 200
Core - Birth and Death DR BD 5400 DOD on or after DOB The Date of Birth must be less than or equal to the Date of Death BR BD 200
Core - Birth and Death DR BD 5500 Place of Birth A place of birth must only be populated if a country of birth is populated BR BD 300

NHI Core Gender Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Core - Gender BR GD 100 Gender A Patient must have a current gender

NHI Core Ethnicity Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Core - Ethnicity BR ET 100 Ethnicity A Patient must have one active set of ethnicity information
Core - Ethnicity BR ET 200 Replace ethnicity on update A Patient must supply all ethnicities identified with when supplying ethnicity information
Core - Ethnicity AR ET 1000 Acceptable Ethnicity information Definition A valid set of Ethnicity information:
- contains at least one, and up to 6, detailed (level four) ethnic groups, AND
- each code appears only once in the set (i.e. no duplicate values), AND
- contains a maximum of one residual code (9xxxx), AND
- does not contain code 96666 (repeated value), AND
- does not contain code 98888 (response out of scope)
Core - Ethnicity AR ET 1100 Update Ethnicity A Patient Core identity update to Ethnicity must have an acceptable set of ethnicity information BR ET 100
Core - Ethnicity AR ET 1200 Complete Ethnicity A Patient Core identity update to Ethnicity must replace the existing set of ethnicity information BR ET 200
Core - Ethnicity DR ET 5000 Valid residual codes n ethnicity update may contain a maximum of one residual (9xxxx) ethnicity code, and must:
- contain only one 9xxxx code (i.e. a residual code must not be applied in conjuction with any other code), AND
- not contain unused code 96666 (repeated value); AND
- not contain unused code 98888 (response out of scope) 		AR ET 1000

NHI Core NZ Citizenship Rules

Rule Type Rule ID Title Rule description Parent (Child) rule HTTP Error Error Code Error message
Core - NZ Citizenship BR NZ 100 NZ Citizenship A Patient may have an NZ Citizenship status
Core - NZ Citizenship AR NZ 1000 Registered NZ Citizenship Status Definition A Registered NZ Citizenship status is a patient who holds NZ Citizenship and the citizenship status has been verified by a Government Agency
Core - NZ Citizenship AR NZ 1100 Verified NZ Citizenship Status Definition A Verified NZ Citizenship Status is a patient who holds NZ Citizenship for which acceptable documentary evidence has been sighted by the person recording the NZ Citizenship status
Core - NZ Citizenship AR NZ 1200 Unverified NZ Citizenship Status Definition A Unverified NZ Citizenship status is a patient who states they hold NZ Citizenship, for which either no proof, or unacceptable documentary evidence, has been sighted by the person recording the NZ Citizenship status
Core - NZ Citizenship AR NZ 1300 Derived NZ Citizenship status Definition A Derived NZ Citizenship Status is a patient who was born in New Zealand prior to 1 January 2006.
Core - NZ Citizenship AR NZ 1400 Non Citizen NZ Citizenship status Definition A Non Citizen NZ Citizenship status is a patient who states they do not hold NZ citizenship, with or without documentary evidence.
Core - NZ Citizenship AR NZ 1500 Unknown NZ Citizenship Status Definition An Unknown NZ Citizenship status is a patient who is unable or unwilling to provide any information about their NZ Citizenship status
Core - NZ Citizenship AR NZ 1600 NZ Citizenship Information Source Update A request to populate the NZ Citizenship Information Source must also populate the NZ Citizenship status value BR RQ 700
Core - NZ Citizenship AR NZ 1700 Modify Verified NZ Citizenship Value An update request must not modify or delete NZ Citizenship information with a Status of Verified, i.e. Verified NZ Citizenship Status BR RQ 900