Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://nzhts.digital.health.nz/fhir/ValueSet/air-related-person-relationship-code | Version: 2.7.0 | |||
| Active as of 2026-07-20 | Computable Name: AIRRelatedPersonRelationshipCode | |||
This value set is used to encode the relationship of a related person to the vaccine consumer. It is a subset of the FHIR Patient Relationship Type value set and includes some customised codes and displays for NZ usage.
References
This value set includes codes based on the following rules:
http://terminology.hl7.org/CodeSystem/v3-RoleCode version 📍4.0.0| Code | Display | Definition |
| MTH | mother | The player of the role is a female who conceives, gives birth to, or raises and nurtures the scoping entity (child). |
| FTH | father | The player of the role is a male who begets or raises or nurtures the scoping entity (child). |
| SIS | sister | The player of the role is a female sharing one or both parents in common with the scoping entity. |
| BRO | brother | The player of the role is a male sharing one or both parents in common with the scoping entity. |
| SON | son | The player of the role is a male offspring of the scoping entity (parent). |
| DAU | daughter | The player of the role is a female offspring of the scoping entity (parent). |
| UNCLE | uncle | The player of the role is a brother of the scoping person's mother or father. |
| AUNT | aunt | The player of the role is a sister of the scoping person's mother or father. |
| NEPHEW | nephew | The player of the role is a son of the scoping person's brother or sister or of the brother or sister of the scoping person's spouse. |
| NIECE | niece | The player of the role is a daughter of the scoping person's brother or sister or of the brother or sister of the scoping person's spouse. |
| COUSN | cousin | The player of the role is a relative of the scoping person descended from a common ancestor, such as a grandparent, by two or more steps in a diverging line. |
| GRFTH | grandfather | The player of the role is the father of the scoping person's mother or father. |
| GRMTH | grandmother | The player of the role is the mother of the scoping person's mother or father. |
| SPS | spouse | The player of the role is a marriage partner of the scoping person. |
| FTHFOST | foster father | The player of the role (parent) who is a male state-certified caregiver responsible for the scoper (child) who has been placed in the parent's care. The placement of the child is usually arranged through the government or a social-service agency, and temporary. The state, via a jurisdiction recognized child protection agency, stands as in loco parentis to the child, making all legal decisions while the foster parent is responsible for the day-to-day care of the specified child. |
| MTHFOST | foster mother | The player of the role (parent) who is a female state-certified caregiver responsible for the scoper (child) who has been placed in the parent's care. The placement of the child is usually arranged through the government or a social-service agency, and temporary. The state, via a jurisdiction recognized child protection agency, stands as in loco parentis to the child, making all legal decisions while the foster parent is responsible for the day-to-day care of the specified child. |
| STPFTH | stepfather | The player of the role is the husband of scoping person's mother and not the scoping person's natural father. |
| STPMTH | stepmother | The player of the role is the wife of scoping person's father and not the scoping person's natural mother. |
| GUARD | guardian | The role played by a person or institution legally empowered with responsibility for the care of a ward. |
| PRN | parent | The player of the role is one who begets, gives birth to, or nurtures and raises the scoping entity (child). |
http://terminology.hl7.org/CodeSystem/v2-0131 version 📍3.0.0
| Code | Display | Definition |
| E | Employer | Employer |
| O | Other | Other |
https://standards.digital.health.nz/ns/air-terms-code version 📦2.7.0
| Code | Display |
| WHANGAI | whāngai |
Expansion performed internally based on:
This value set contains 23 concepts
| System | Code | Display (en) | Definition | JSON | XML |
http://terminology.hl7.org/CodeSystem/v3-RoleCode | MTH | mother | The player of the role is a female who conceives, gives birth to, or raises and nurtures the scoping entity (child). | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | FTH | father | The player of the role is a male who begets or raises or nurtures the scoping entity (child). | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | SIS | sister | The player of the role is a female sharing one or both parents in common with the scoping entity. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | BRO | brother | The player of the role is a male sharing one or both parents in common with the scoping entity. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | SON | son | The player of the role is a male offspring of the scoping entity (parent). | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | DAU | daughter | The player of the role is a female offspring of the scoping entity (parent). | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | UNCLE | uncle | The player of the role is a brother of the scoping person's mother or father. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | AUNT | aunt | The player of the role is a sister of the scoping person's mother or father. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | NEPHEW | nephew | The player of the role is a son of the scoping person's brother or sister or of the brother or sister of the scoping person's spouse. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | NIECE | niece | The player of the role is a daughter of the scoping person's brother or sister or of the brother or sister of the scoping person's spouse. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | COUSN | cousin | The player of the role is a relative of the scoping person descended from a common ancestor, such as a grandparent, by two or more steps in a diverging line. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | GRFTH | grandfather | The player of the role is the father of the scoping person's mother or father. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | GRMTH | grandmother | The player of the role is the mother of the scoping person's mother or father. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | SPS | spouse | The player of the role is a marriage partner of the scoping person. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | FTHFOST | foster father | The player of the role (parent) who is a male state-certified caregiver responsible for the scoper (child) who has been placed in the parent's care. The placement of the child is usually arranged through the government or a social-service agency, and temporary. The state, via a jurisdiction recognized child protection agency, stands as in loco parentis to the child, making all legal decisions while the foster parent is responsible for the day-to-day care of the specified child. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | MTHFOST | foster mother | The player of the role (parent) who is a female state-certified caregiver responsible for the scoper (child) who has been placed in the parent's care. The placement of the child is usually arranged through the government or a social-service agency, and temporary. The state, via a jurisdiction recognized child protection agency, stands as in loco parentis to the child, making all legal decisions while the foster parent is responsible for the day-to-day care of the specified child. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | STPFTH | stepfather | The player of the role is the husband of scoping person's mother and not the scoping person's natural father. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | STPMTH | stepmother | The player of the role is the wife of scoping person's father and not the scoping person's natural mother. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | GUARD | guardian | The role played by a person or institution legally empowered with responsibility for the care of a ward. | ||
http://terminology.hl7.org/CodeSystem/v3-RoleCode | PRN | parent | The player of the role is one who begets, gives birth to, or nurtures and raises the scoping entity (child). | ||
http://terminology.hl7.org/CodeSystem/v2-0131 | E | Employer | Employer | ||
http://terminology.hl7.org/CodeSystem/v2-0131 | O | Other | Other | ||
https://standards.digital.health.nz/ns/air-terms-code | WHANGAI | whāngai |
Explanation of the columns that may appear on this page:
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| System | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |