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

## : SMSCommunicationRequestWithTemplateExample - XML Representation

Raw xml | Download

    <CommunicationRequest xmlns="http://hl7.org/fhir">
      <meta>
        <profile
                 value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest"/>
      </meta>
      <text>
        <status value="extensions"/>
        <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 (use: usual, ), <code>https://api.messaging.digital.health.nz/CorrelationId</code>/#bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001 (use: secondary, ), <code>https://api.messaging.digital.health.nz/MessageId</code>/#cb8d66-1390-42c7-89a6-a9a75d65d344 (use: secondary, ), <code>https://api.messaging.digital.health.nz/ProviderMessageId</code>/#cb8d66-1390-42c7-89a6-a9a75d65d333 (use: secondary, ), <code>https://api.messaging.digital.health.nz/ConsumerId</code>/#lb8d66-1390-42c7-89a6-a9a75d65d333 (use: secondary, )</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 (use: official, ))</p></div>
      </text>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension">
        <extension url="campaignCode">
          <valueString value="2141acc05fdf4bc79070e472e69b17f6"/>
        </extension>
        <extension url="campaignName">
          <valueString value="Measles_HealthCheck_Email_Journey_Sit_24_Feb"/>
        </extension>
      </extension>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension">
        <extension url="toContactPoint">
          <valueContactPoint>
            <system value="sms"/>
            <value value="0221234567"/>
          </valueContactPoint>
        </extension>
        <extension url="fromContactPoint">
          <valueContactPoint>
            <system value="sms"/>
            <value value="1234"/>
          </valueContactPoint>
        </extension>
      </extension>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension">
        <extension url="replyUrl">
          <valueUrl value="https://example.com/webhook"/>
        </extension>
        <extension url="replyBoolean">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <extension
                 url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension">
        <valueUrl value="https://example.com/callback"/>
      </extension>
      <identifier>
        <use value="usual"/>
        <system value="https://api.messaging.digital.health.nz/SourceId"/>
        <value value="#ebdb8d66-1390-42c7-89a6-a9a75d65d0e6"/>
      </identifier>
      <identifier>
        <use value="secondary"/>
        <system value="https://api.messaging.digital.health.nz/CorrelationId"/>
        <value value="#bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001"/>
      </identifier>
      <identifier>
        <use value="secondary"/>
        <system value="https://api.messaging.digital.health.nz/MessageId"/>
        <value value="#cb8d66-1390-42c7-89a6-a9a75d65d344"/>
      </identifier>
      <identifier>
        <use value="secondary"/>
        <system
                value="https://api.messaging.digital.health.nz/ProviderMessageId"/>
        <value value="#cb8d66-1390-42c7-89a6-a9a75d65d333"/>
      </identifier>
      <identifier>
        <use value="secondary"/>
        <system value="https://api.messaging.digital.health.nz/ConsumerId"/>
        <value value="#lb8d66-1390-42c7-89a6-a9a75d65d333"/>
      </identifier>
      <status value="unknown"/>
      <medium>
        <coding>
          <system
                  value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes"/>
          <code value="SMSWRIT"/>
        </coding>
      </medium>
      <payload>
        <contentReference id="message-template">🔗
          <reference value="DocumentReference/EmailCommunicationTemplateExample"/>
          <display value="Vaccination Appointment Reminder"/>
        </contentReference>
      </payload>
      <payload>
        <contentAttachment id="message-parameters">
          <contentType value="application/json"/>
          <data
                value="eyAiUGF0aWVudE5hbWUiOiAiSm9obiBEb2UiLCAiQXBwb2ludG1lbnREYXRlIjogIjIwMjQtMTItMTMiLCAiQXBwb2ludG1lbnRUaW1lIjogIjEwOjAwIEFNIiwgIkNvbmZpcm1hdGlvbkRlYWRsaW5lIjogIjIwMjQtMTItMTAiIH0="/>
          <creation value="2023-08-01T09:35:00+11:00"/>
        </contentAttachment>
      </payload>
      <authoredOn value="2024-08-20T14:30:00Z"/>
      <sender>
        <type value="Device"/>
        <identifier>
          <use value="official"/>
          <system
                  value="https://hub.services.digital.health.nz/ns/hip-application-id"/>
          <value value="56789"/>
        </identifier>
        <display value="BSA"/>
      </sender>
    </CommunicationRequest>