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

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

## : SMSCommunicationRequestWithTemplateExample - JSON Representation

Raw json | Download

    {
      "resourceType" : "CommunicationRequest",
      "meta" : {
        "profile" : [
          🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest"
        ]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CommunicationRequest SMSCommunicationRequestWithTemplateExample</b></p><a name=\"SMSCommunicationRequestWithTemplateExample\"> </a><a name=\"hcSMSCommunicationRequestWithTemplateExample\"> </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-CMSCommunicationRequest.html\">CMS Communication Request</a></p></div><blockquote><p><b>Campaign details</b></p><ul><li>campaignCode: 2141acc05fdf4bc79070e472e69b17f6</li><li>campaignName: Measles_HealthCheck_Email_Journey_Sit_24_Feb</li></ul></blockquote><blockquote><p><b>Send to and from communication to contact points</b></p><ul><li>toContactPoint: 0221234567</li><li>fromContactPoint: 1234</li></ul></blockquote><blockquote><p><b>For sms reply</b></p><ul><li>replyUrl: <a href=\"https://example.com/webhook\">https://example.com/webhook</a></li><li>replyBoolean: true</li></ul></blockquote><p><b>Callback Url</b>: <a href=\"https://example.com/callback\">https://example.com/callback</a></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>status</b>: Unknown</p><p><b>medium</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes SMSWRIT}\">SMS message</span></p><blockquote><p><b>payload</b></p><p><b>content</b>: <a href=\"DocumentReference-EmailCommunicationTemplateExample.html\">Vaccination Appointment Reminder</a></p></blockquote><blockquote><p><b>payload</b></p><p><b>content</b>: application/json: eyAiUGF0aWVudE5hbWUiOiAiSm9obiBEb2UiLCAiQXBwb2ludG1lbnREYXRlIjogIjIwMjQtMTItMTMiLCAiQXBwb2ludG1lbnRUaW1lIjogIjEwOjAwIEFNIiwgIkNvbmZpcm1hdGlvbkRlYWRsaW5lIjogIjIwMjQtMTItMTAiIH0=</p></blockquote><p><b>authoredOn</b>: 2024-08-20 14:30: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></div>"
      },
      "extension" : [
        {
          "extension" : [
            {
              "url" : "campaignCode",
              "valueString" : "2141acc05fdf4bc79070e472e69b17f6"
            },
            {
              "url" : "campaignName",
              "valueString" : "Measles_HealthCheck_Email_Journey_Sit_24_Feb"
            }
          ],
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension"
        },
        {
          "extension" : [
            {
              "url" : "toContactPoint",
              "valueContactPoint" : {
                "system" : "sms",
                "value" : "0221234567"
              }
            },
            {
              "url" : "fromContactPoint",
              "valueContactPoint" : {
                "system" : "sms",
                "value" : "1234"
              }
            }
          ],
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension"
        },
        {
          "extension" : [
            {
              "url" : "replyUrl",
              "valueUrl" : "https://example.com/webhook"
            },
            {
              "url" : "replyBoolean",
              "valueBoolean" : true
            }
          ],
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension"
        },
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension",
          "valueUrl" : "https://example.com/callback"
        }
      ],
      "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"
        }
      ],
      "status" : "unknown",
      "medium" : [
        {
          "coding" : [
            {
              "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes",
              "code" : "SMSWRIT"
            }
          ]
        }
      ],
      "payload" : [
        {
          "contentReference" : {
            🔗 "id" : "message-template",
            "reference" : "DocumentReference/EmailCommunicationTemplateExample",
            "display" : "Vaccination Appointment Reminder"
          }
        },
        {
          "contentAttachment" : {
            "id" : "message-parameters",
            "contentType" : "application/json",
            "data" : "eyAiUGF0aWVudE5hbWUiOiAiSm9obiBEb2UiLCAiQXBwb2ludG1lbnREYXRlIjogIjIwMjQtMTItMTMiLCAiQXBwb2ludG1lbnRUaW1lIjogIjEwOjAwIEFNIiwgIkNvbmZpcm1hdGlvbkRlYWRsaW5lIjogIjIwMjQtMTItMTAiIH0=",
            "creation" : "2023-08-01T09:35:00+11:00"
          }
        }
      ],
      "authoredOn" : "2024-08-20T14:30:00Z",
      "sender" : {
        "type" : "Device",
        "identifier" : {
          "use" : "official",
          "system" : "https://hub.services.digital.health.nz/ns/hip-application-id",
          "value" : "56789"
        },
        "display" : "BSA"
      }
    }