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

• Narrative Content
• XML
• JSON
• TTL

: OutreachCommunicationExample - 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 OutreachCommunicationExample</b></p><a name=\"OutreachCommunicationExample\"> </a><a name=\"hcOutreachCommunicationExample\"> </a><a name=\"OutreachCommunicationExample-en-NZ\"> </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=\"tel:+64221234567\">+64221234567</a></li></ul></blockquote><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=\"ServiceRequest-OutreachServiceRequestExample.html\">ServiceRequest Immunization Outreach</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 PHONE}\">telephone</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>recipient</b>: Carey Carrington (Identifier: NHI/ZXP7823\u00a0(use:\u00a0official,\u00a0))</p><p><b>sender</b>: Whaihua (Identifier: <code>https://hub.services.digital.health.nz/ns/hip-application-id</code>/12345\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>summary of the communication</td></tr></table></div>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "toContactPoint",
          "valueContactPoint" : {
            "system" : "phone",
            "value" : "+64221234567"
          }
        }
      ],
      "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension"
    }
  ],
  "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" : "ServiceRequest/OutreachServiceRequestExample"
    }
  ],
  "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" : "PHONE"
        }
      ]
    }
  ],
  "sent" : "2024-08-20T14:30:00Z",
  "received" : "2024-08-20T14:35:00Z",
  "recipient" : [
    {
      "type" : "Patient",
      "identifier" : {
        "use" : "official",
        "system" : "https://standards.digital.health.nz/ns/nhi-id",
        "value" : "ZXP7823"
      },
      "display" : "Carey Carrington"
    }
  ],
  "sender" : {
    "type" : "Device",
    "identifier" : {
      "use" : "official",
      "system" : "https://hub.services.digital.health.nz/ns/hip-application-id",
      "value" : "12345"
    },
    "display" : "Whaihua"
  },
  "payload" : [
    {
      "contentString" : "summary of the communication"
    }
  ]
}