Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.3 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Codes for Template category - JSON Representation

Active as of 2025-11-25

Raw json | Download

    {
      "resourceType" : "CodeSystem",
      "id" : "hnz-template-category-codes",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem hnz-template-category-codes</b></p><a name=\"hnz-template-category-codes\"> </a><a name=\"hchnz-template-category-codes\"> </a><p>This case-insensitive code system <code>https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-template-category-codes</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td></tr><tr><td style=\"white-space:nowrap\">eligible<a name=\"hnz-template-category-codes-eligible\"> </a></td><td>Notifies a participant that they are eligible for a screening</td></tr><tr><td style=\"white-space:nowrap\">enrolled<a name=\"hnz-template-category-codes-enrolled\"> </a></td><td>Confirms enrolment in a screening program and what is this means</td></tr><tr><td style=\"white-space:nowrap\">recall<a name=\"hnz-template-category-codes-recall\"> </a></td><td>Sends a recall notice for a screening</td></tr><tr><td style=\"white-space:nowrap\">routineReminder<a name=\"hnz-template-category-codes-routineReminder\"> </a></td><td>Sends a routine reminder for a scheduled screening</td></tr><tr><td style=\"white-space:nowrap\">repeatReminder<a name=\"hnz-template-category-codes-repeatReminder\"> </a></td><td>Sends a reminder for a missed or rescheduled screening</td></tr><tr><td style=\"white-space:nowrap\">invalidReminder<a name=\"hnz-template-category-codes-invalidReminder\"> </a></td><td>Indicates an invalid reminder (e.g., sent to an ineligible participant)</td></tr><tr><td style=\"white-space:nowrap\">postReminder<a name=\"hnz-template-category-codes-postReminder\"> </a></td><td>Sends a post-screening reminder or follow-up information</td></tr><tr><td style=\"white-space:nowrap\">withdrawnAcknowledgement<a name=\"hnz-template-category-codes-withdrawnAcknowledgement\"> </a></td><td>Acknowledges a participant's withdrawal from the program</td></tr><tr><td style=\"white-space:nowrap\">withdrawnPending<a name=\"hnz-template-category-codes-withdrawnPending\"> </a></td><td>Indicates that a withdrawal request is pending</td></tr><tr><td style=\"white-space:nowrap\">withdrawnCompleted<a name=\"hnz-template-category-codes-withdrawnCompleted\"> </a></td><td>Confirms that a withdrawal request has been processed</td></tr><tr><td style=\"white-space:nowrap\">withdrawncancelled<a name=\"hnz-template-category-codes-withdrawncancelled\"> </a></td><td>Indicates that a withdrawal request has been canceled</td></tr><tr><td style=\"white-space:nowrap\">unenrolled<a name=\"hnz-template-category-codes-unenrolled\"> </a></td><td>Notifies a participant that they have been unenrolled from the program</td></tr></table></div>"
      },
      "url" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-template-category-codes",
      "version" : "0.4.3",
      "name" : "TemplateCategoryCodes",
      "title" : "Codes for Template category",
      "status" : "active",
      "experimental" : false,
      "date" : "2025-11-25T02:00:55+00:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.tewhatuora.govt.nz/"
            }
          ]
        },
        {
          "name" : "Te Whatu Ora Integration Team",
          "telecom" : [
            {
              "system" : "email",
              "value" : "integration@tewhatuora.govt.nz",
              "use" : "work"
            }
          ]
        }
      ],
      "description" : "Each code represents a Template category",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "NZ",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "purpose" : "specific category tied to a Template.",
      "caseSensitive" : false,
      "content" : "complete",
      "count" : 12,
      "concept" : [
        {
          "code" : "eligible",
          "display" : "Notifies a participant that they are eligible for a screening"
        },
        {
          "code" : "enrolled",
          "display" : "Confirms enrolment in a screening program and what is this means"
        },
        {
          "code" : "recall",
          "display" : "Sends a recall notice for a screening"
        },
        {
          "code" : "routineReminder",
          "display" : "Sends a routine reminder for a scheduled screening"
        },
        {
          "code" : "repeatReminder",
          "display" : "Sends a reminder for a missed or rescheduled screening"
        },
        {
          "code" : "invalidReminder",
          "display" : "Indicates an invalid reminder (e.g., sent to an ineligible participant)"
        },
        {
          "code" : "postReminder",
          "display" : "Sends a post-screening reminder or follow-up information"
        },
        {
          "code" : "withdrawnAcknowledgement",
          "display" : "Acknowledges a participant's withdrawal from the program"
        },
        {
          "code" : "withdrawnPending",
          "display" : "Indicates that a withdrawal request is pending"
        },
        {
          "code" : "withdrawnCompleted",
          "display" : "Confirms that a withdrawal request has been processed"
        },
        {
          "code" : "withdrawncancelled",
          "display" : "Indicates that a withdrawal request has been canceled"
        },
        {
          "code" : "unenrolled",
          "display" : "Notifies a participant that they have been unenrolled from the program"
        }
      ]
    }