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

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

: SMSCommunicationRequestWithoutTemplateExample - JSON Representation

Raw json | Download

{
  "resourceType" : "CommunicationRequest",
  "meta" : {
    "profile" : [
      🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest"
    ],
    "tag" : [
      {
        "system" : "https://hub.services.digital.health.nz/ns/correlation-id",
        "code" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      }
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CommunicationRequest SMSCommunicationRequestWithoutTemplateExample</b></p><a name=\"SMSCommunicationRequestWithoutTemplateExample\"> </a><a name=\"hcSMSCommunicationRequestWithoutTemplateExample\"> </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><p style=\"margin-bottom: 0px\">Tag: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (Details: correlation-id code xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)</p></div><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>Campaign details</b></p><ul><li>campaignCode: 2141acc05fdf4bc79070e472e69b17f6</li><li>campaignName: Measles_HealthCheck_Email_Journey_Sit_24_Feb</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>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><h3>Payloads</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Content[x]</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>text/plain: IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</td></tr></table><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" : "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" : "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" : "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"
    }
  ],
  "status" : "unknown",
  "medium" : [
    {
      "coding" : [
        {
          "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes",
          "code" : "SMSWRIT"
        }
      ]
    }
  ],
  "payload" : [
    {
      "extension" : [
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension",
          "valueCode" : "body"
        }
      ],
      "contentAttachment" : {
        "contentType" : "text/plain",
        "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
        "title" : "Appointment Reminder"
      }
    }
  ],
  "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"
  }
}