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

• Narrative Content
• XML
• JSON
• TTL

: EmailCommunicationRequestExample - 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 EmailCommunicationRequestExample</b></p><a name=\"EmailCommunicationRequestExample\"> </a><a name=\"hcEmailCommunicationRequestExample\"> </a><a name=\"EmailCommunicationRequestExample-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>: <a href=\"mailto:test@gmail.com\">test@gmail.com</a></p><p><b>identifier</b>: <code>https://api.messaging.digital.health.nz/ConsumerRecordId</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>/#jb8d66-1390-42c7-89a6-a9a75d65d344\u00a0(use:\u00a0secondary,\u00a0), <code>https://api.messaging.digital.health.nz/ProviderMessageID</code>/#kb8d66-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:{http://terminology.hl7.org/CodeSystem/v3-ParticipationMode MAILWRIT}\">mail</span></p><p><b>subject</b>: Carey Carrington (Identifier: NHI/ZXP7823\u00a0(use:\u00a0official,\u00a0))</p><blockquote><p><b>payload</b></p><p><b>content</b>: application/pdf: IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</p></blockquote><blockquote><p><b>payload</b></p><p><b>content</b>: application/pdf: IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</p></blockquote><blockquote><p><b>payload</b></p><p><b>content</b>: application/pdf: IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</p></blockquote><blockquote><p><b>payload</b></p><p><b>content</b>: application/pdf: IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=</p></blockquote><blockquote><p><b>payload</b></p><p><b>content</b>: Subject : Appointment Reminder</p></blockquote><p><b>occurrence</b>: 2024-08-20 14:30:00+0000</p><p><b>authoredOn</b>: 2024-08-20 14:30:00+0000</p><p><b>recipient</b>: Identifier: HPIProvider/99ZZFX\u00a0(use:\u00a0official,\u00a0)</p><p><b>sender</b>: <a href=\"HealthcareService-BSAService.html\">HealthcareService National Breast Screening Programme</a></p></div>"
  },
  "extension" : [
    {
      "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-code-extension",
      "valueString" : "2141acc05fdf4bc79070e472e69b17f6"
    },
    {
      "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-name-extension",
      "valueString" : "Measles_HealthCheck_Email_Journey_Sit_24_Feb"
    },
    {
      "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension",
      "valueContactPoint" : {
        "system" : "email",
        "value" : "test@gmail.com"
      }
    }
  ],
  "identifier" : [
    {
      "use" : "usual",
      "system" : "https://api.messaging.digital.health.nz/ConsumerRecordId",
      "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" : "#jb8d66-1390-42c7-89a6-a9a75d65d344"
    },
    {
      "use" : "secondary",
      "system" : "https://api.messaging.digital.health.nz/ProviderMessageID",
      "value" : "#kb8d66-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" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
          "code" : "MAILWRIT"
        }
      ]
    }
  ],
  "subject" : {
    "identifier" : {
      "use" : "official",
      "system" : "https://standards.digital.health.nz/ns/nhi-id",
      "value" : "ZXP7823"
    },
    "display" : "Carey Carrington"
  },
  "payload" : [
    {
      "contentAttachment" : {
        "contentType" : "application/pdf",
        "language" : "en-nz",
        "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
        "title" : "body",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    },
    {
      "contentAttachment" : {
        "contentType" : "application/pdf",
        "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
        "title" : "File1.pdf",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    },
    {
      "contentAttachment" : {
        "contentType" : "application/pdf",
        "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
        "title" : "File2.pdf",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    },
    {
      "contentAttachment" : {
        "contentType" : "application/pdf",
        "language" : "en-nz",
        "data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
        "title" : "Template",
        "creation" : "2023-08-01T09:35:00+11:00"
      }
    },
    {
      "contentReference" : {
        "display" : "Subject : Appointment Reminder"
      }
    }
  ],
  "occurrenceDateTime" : "2024-08-20T14:30:00Z",
  "authoredOn" : "2024-08-20T14:30:00Z",
  "recipient" : [
    {
      "type" : "Practitioner",
      "identifier" : {
        "use" : "official",
        "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
        "value" : "99ZZFX"
      }
    }
  ],
  "sender" : {
    🔗 "reference" : "HealthcareService/BSAService"
  }
}