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

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

: SMSCommunicationExample - XML Representation

Raw xml | Download


<Communication xmlns="http://hl7.org/fhir">
  <meta>
    <profile
             value="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunication"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Communication SMSCommunicationExample</b></p><a name="SMSCommunicationExample"> </a><a name="hcSMSCommunicationExample"> </a><a name="SMSCommunicationExample-en-NZ"> </a><p><b>Campaign Code Extension</b>: 2141acc05fdf4bc79070e472e69b17f6</p><p><b>Campaign Name Extension</b>: Measles_HealthCheck_Email_Journey_Sit_24_Feb</p><p><b>Communication details at paticular time</b>: 555-1234</p><p><b>identifier</b>: <code>https://api.messaging.digital.health.nz/ConsumerRecordId</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>basedOn</b>: <a href="CommunicationRequest-SMSCommunicationRequestExample.html">CommunicationRequest: extension = 2141acc05fdf4bc79070e472e69b17f6,Measles_HealthCheck_Email_Journey_Sit_24_Feb,555-1234; identifier = https://api.messaging.digital.health.nz/ConsumerRecordId##ebdb8d66-1390-42c7-89a6-a9a75d65d0e6 (use: usual, ),https://api.messaging.digital.health.nz/CorrelationID##bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001 (use: secondary, ),https://api.messaging.digital.health.nz/MessageID##cb8d66-1390-42c7-89a6-a9a75d65d344 (use: secondary, ),https://api.messaging.digital.health.nz/ProviderMessageID##cb8d66-1390-42c7-89a6-a9a75d65d333 (use: secondary, ),https://api.messaging.digital.health.nz/ConsumerID##lb8d66-1390-42c7-89a6-a9a75d65d333 (use: secondary, ); status = unknown; medium = SMS message; authoredOn = 2024-08-20 14:30:00+0000</a></p><p><b>status</b>: Unknown</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>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/communication-category notification}">Notification</span></p><p><b>medium</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ParticipationMode SMSWRIT}">SMS message</span></p><p><b>subject</b>: Carey Carrington (Identifier: NHI/ZXP7823 (use: official, ))</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>recipient</b>: Identifier: HPIProvider/99ZZFX (use: official, )</p><p><b>sender</b>: <a href="HealthcareService-BSAService.html">HealthcareService National Breast Screening Programme</a></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/markdown: IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</td></tr></table></div>
  </text>
  <extension
             url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-code-extension">
    <valueString value="2141acc05fdf4bc79070e472e69b17f6"/>
  </extension>
  <extension
             url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-name-extension">
    <valueString value="Measles_HealthCheck_Email_Journey_Sit_24_Feb"/>
  </extension>
  <extension
             url="https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension">
    <valueContactPoint>
      <system value="sms"/>
      <value value="555-1234"/>
    </valueContactPoint>
  </extension>
  <identifier>
    <use value="usual"/>
    <system value="https://api.messaging.digital.health.nz/ConsumerRecordId"/>
    <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>
  <basedOn>🔗 
    <reference value="CommunicationRequest/SMSCommunicationRequestExample"/>
  </basedOn>
  <status value="unknown"/>
  <statusReason>
    <coding>
      <system
              value="https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-communication-delivery-status-codes"/>
      <code value="sent"/>
    </coding>
  </statusReason>
  <category>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/communication-category"/>
      <code value="notification"/>
    </coding>
  </category>
  <medium>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/v3-ParticipationMode"/>
      <code value="SMSWRIT"/>
    </coding>
  </medium>
  <subject>
    <type value="Patient"/>
    <identifier>
      <use value="official"/>
      <system value="https://standards.digital.health.nz/ns/nhi-id"/>
      <value value="ZXP7823"/>
    </identifier>
    <display value="Carey Carrington"/>
  </subject>
  <sent value="2024-08-20T14:30:00Z"/>
  <received value="2024-08-20T14:35:00Z"/>
  <recipient>
    <type value="Practitioner"/>
    <identifier>
      <use value="official"/>
      <system value="https://standards.digital.health.nz/ns/hpi-person-id"/>
      <value value="99ZZFX"/>
    </identifier>
  </recipient>
  <sender>🔗 
    <reference value="HealthcareService/BSAService"/>
  </sender>
  <payload>
    <contentAttachment>
      <contentType value="text/markdown"/>
      <language value="en-nz"/>
      <data
            value="IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4="/>
      <title value="Payload"/>
      <creation value="2023-08-01T09:35:00+11:00"/>
    </contentAttachment>
  </payload>
</Communication>