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

This page is part of the HL7® FHIR® New Zealand Base Implementation Guide (v3.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: Valid use values for NHI - JSON Representation

Active as of 2022-08-29

Raw json | Download

{
  "resourceType" : "ValueSet",
  "id" : "nhi-use",
  "meta" : {
    "versionId" : "6",
    "lastUpdated" : "2026-05-08T10:05:37.365+12:00",
    "tag" : [
      {
        "system" : "https://standards.digital.health.nz/ns/nzhts-usage-tags",
        "code" : "NZBase"
      }
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include these codes as defined in <a href=\"http://hl7.org/fhir/R4/codesystem-identifier-use.html\"><code>http://hl7.org/fhir/identifier-use</code></a><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://hl7.org/fhir/R4/codesystem-identifier-use.html#identifier-use-official\">official</a></td><td>Official</td><td>The identifier considered to be most trusted for the identification of this item. Sometimes also known as &quot;primary&quot; and &quot;main&quot;. The determination of &quot;official&quot; is subjective and implementation guides often provide additional guidelines for use.</td></tr><tr><td><a href=\"http://hl7.org/fhir/R4/codesystem-identifier-use.html#identifier-use-old\">old</a></td><td>Old</td><td>The identifier id no longer considered valid, but may be relevant for search purposes.  E.g. Changes to identifier schemes, account merges, etc.</td></tr></table></li></ul></div>"
  },
  "url" : "https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code",
  "version" : "1.0.0",
  "name" : "NHIUse",
  "title" : "Valid use values for NHI",
  "status" : "active",
  "experimental" : false,
  "date" : "2022-08-29T12:59:31+00:00",
  "publisher" : "HL7 New Zealand",
  "contact" : [
    {
      "name" : "HL7 New Zealand",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:admin@hl7.org.nz"
        }
      ]
    }
  ],
  "description" : "NHI Use codes",
  "compose" : {
    "include" : [
      {
        "system" : "http://hl7.org/fhir/identifier-use",
        "concept" : [
          {
            "code" : "official"
          },
          {
            "code" : "old"
          }
        ]
      }
    ]
  }
}