Skip to content

Communication Profile

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-emr-core-communication
Statusdraft (experimental) · 1.33.0
BaseCommunication (constraint)
SourceFSH · JSON

Nexus EMR profile for Communication, covering three distinct populations: WELL-internal staff chat about a patient, eReferral correspondence passed through from or to external partners, and outbound delivery (one fax, SMS or email sent to one recipient through a delivery service). First pass -- the pass-through boundary and message threading are not yet settled.

Examples

Internal Staff Chat About a Patient · Outbound Fax to a Bare Number (delivered) · Outbound SMS Reminder (failed)

Outbound SMS Reminder (failed)

An appointment reminder texted to the patient that the delivery service accepted and then failed for good -- status not-done, with the service's error code and text in statusReason. A retry would be a new Communication whose basedOn names this one

Communication/comm-outbound-sms-failed — claims conformance to Communication Profile

{
  "resourceType": "Communication",
  "id": "comm-outbound-sms-failed",
  "meta": {
    "profile": [
      "https://fhir.apps.health/StructureDefinition/nexus-emr-core-communication"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>Outbound SMS appointment reminder from Cedarbrook Family Health to Avery Linwood at +1 403 555 0142, sent through the clinic's Clinic SMS account (the integration coding beside SMSWRIT on medium). The recipient is her name, as display only; the number texted is carried in the delivery-address extension. Accepted by RingCentral at 09:00, then failed for good: the carrier reported the handset unreachable. Status not-done, with the delivery service's error code and text in statusReason. A retry would be a new Communication pointing back at this one.</p></div>"
  },
  "extension": [
    {
      "url": "https://fhir.apps.health/StructureDefinition/nexus-communication-delivery-address",
      "valueContactPoint": {
        "system": "sms",
        "value": "+1 403 555 0142"
      }
    }
  ],
  "identifier": [
    {
      "system": "https://fhir.apps.health/NamingSystem/nexus-ringcentral-message-id",
      "value": "1874553920016"
    }
  ],
  "status": "not-done",
  "statusReason": {
    "text": "Delivery service error 30003: destination handset unreachable"
  },
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.apps.health/CodeSystem/nexus-communication-category",
          "code": "outbound-delivery",
          "display": "Outbound delivery"
        }
      ]
    }
  ],
  "medium": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
          "code": "SMSWRIT",
          "display": "SMS message"
        },
        {
          "system": "https://fhir.apps.health/CodeSystem/nexus-message-integration",
          "code": "c41e8d27-9b6a-4f13-8e05-3a7d2f9b6c58",
          "display": "Clinic SMS"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/avery-linwood",
    "display": "Avery Linwood"
  },
  "sent": "2025-04-11T09:00:00-06:00",
  "recipient": [
    {
      "display": "Avery Linwood"
    }
  ],
  "sender": {
    "reference": "Organization/cedarbrook-clinic",
    "display": "Cedarbrook Family Health"
  },
  "payload": [
    {
      "contentString": "Cedarbrook Family Health: reminder of your appointment tomorrow at 10:15. Reply C to confirm or call the clinic to rebook."
    }
  ]
}