LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

: Engagement Communication Example - JSON Representation

Raw json | Download


{
  "resourceType" : "Communication",
  "id" : "EngagementCommunicationExample",
  "meta" : {
    "extension" : [
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/tenant-id",
        "valueString" : "99999"
      },
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/ingestion-batch-id",
        "valueString" : "b069a545-9506-40c6-8498-23de2e189143"
      },
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-organization",
        "valueString" : "HDC"
      },
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-type",
        "valueString" : "Engagement Communication"
      },
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-name",
        "valueString" : "ATC"
      },
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-version",
        "valueString" : "1.0"
      },
      {
        "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp",
        "valueDateTime" : "2020-03-01T10:01:00Z"
      }
    ],
    "source" : "http://linuxforhealth.org/platform/engagement",
    "profile" : [
      "http://linuxforhealth.org/fhir/cdm/StructureDefinition/engagement-communication"
    ],
    "tag" : [
      {
        "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification",
        "code" : "derived"
      }
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Communication</b><a name=\"EngagementCommunicationExample\"> </a></p><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\">Resource Communication \"EngagementCommunicationExample\" </p><p style=\"margin-bottom: 0px\">Information Source: http://linuxforhealth.org/platform/engagement!</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-engagement-communication.html\">Engagement Communication</a></p><p style=\"margin-bottom: 0px\">Tag: <span title=\"{http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification}\">http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification</span></p></div><p><b>Communication Contact</b>: 808-248-8689(MOBILE)</p><p><b>Communication Template</b>: dm-template</p><p><b>Communication Payload Data</b>: {shortCode = '888-111'}</p><p><b>Communication Product</b>: Care Gap <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"CodeSystem-eng-product.html\">Engagement Product Codes</a>#care-gap)</span></p><p><b>Conversation Type</b>: Health reminders associated with a gap in care <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"CodeSystem-eng-conversation-type.html\">Engagement Conversation Type Codes</a>#gap-in-care)</span></p><p><b>Communication On-Behalf Of</b>: <a href=\"PractitionerRole-CDMPractitionerRole-Attributed-PCP.html\">PractitionerRole/CDMPractitionerRole-Attributed-PCP</a></p><p><b>Communication Measure</b>: <a href=\"Measure-QualityMeasureExample.html\">Measure/QualityMeasureExample</a> \"Diabetes_HbA1c_Test_Performed\"</p><p><b>Communication Care Gap</b>: dm-hba1c-caregap-poor-control</p><p><b>Communication Priority Sequence</b>: 1</p><blockquote><p><b>Communication Reengagement</b></p><p><b>value</b>: 1</p><p><b>value</b>: 1st reengagement</p></blockquote><p><b>Communication Language</b>: en-US</p><p><b>Communication Retry Limit</b>: 5</p><p><b>Communication Vendor</b>: <a href=\"Organization-CommunicationVendor1.html\">Organization/CommunicationVendor1</a> \"Communication Vendor 1\"</p><p><b>identifier</b>: Derived Resource Identifier: de25d288-120e-47c1-bb76-caac8bc3f439</p><p><b>basedOn</b>: <a href=\"CommunicationRequest-EngagementCommunicationRequestExample.html\">CommunicationRequest/EngagementCommunicationRequestExample</a></p><p><b>status</b>: in-progress</p><p><b>statusReason</b>: In-Process - SMS text queued <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"CodeSystem-eng-communication-status-reason.html\">Engagement Communication Status Reason Codes</a>#sms-queued; <a href=\"CodeSystem-eng-communication-status-reason.html\">Engagement Communication Status Reason Codes</a>#sms-sending \"In-Process - Sending SMS text\")</span></p><p><b>category</b>: Notification <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-communication-category.html\">CommunicationCategory</a>#notification)</span></p><p><b>priority</b>: routine</p><p><b>medium</b>: Sms Text <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"CodeSystem-eng-communication-mode.html\">Engagement Communication Mode Codes</a>#sms)</span></p><p><b>subject</b>: <a href=\"Patient-CDMPatientInstance.html\">Patient/CDMPatientInstance</a> \" MCLASTNAME\"</p><p><b>about</b>: <a href=\"DetectedIssue-CareGapDetectedIssueExample.html\">DetectedIssue/CareGapDetectedIssueExample</a></p><p><b>recipient</b>: <a href=\"Patient-CDMPatientInstance.html\">Patient/CDMPatientInstance</a> \" MCLASTNAME\"</p><p><b>sender</b>: <a href=\"Organization-HDC.html\">Organization/HDC</a> \"HDC\"</p><h3>Payloads</h3><table class=\"grid\"><tr><td>-</td><td><b>Content[x]</b></td></tr><tr><td>*</td><td>Our records indicate you are overdue for a medical appointment.  Please contact [PRACTIIONER-NAME] at [FACILITY-NAME], [FACILTY-PHONE] to schedule an appointment.</td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-contact",
      "valueContactPoint" : {
        "system" : "sms",
        "value" : "808-248-8689",
        "use" : "mobile"
      }
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-template",
      "valueString" : "dm-template"
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-payload-data",
      "valueString" : "{shortCode = '888-111'}"
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product",
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/eng-product",
            "code" : "care-gap"
          }
        ]
      }
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/conversation-type",
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/eng-conversation-type",
            "code" : "gap-in-care"
          }
        ]
      }
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-on-behalf-of",
      "valueReference" : {
        "reference" : "PractitionerRole/CDMPractitionerRole-Attributed-PCP"
      }
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-measure",
      "valueReference" : {
        "reference" : "Measure/QualityMeasureExample"
      }
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap",
      "valueString" : "dm-hba1c-caregap-poor-control"
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-priority-sequence",
      "valueDecimal" : 1
    },
    {
      "extension" : [
        {
          "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/reengagement-value",
          "valueUnsignedInt" : 1
        },
        {
          "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/reengagement-display",
          "valueString" : "1st reengagement"
        }
      ],
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-reengagement"
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-language",
      "valueCode" : "en-US"
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-retry-limt",
      "valueString" : "5"
    },
    {
      "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-vendor",
      "valueReference" : {
        "reference" : "Organization/CommunicationVendor1"
      }
    }
  ],
  "identifier" : [
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type",
            "code" : "DRI"
          }
        ]
      },
      "system" : "http://linuxforhealth.org/platform/engagement-communication",
      "value" : "de25d288-120e-47c1-bb76-caac8bc3f439",
      "assigner" : {
        "display" : "HDC"
      }
    }
  ],
  "basedOn" : [
    {
      "reference" : "CommunicationRequest/EngagementCommunicationRequestExample"
    }
  ],
  "status" : "in-progress",
  "statusReason" : {
    "coding" : [
      {
        "extension" : [
          {
            "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp",
            "valueDateTime" : "2020-03-01T10:01:01Z"
          }
        ],
        "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/eng-communication-status-reason",
        "code" : "sms-queued",
        "display" : "In-Process - SMS text queued"
      },
      {
        "extension" : [
          {
            "url" : "http://linuxforhealth.org/fhir/cdm/StructureDefinition/process-timestamp",
            "valueDateTime" : "2020-03-01T10:02:02Z"
          }
        ],
        "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/eng-communication-status-reason",
        "code" : "sms-sending",
        "display" : "In-Process - Sending SMS text"
      }
    ]
  },
  "category" : [
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/communication-category",
          "code" : "notification"
        }
      ]
    }
  ],
  "priority" : "routine",
  "medium" : [
    {
      "coding" : [
        {
          "system" : "http://linuxforhealth.org/fhir/cdm/CodeSystem/eng-communication-mode",
          "code" : "sms"
        }
      ]
    }
  ],
  "subject" : {
    "reference" : "Patient/CDMPatientInstance"
  },
  "about" : [
    {
      "reference" : "DetectedIssue/CareGapDetectedIssueExample"
    }
  ],
  "recipient" : [
    {
      "reference" : "Patient/CDMPatientInstance"
    }
  ],
  "sender" : {
    "reference" : "Organization/HDC"
  },
  "payload" : [
    {
      "contentString" : "Our records indicate you are overdue for a medical appointment.  Please contact [PRACTIIONER-NAME] at [FACILITY-NAME], [FACILTY-PHONE] to schedule an appointment."
    }
  ]
}