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

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"
        ]
      },
      "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\">Record of Template for Email Communication from Any Healthcare System</a></p></div><p><b>masterIdentifier</b>: <code>https://api.messaging.digital.health.nz/MasterTemplateId</code>/REC0\u00a0(use:\u00a0usual,\u00a0)</p><p><b>identifier</b>: <code>https://api.messaging.digital.health.nz/TemplateId</code>/CR1\u00a0(use:\u00a0usual,\u00a0)</p><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><blockquote><p><b>attachment</b></p><blockquote><p><b>id</b></p>template-message-body</blockquote><p><b>contentType</b>: text/html</p><p><b>data</b>: <code>PHA+RGVhciB7e1BhdGllbnROYW1lfX0sPC9wPiA8cD5Zb3UgYXJlIGludml0ZWQgdG8gYSBzY3JlZW5pbmcgb24ge3tBcHBvaW50bWVudERhdGV9fSBhdCB7e0FwcG9pbnRtZW50VGltZX19LjwvcD4gPHA+UGxlYXNlIGNvbmZpcm0geW91ciBhdHRlbmRhbmNlIGJ5IHt7Q29uZmlybWF0aW9uRGVhZGxpbmV9fS48L3A+IDxwPlNpbmNlcmVseSw8L3A+IDxwPllvdXIgSGVhbHRoY2FyZSBUZWFtPC9wPg==</code></p><p><b>creation</b>: 2023-08-01 09:35:00+1100</p></blockquote></blockquote><blockquote><p><b>content</b></p><blockquote><p><b>attachment</b></p><blockquote><p><b>id</b></p>template-message-parameters</blockquote><p><b>contentType</b>: application/json</p><p><b>data</b>: <code>ewogICJ0aXRsZSI6ICJXZWxjb21lIE1lc3NhZ2UgU2NoZW1hIiwKICAidHlwZSI6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIjogewogICAgImZpcnN0TmFtZSI6IHsKICAgICAgInR5cGUiOiAic3RyaW5nIiwKICAgICAgImRlc2NyaXB0aW9uIjogIlRoZSByZWNpcGllbnQncyBmaXJzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IHRydWUKICAgIH0sCiAgICAibGFzdE5hbWUiOiB7CiAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICJUaGUgcmVjaXBpZW50J3MgbGFzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9LAogICAgIndlbGNvbWVNZXNzYWdlIjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZGVzY3JpcHRpb24iOiAiQSBjdXN0b20gd2VsY29tZSBtZXNzYWdlLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9CiAgfSwKICAicmVxdWlyZWQiOiBbImZpcnN0TmFtZSJdCn0=</code></p><p><b>creation</b>: 2023-08-01 09:35:00+1100</p></blockquote></blockquote><blockquote><p><b>content</b></p><blockquote><p><b>attachment</b></p><blockquote><p><b>id</b></p>template-attachment-file1</blockquote><blockquote><p><b>Attachment details</b></p><ul><li>attachmentDisposition: attachment</li><li>attachmentContentId: logo</li></ul></blockquote><p><b>contentType</b>: application/pdf</p><p><b>data</b>: <code>IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</code></p><p><b>title</b>: InstructionSet.pdf</p><p><b>creation</b>: 2023-08-01 09:35:00+1100</p></blockquote></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><a href=\"HealthcareService-BSAService.html\">HealthcareService National Breast Screening Programme</a></td></tr></table></div>"
      },
      "masterIdentifier" : {
        "use" : "usual",
        "system" : "https://api.messaging.digital.health.nz/MasterTemplateId",
        "value" : "REC0"
      },
      "identifier" : [
        {
          "use" : "usual",
          "system" : "https://api.messaging.digital.health.nz/TemplateId",
          "value" : "CR1"
        }
      ],
      "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" : [
        {
          "attachment" : {
            "id" : "template-message-body",
            "contentType" : "text/html",
            "data" : "PHA+RGVhciB7e1BhdGllbnROYW1lfX0sPC9wPiA8cD5Zb3UgYXJlIGludml0ZWQgdG8gYSBzY3JlZW5pbmcgb24ge3tBcHBvaW50bWVudERhdGV9fSBhdCB7e0FwcG9pbnRtZW50VGltZX19LjwvcD4gPHA+UGxlYXNlIGNvbmZpcm0geW91ciBhdHRlbmRhbmNlIGJ5IHt7Q29uZmlybWF0aW9uRGVhZGxpbmV9fS48L3A+IDxwPlNpbmNlcmVseSw8L3A+IDxwPllvdXIgSGVhbHRoY2FyZSBUZWFtPC9wPg==",
            "creation" : "2023-08-01T09:35:00+11:00"
          }
        },
        {
          "attachment" : {
            "id" : "template-message-parameters",
            "contentType" : "application/json",
            "data" : "ewogICJ0aXRsZSI6ICJXZWxjb21lIE1lc3NhZ2UgU2NoZW1hIiwKICAidHlwZSI6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIjogewogICAgImZpcnN0TmFtZSI6IHsKICAgICAgInR5cGUiOiAic3RyaW5nIiwKICAgICAgImRlc2NyaXB0aW9uIjogIlRoZSByZWNpcGllbnQncyBmaXJzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IHRydWUKICAgIH0sCiAgICAibGFzdE5hbWUiOiB7CiAgICAgICJ0eXBlIjogInN0cmluZyIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICJUaGUgcmVjaXBpZW50J3MgbGFzdCBuYW1lLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9LAogICAgIndlbGNvbWVNZXNzYWdlIjogewogICAgICAidHlwZSI6ICJzdHJpbmciLAogICAgICAiZGVzY3JpcHRpb24iOiAiQSBjdXN0b20gd2VsY29tZSBtZXNzYWdlLiIsCiAgICAgICJyZXF1aXJlZCI6IGZhbHNlCiAgICB9CiAgfSwKICAicmVxdWlyZWQiOiBbImZpcnN0TmFtZSJdCn0=",
            "creation" : "2023-08-01T09:35:00+11:00"
          }
        },
        {
          "attachment" : {
            "id" : "template-attachment-file1",
            "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" : [
          {
            🔗 "reference" : "HealthcareService/BSAService"
          }
        ]
      }
    }