HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

: NZ Residency status - JSON Representation

Active as of 2023-10-25

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "nz-residency",
  "meta" : {
    "versionId" : "10",
    "lastUpdated" : "2026-05-07T20:19:16.919+12:00",
    "tag" : [
      {
        "system" : "https://standards.digital.health.nz/ns/nzhts-usage-tags",
        "code" : "NZBase"
      }
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>NZ Residency status</h2><tt>https://standards.digital.health.nz/ns/nz-residency-code</tt><p>NZ Residency status</p></div>"
  },
  "url" : "https://standards.digital.health.nz/ns/nz-residency-code",
  "version" : "1.1.0",
  "name" : "NZResidency",
  "title" : "NZ Residency status",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-10-25T11:59:31.000Z",
  "publisher" : "HL7 New Zealand",
  "contact" : [
    {
      "name" : "HL7 New Zealand",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:admin@hl7.org.nz"
        }
      ]
    }
  ],
  "description" : "NZ Residency status",
  "caseSensitive" : true,
  "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code",
  "content" : "complete",
  "count" : 3,
  "concept" : [
    {
      "code" : "yes",
      "display" : "Permanent Resident",
      "definition" : "Use this status if the person holds a residence class visa"
    },
    {
      "code" : "no",
      "display" : "Not a Permanent Resident",
      "definition" : "Use this status for a person who is a NZ Citizen or does not hold a residence class visa"
    },
    {
      "code" : "unknown",
      "display" : "Unknown",
      "definition" : "use this status if the residency status of the person cannot be determined or is unknown"
    }
  ]
}