Skip to content

Communication Request Profile

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-core-communicationrequest
Statusdraft · 1.33.0
BaseCommunicationRequest (constraint)
SourceFSH · JSON

The request a client submits to send one message by fax, SMS or email: to which recipients, by which channel and sending account, and what to send. It is the input to the message exchange service's $send-message operation, validated against this profile and not stored. Each send is recorded as an outbound-delivery Communication. One channel, or fax with email. Recipients are contained Organizations holding the name and address to use. First pass.

Examples

Request to Fax and Email a Consult Note

One request, two channels -- a consult note faxed to Lakeshore Cardiology and emailed to Northside Physiotherapy. Each recipient is a contained Organization holding its name and the address to use; each medium entry carries the HL7 kind and the clinic sending account; the document is referenced at the version to send, the email has one body string, and its subject rides the email-subject extension. This is what a client posts to the send operation; it is not stored, and each send would be recorded as its own outbound-delivery Communication

CommunicationRequest/commreq-consult-fax-and-email — claims conformance to Communication Request Profile

{
  "resourceType": "CommunicationRequest",
  "id": "commreq-consult-fax-and-email",
  "meta": {
    "profile": [
      "https://fhir.apps.health/StructureDefinition/nexus-core-communicationrequest"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>The request a client posts to the message exchange service's send operation; it is not stored, and each send is recorded as its own outbound-delivery Communication.</p><p>Dr. Emily Carter asks for Avery Linwood's consult note (version 1) to be faxed to Lakeshore Cardiology at 905-555-0142 through the clinic's Main Street fax account, and emailed to Northside Physiotherapy at intake@northside.example through the clinic email account, with the subject 'Consult note: A. Linwood' and a one-line body. The document is faxed to the fax recipient and attached to the email; the body is never faxed.</p></div>"
  },
  "contained": [
    {
      "resourceType": "Organization",
      "id": "r1",
      "name": "Lakeshore Cardiology",
      "telecom": [
        {
          "system": "fax",
          "value": "905-555-0142"
        }
      ]
    },
    {
      "resourceType": "Organization",
      "id": "r2",
      "name": "Northside Physiotherapy",
      "telecom": [
        {
          "system": "email",
          "value": "intake@northside.example"
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "https://fhir.apps.health/StructureDefinition/nexus-communication-email-subject",
      "valueString": "Consult note: A. Linwood"
    }
  ],
  "status": "active",
  "subject": {
    "reference": "Patient/avery-linwood",
    "display": "Avery Linwood"
  },
  "medium": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
          "code": "FAXWRIT",
          "display": "telefax"
        },
        {
          "system": "https://fhir.apps.health/CodeSystem/nexus-message-integration",
          "code": "7f3c2a90-51d4-4e0b-9a1e-2c5d8b6f0a11",
          "display": "Main Street fax"
        }
      ]
    },
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
          "code": "EMAILWRIT",
          "display": "email"
        },
        {
          "system": "https://fhir.apps.health/CodeSystem/nexus-message-integration",
          "code": "b21e9c44-0f6a-47d2-8e33-91aa7c5e2d08",
          "display": "Clinic email"
        }
      ]
    }
  ],
  "recipient": [
    {
      "reference": "#r1",
      "display": "Lakeshore Cardiology"
    },
    {
      "reference": "#r2",
      "display": "Northside Physiotherapy"
    }
  ],
  "payload": [
    {
      "contentReference": {
        "reference": "DocumentReference/anemia-consult-20250408/_history/1",
        "display": "Consult note, Avery Linwood, 2025-04-08"
      }
    },
    {
      "contentString": "Please find the consult note attached."
    }
  ],
  "authoredOn": "2025-04-10T09:58:00-06:00",
  "requester": {
    "reference": "Practitioner/dr-emily-carter",
    "display": "Dr. Emily Carter"
  }
}