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

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

: EmailCommunicationTemplateExample - JSON Representation

Raw json | Download

{
  "resourceType" : "DocumentReference",
  "meta" : {
    "profile" : [
      🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/TemplateDocumentReference"
    ],
    "tag" : [
      {
        "system" : "https://hub.services.digital.health.nz/ns/correlation-id",
        "code" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      }
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: DocumentReference EmailCommunicationTemplateExample</b></p><a name=\"EmailCommunicationTemplateExample\"> </a><a name=\"hcEmailCommunicationTemplateExample\"> </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\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-TemplateDocumentReference.html\">CMSTemplateDocumentReference</a></p><p style=\"margin-bottom: 0px\">Tag: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (Details: correlation-id code xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)</p></div><p><b>status</b>: Current</p><p><b>docStatus</b>: Final</p><p><b>category</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-template-category-codes eligible}\">Notifies a participant that they are eligible for a screening</span></p><p><b>date</b>: 2024-08-20 14:30:00+0000</p><p><b>description</b>: Participant is due for first-time screening (i.e. Pathway status has been updated to eligible): This would be triggered by a participant turning 25 (aged in) or having acquired a new NHI #</p><blockquote><p><b>content</b></p><p><b>CMS Template Content Type Extension</b>: body</p><h3>Attachments</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ContentType</b></td><td><b>Data</b></td><td><b>Creation</b></td></tr><tr><td style=\"display: none\">*</td><td>text/html</td><td><code>PHA+RGVhciB7e1BhdGllbnROYW1lfX0sPC9wPiA8cD5Zb3UgYXJlIGludml0ZWQgdG8gYSBzY3JlZW5pbmcgb24ge3tBcHBvaW50bWVudERhdGV9fSBhdCB7e0FwcG9pbnRtZW50VGltZX19LjwvcD4gPHA+UGxlYXNlIGNvbmZpcm0geW91ciBhdHRlbmRhbmNlIGJ5IHt7Q29uZmlybWF0aW9uRGVhZGxpbmV9fS48L3A+IDxwPlNpbmNlcmVseSw8L3A+IDxwPllvdXIgSGVhbHRoY2FyZSBUZWFtPC9wPg==</code></td><td>2023-08-01 09:35:00+1100</td></tr></table></blockquote><blockquote><p><b>content</b></p><p><b>CMS Template Content Type Extension</b>: parameters</p><h3>Attachments</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ContentType</b></td><td><b>Data</b></td><td><b>Creation</b></td></tr><tr><td style=\"display: none\">*</td><td>application/json</td><td><code>ewogICJ0aXRsZSI6ICJXZWxjb21lIE1lc3NhZ2UgU2NoZW1hIiwKICAidHlwZSI6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIjogewogICAgImZpcnN0TmFtZSI6IHsKICAgICAgInR5cGUiOiAic3RyaW5nIiwKICAgICAgImRlc2NyaXB0aW9uIjogIlRoZSByZWNpcGllbnQncyBmaXJzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IHRydWUKICAgIH0sCiAgICAibGFzdE5hbWUiOiB7CiAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICJUaGUgcmVjaXBpZW50J3MgbGFzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9LAogICAgIndlbGNvbWVNZXNzYWdlIjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZGVzY3JpcHRpb24iOiAiQSBjdXN0b20gd2VsY29tZSBtZXNzYWdlLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9CiAgfSwKICAicmVxdWlyZWQiOiBbImZpcnN0TmFtZSJdCn0=</code></td><td>2023-08-01 09:35:00+1100</td></tr></table></blockquote><blockquote><p><b>content</b></p><p><b>CMS Template Content Type Extension</b>: attachment</p><h3>Attachments</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>ContentType</b></td><td><b>Data</b></td><td><b>Title</b></td><td><b>Creation</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>application/pdf</td><td><code>IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</code></td><td>InstructionSet.pdf</td><td>2023-08-01 09:35:00+1100</td></tr></table></blockquote><h3>Contexts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Related</b></td></tr><tr><td style=\"display: none\">*</td><td>BSA (Identifier: <code>https://hub.services.digital.health.nz/ns/hip-application-id</code>/56789\u00a0(use:\u00a0official,\u00a0))</td></tr></table></div>"
  },
  "status" : "current",
  "docStatus" : "final",
  "category" : [
    {
      "coding" : [
        {
          "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-template-category-codes",
          "code" : "eligible"
        }
      ]
    }
  ],
  "date" : "2024-08-20T14:30:00Z",
  "description" : "Participant is due for first-time screening (i.e. Pathway status has been updated to eligible): This would be triggered by a participant turning 25 (aged in) or having acquired a new NHI #",
  "content" : [
    {
      "extension" : [
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension",
          "valueCode" : "body"
        }
      ],
      "attachment" : {
        "contentType" : "text/html",
        "data" : "PHA+RGVhciB7e1BhdGllbnROYW1lfX0sPC9wPiA8cD5Zb3UgYXJlIGludml0ZWQgdG8gYSBzY3JlZW5pbmcgb24ge3tBcHBvaW50bWVudERhdGV9fSBhdCB7e0FwcG9pbnRtZW50VGltZX19LjwvcD4gPHA+UGxlYXNlIGNvbmZpcm0geW91ciBhdHRlbmRhbmNlIGJ5IHt7Q29uZmlybWF0aW9uRGVhZGxpbmV9fS48L3A+IDxwPlNpbmNlcmVseSw8L3A+IDxwPllvdXIgSGVhbHRoY2FyZSBUZWFtPC9wPg==",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    },
    {
      "extension" : [
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension",
          "valueCode" : "parameters"
        }
      ],
      "attachment" : {
        "contentType" : "application/json",
        "data" : "ewogICJ0aXRsZSI6ICJXZWxjb21lIE1lc3NhZ2UgU2NoZW1hIiwKICAidHlwZSI6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIjogewogICAgImZpcnN0TmFtZSI6IHsKICAgICAgInR5cGUiOiAic3RyaW5nIiwKICAgICAgImRlc2NyaXB0aW9uIjogIlRoZSByZWNpcGllbnQncyBmaXJzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IHRydWUKICAgIH0sCiAgICAibGFzdE5hbWUiOiB7CiAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICJUaGUgcmVjaXBpZW50J3MgbGFzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9LAogICAgIndlbGNvbWVNZXNzYWdlIjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZGVzY3JpcHRpb24iOiAiQSBjdXN0b20gd2VsY29tZSBtZXNzYWdlLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9CiAgfSwKICAicmVxdWlyZWQiOiBbImZpcnN0TmFtZSJdCn0=",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    },
    {
      "extension" : [
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension",
          "valueCode" : "attachment"
        }
      ],
      "attachment" : {
        "extension" : [
          {
            "extension" : [
              {
                "url" : "attachmentDisposition",
                "valueString" : "attachment"
              },
              {
                "url" : "attachmentContentId",
                "valueString" : "logo"
              }
            ],
            "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension"
          }
        ],
        "contentType" : "application/pdf",
        "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
        "title" : "InstructionSet.pdf",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    }
  ],
  "context" : {
    "related" : [
      {
        "type" : "Device",
        "identifier" : {
          "use" : "official",
          "system" : "https://hub.services.digital.health.nz/ns/hip-application-id",
          "value" : "56789"
        },
        "display" : "BSA"
      }
    ]
  }
}