Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.28.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.28.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : AIR Related Person Relationship Code - JSON Representation

Active as of 2026-08-04

Raw json | Download

    {
      "resourceType" : "ValueSet",
      "id" : "air-related-person-relationship-code",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ValueSet air-related-person-relationship-code</b></p><a name=\"air-related-person-relationship-code\"> </a><a name=\"hcair-related-person-relationship-code\"> </a><p>This value set includes codes based on the following rules:</p><ul><li>Include these codes as defined in <a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html\"><code>http://terminology.hl7.org/CodeSystem/v3-RoleCode</code></a><span title=\"Version is explicitly stated to be 4.0.0\"> version &#x1F4CD;4.0.0</span><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-MTH\">MTH</a></td><td style=\"color: #cccccc\">mother</td><td>The player of the role is a female who conceives, gives birth to, or raises and nurtures the scoping entity (child).</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-FTH\">FTH</a></td><td style=\"color: #cccccc\">father</td><td>The player of the role is a male who begets or raises or nurtures the scoping entity (child).</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SIS\">SIS</a></td><td style=\"color: #cccccc\">sister</td><td>The player of the role is a female sharing one or both parents in common with the scoping entity.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-BRO\">BRO</a></td><td style=\"color: #cccccc\">brother</td><td>The player of the role is a male sharing one or both parents in common with the scoping entity.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SON\">SON</a></td><td>son</td><td>The player of the role is a male offspring of the scoping entity (parent).</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DAU\">DAU</a></td><td>daughter</td><td>The player of the role is a female offspring of the scoping entity (parent).</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-UNCLE\">UNCLE</a></td><td style=\"color: #cccccc\">uncle</td><td>The player of the role is a brother of the scoping person's mother or father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-AUNT\">AUNT</a></td><td style=\"color: #cccccc\">aunt</td><td>The player of the role is a sister of the scoping person's mother or father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-NEPHEW\">NEPHEW</a></td><td style=\"color: #cccccc\">nephew</td><td>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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-NIECE\">NIECE</a></td><td style=\"color: #cccccc\">niece</td><td>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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-COUSN\">COUSN</a></td><td style=\"color: #cccccc\">cousin</td><td>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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-GRFTH\">GRFTH</a></td><td style=\"color: #cccccc\">grandfather</td><td>The player of the role is the father of the scoping person's mother or father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-GRMTH\">GRMTH</a></td><td style=\"color: #cccccc\">grandmother</td><td>The player of the role is the mother of the scoping person's mother or father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SPS\">SPS</a></td><td style=\"color: #cccccc\">spouse</td><td>The player of the role is a marriage partner of the scoping person.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-FTHFOST\">FTHFOST</a></td><td style=\"color: #cccccc\">foster father</td><td>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.<br/><br/>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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-MTHFOST\">MTHFOST</a></td><td style=\"color: #cccccc\">foster mother</td><td>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.<br/><br/>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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-STPFTH\">STPFTH</a></td><td style=\"color: #cccccc\">stepfather</td><td>The player of the role is the husband of scoping person's mother and not the scoping person's natural father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-STPMTH\">STPMTH</a></td><td style=\"color: #cccccc\">stepmother</td><td>The player of the role is the wife of scoping person's father and not the scoping person's natural mother.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-GUARD\">GUARD</a></td><td>guardian</td><td>The role played by a person or institution legally empowered with responsibility for the care of a ward.</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-PRN\">PRN</a></td><td>parent</td><td>The player of the role is one who begets, gives birth to, or nurtures and raises the scoping entity (child).</td></tr></table></li><li>Include these codes as defined in <a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v2-0131.html\"><code>http://terminology.hl7.org/CodeSystem/v2-0131</code></a><span title=\"Version is explicitly stated to be 3.0.0\"> version &#x1F4CD;3.0.0</span><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v2-0131.html#v2-0131-E\">E</a></td><td style=\"color: #cccccc\">Employer</td><td>Employer</td></tr><tr><td><a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v2-0131.html#v2-0131-O\">O</a></td><td style=\"color: #cccccc\">Other</td><td>Other</td></tr></table></li><li>Include these codes as defined in <a href=\"CodeSystem-air-terms-code.html\"><code>https://standards.digital.health.nz/ns/air-terms-code</code></a><span title=\"Version is not explicitly stated, which means it is fixed to the version provided in this specification\"> version &#x1F4E6;1.28.0-SNAPSHOT</span><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td></tr><tr><td><a href=\"CodeSystem-air-terms-code.html#air-terms-code-WHANGAI\">WHANGAI</a></td><td>whāngai</td></tr></table></li></ul></div>"
      },
      "url" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-related-person-relationship-code",
      "version" : "1.28.0-SNAPSHOT",
      "name" : "AIRRelatedPersonRelationshipCode",
      "title" : "AIR Related Person Relationship Code",
      "status" : "active",
      "experimental" : false,
      "date" : "2026-08-04T03:40:16+00:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://tewhatuora.govt.nz"
            }
          ]
        }
      ],
      "description" : "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.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "compose" : {
        "include" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
            "version" : "4.0.0",
            "concept" : [
              {
                "code" : "MTH"
              },
              {
                "code" : "FTH"
              },
              {
                "code" : "SIS"
              },
              {
                "code" : "BRO"
              },
              {
                "code" : "SON",
                "display" : "son"
              },
              {
                "code" : "DAU",
                "display" : "daughter"
              },
              {
                "code" : "UNCLE"
              },
              {
                "code" : "AUNT"
              },
              {
                "code" : "NEPHEW"
              },
              {
                "code" : "NIECE"
              },
              {
                "code" : "COUSN"
              },
              {
                "code" : "GRFTH"
              },
              {
                "code" : "GRMTH"
              },
              {
                "code" : "SPS"
              },
              {
                "code" : "FTHFOST"
              },
              {
                "code" : "MTHFOST"
              },
              {
                "code" : "STPFTH"
              },
              {
                "code" : "STPMTH"
              },
              {
                "code" : "GUARD",
                "display" : "guardian"
              },
              {
                "code" : "PRN",
                "display" : "parent"
              }
            ]
          },
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v2-0131",
            "version" : "3.0.0",
            "concept" : [
              {
                "code" : "E"
              },
              {
                "code" : "O"
              }
            ]
          },
          {
            "system" : "https://standards.digital.health.nz/ns/air-terms-code",
            "concept" : [
              {
                "code" : "WHANGAI",
                "display" : "whāngai"
              }
            ]
          }
        ]
      }
    }