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

## : EmailCommunicationExample - JSON Representation

Raw json | Download

    {
      "resourceType" : "Communication",
      "meta" : {
        "profile" : [
          🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunication"
        ]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Communication EmailCommunicationExample</b></p><a name=\"EmailCommunicationExample\"> </a><a name=\"hcEmailCommunicationExample\"> </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-CMSCommunication.html\">CMS Communication</a></p></div><blockquote><p><b>Send to and from communication to contact points</b></p><ul><li>toContactPoint: <a href=\"mailto:totest@gmail.com\">totest@gmail.com</a></li><li>fromContactPoint: <a href=\"mailto:fromtest@gmail.com\">fromtest@gmail.com</a></li></ul></blockquote><p><b>Status DateTime</b>: 2024-08-20 14:35:00+0000</p><p><b>identifier</b>: <code>https://api.messaging.digital.health.nz/SourceId</code>/#ebdb8d66-1390-42c7-89a6-a9a75d65d0e6\u00a0(use:\u00a0usual,\u00a0), <code>https://api.messaging.digital.health.nz/CorrelationId</code>/#bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001\u00a0(use:\u00a0secondary,\u00a0), <code>https://api.messaging.digital.health.nz/MessageId</code>/#cb8d66-1390-42c7-89a6-a9a75d65d344\u00a0(use:\u00a0secondary,\u00a0), <code>https://api.messaging.digital.health.nz/ProviderMessageId</code>/#cb8d66-1390-42c7-89a6-a9a75d65d333\u00a0(use:\u00a0secondary,\u00a0), <code>https://api.messaging.digital.health.nz/ConsumerId</code>/#lb8d66-1390-42c7-89a6-a9a75d65d333\u00a0(use:\u00a0secondary,\u00a0)</p><p><b>basedOn</b>: <a href=\"CommunicationRequest-EmailCommunicationRequestWithTemplateExample.html\">CommunicationRequest: extension = ,,https://example.com/callback; identifier = https://api.messaging.digital.health.nz/SourceId##ebdb8d66-1390-42c7-89a6-a9a75d65d0e6\u00a0(use:\u00a0usual,\u00a0),https://api.messaging.digital.health.nz/CorrelationId##bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001\u00a0(use:\u00a0secondary,\u00a0),https://api.messaging.digital.health.nz/MessageId##jb8d66-1390-42c7-89a6-a9a75d65d344\u00a0(use:\u00a0secondary,\u00a0),https://api.messaging.digital.health.nz/ProviderMessageId##kb8d66-1390-42c7-89a6-a9a75d65d333\u00a0(use:\u00a0secondary,\u00a0),https://api.messaging.digital.health.nz/ConsumerId##lb8d66-1390-42c7-89a6-a9a75d65d333\u00a0(use:\u00a0secondary,\u00a0); status = unknown; medium = email; occurrence[x] = 2024-08-20 14:30:00+0000; authoredOn = 2024-08-20 14:30:00+0000</a></p><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-communication-delivery-status-codes sent}\">Sent</span></p><p><b>medium</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes EMAILWRIT}\">email</span></p><p><b>sent</b>: 2024-08-20 14:30:00+0000</p><p><b>received</b>: 2024-08-20 14:35:00+0000</p><p><b>sender</b>: BSA (Identifier: <code>https://hub.services.digital.health.nz/ns/hip-application-id</code>/56789\u00a0(use:\u00a0official,\u00a0))</p><h3>Payloads</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Content[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>text/plain @ https://standards.digital.health.nz/ns/attachment</td></tr></table></div>"
      },
      "extension" : [
        {
          "extension" : [
            {
              "url" : "toContactPoint",
              "valueContactPoint" : {
                "system" : "email",
                "value" : "totest@gmail.com"
              }
            },
            {
              "url" : "fromContactPoint",
              "valueContactPoint" : {
                "system" : "email",
                "value" : "fromtest@gmail.com"
              }
            }
          ],
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension"
        },
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension",
          "valueDateTime" : "2024-08-20T14:35:00Z"
        }
      ],
      "identifier" : [
        {
          "use" : "usual",
          "system" : "https://api.messaging.digital.health.nz/SourceId",
          "value" : "#ebdb8d66-1390-42c7-89a6-a9a75d65d0e6"
        },
        {
          "use" : "secondary",
          "system" : "https://api.messaging.digital.health.nz/CorrelationId",
          "value" : "#bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001"
        },
        {
          "use" : "secondary",
          "system" : "https://api.messaging.digital.health.nz/MessageId",
          "value" : "#cb8d66-1390-42c7-89a6-a9a75d65d344"
        },
        {
          "use" : "secondary",
          "system" : "https://api.messaging.digital.health.nz/ProviderMessageId",
          "value" : "#cb8d66-1390-42c7-89a6-a9a75d65d333"
        },
        {
          "use" : "secondary",
          "system" : "https://api.messaging.digital.health.nz/ConsumerId",
          "value" : "#lb8d66-1390-42c7-89a6-a9a75d65d333"
        }
      ],
      "basedOn" : [
        {
          🔗 "reference" : "CommunicationRequest/EmailCommunicationRequestWithTemplateExample"
        }
      ],
      "status" : "completed",
      "statusReason" : {
        "coding" : [
          {
            "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-communication-delivery-status-codes",
            "code" : "sent"
          }
        ]
      },
      "medium" : [
        {
          "coding" : [
            {
              "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes",
              "code" : "EMAILWRIT"
            }
          ]
        }
      ],
      "sent" : "2024-08-20T14:30:00Z",
      "received" : "2024-08-20T14:35:00Z",
      "sender" : {
        "type" : "Device",
        "identifier" : {
          "use" : "official",
          "system" : "https://hub.services.digital.health.nz/ns/hip-application-id",
          "value" : "56789"
        },
        "display" : "BSA"
      },
      "payload" : [
        {
          "contentAttachment" : {
            "id" : "message-attachment",
            "contentType" : "text/plain",
            "language" : "en-nz",
            "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
            "url" : "https://standards.digital.health.nz/ns/attachment",
            "title" : "Title of Attachment",
            "creation" : "2023-08-01T09:35:00+11:00"
          }
        }
      ]
    }