NZ Shared Digital Health Record API
1.1.4 - release

NZ Shared Digital Health Record API - Local Development build (v1.1.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: HNZ Global Opt Out Reason Codes - JSON Representation

Active as of 2026-09-21

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "hnz-global-opt-out-reason",
  "meta" : {
    "versionId" : "1"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem hnz-global-opt-out-reason</b></p><a name=\"hnz-global-opt-out-reason\"> </a><a name=\"hchnz-global-opt-out-reason\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">version: 1</p></div><p>This  code system <code>https://fhir-ig.digital.health.nz/sdhr/CodeSystem/hnz-global-opt-out-reason</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">patient-choice<a name=\"hnz-global-opt-out-reason-patient-choice\"> </a></td><td>Patient choice</td><td>Global opt-off was recorded based on patient choice.</td></tr><tr><td style=\"white-space:nowrap\">patient-deceased<a name=\"hnz-global-opt-out-reason-patient-deceased\"> </a></td><td>Patient deceased</td><td>Global opt-off was recorded because the patient is deceased.</td></tr><tr><td style=\"white-space:nowrap\">imported-external-consent<a name=\"hnz-global-opt-out-reason-imported-external-consent\"> </a></td><td>Imported external consent</td><td>Global opt-off was imported from an external consent source.</td></tr></table></div>"
  },
  "url" : "https://fhir-ig.digital.health.nz/sdhr/CodeSystem/hnz-global-opt-out-reason",
  "version" : "1.1.4",
  "name" : "HNZGlobalOptOutReason",
  "title" : "HNZ Global Opt Out Reason Codes",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-09-21T23:47:20+00:00",
  "publisher" : "Health New Zealand",
  "contact" : [
    {
      "name" : "Health New Zealand",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://github.com/tewhatuora"
        }
      ]
    },
    {
      "name" : "HNZ Integration Team",
      "telecom" : [
        {
          "system" : "email",
          "value" : "integration@tewhatuora.govt.nz",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "This code system defines the reasons for an HNZ global opt-off decision.",
  "content" : "complete",
  "count" : 3,
  "concept" : [
    {
      "code" : "patient-choice",
      "display" : "Patient choice",
      "definition" : "Global opt-off was recorded based on patient choice."
    },
    {
      "code" : "patient-deceased",
      "display" : "Patient deceased",
      "definition" : "Global opt-off was recorded because the patient is deceased."
    },
    {
      "code" : "imported-external-consent",
      "display" : "Imported external consent",
      "definition" : "Global opt-off was imported from an external consent source."
    }
  ]
}