Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release
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
{
"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 EmailCommunicationExample</b></p><a name=\"EmailCommunicationExample\"> </a><a name=\"hcEmailCommunicationExample\"> </a><a name=\"EmailCommunicationExample-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>/#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)</p><p><b>basedOn</b>: <a href=\"CommunicationRequest-EmailCommunicationRequestWithTemplateExample.html\">CommunicationRequest: extension = 2141acc05fdf4bc79070e472e69b17f6,Measles_HealthCheck_Email_Journey_Sit_24_Feb,test@gmail.com; identifier = https://api.messaging.digital.health.nz/ConsumerRecordId##ebdb8d66-1390-42c7-89a6-a9a75d65d0e6\u00a0(use:\u00a0usual,\u00a0),https://api.messaging.digital.health.nz/CorrelationID##bdb8d66-1390-42c7-89a6-a9a75d65d0e6-001\u00a0(use:\u00a0secondary,\u00a0),https://api.messaging.digital.health.nz/MessageID##jb8d66-1390-42c7-89a6-a9a75d65d344\u00a0(use:\u00a0secondary,\u00a0),https://api.messaging.digital.health.nz/ProviderMessageID##kb8d66-1390-42c7-89a6-a9a75d65d333\u00a0(use:\u00a0secondary,\u00a0),https://api.messaging.digital.health.nz/ConsumerID##lb8d66-1390-42c7-89a6-a9a75d65d333\u00a0(use:\u00a0secondary,\u00a0); status = unknown; medium = mail; occurrence[x] = 2024-08-20 14:30:00+0000; authoredOn = 2024-08-20 14:30:00+0000</a></p><p><b>status</b>: Preparation</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:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes EMAILWRIT}\">email</span></p><p><b>subject</b>: Carey Carrington (Identifier: NHI/ZXP7823\u00a0(use:\u00a0official,\u00a0))</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\u00a0(use:\u00a0official,\u00a0)</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/plain @ https://standards.digital.health.nz/ns/attachment</td></tr></table></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" : "#cb8d66-1390-42c7-89a6-a9a75d65d344"
},
{
"use" : "secondary",
"system" : "https://api.messaging.digital.health.nz/ProviderMessageID",
"value" : "#cb8d66-1390-42c7-89a6-a9a75d65d333"
}
],
"basedOn" : [
{
🔗 "reference" : "CommunicationRequest/EmailCommunicationRequestWithTemplateExample"
}
],
"status" : "preparation",
"statusReason" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-communication-delivery-status-codes",
"code" : "sent"
}
]
},
"category" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/communication-category",
"code" : "notification"
}
]
}
],
"medium" : [
{
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-participation-mode-codes",
"code" : "EMAILWRIT"
}
]
}
],
"subject" : {
"type" : "Patient",
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZXP7823"
},
"display" : "Carey Carrington"
},
"sent" : "2024-08-20T14:30:00Z",
"received" : "2024-08-20T14:35:00Z",
"recipient" : [
{
"type" : "Practitioner",
"identifier" : {
"use" : "official",
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZFX"
}
}
],
"sender" : {
🔗 "reference" : "HealthcareService/BSAService"
},
"payload" : [
{
"contentAttachment" : {
"id" : "message-attachment",
"contentType" : "text/plain",
"language" : "en-nz",
"data" : "IyBQYXRpZW50IEVuY291bnRlciBOb3RlcwoKIyMgMjAyMy0wOC0wMgoKLSBEaXNjdXNzZWQgY29uZGl0aW9uCi0gT3RhaW5lZCBjb25zZW50IAotIGV0Yy4=",
"url" : "https://standards.digital.health.nz/ns/attachment",
"title" : "Title of Attachment",
"creation" : "2023-08-01T09:35:00+11:00"
}
}
]
}