Communication Request Profile¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-core-communicationrequest |
|---|---|
| Status | draft · 1.33.0 |
| Base | CommunicationRequest (constraint) |
| Source | FSH · 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.
Overview
⚠ FIRST PASS -- do not treat this as a contract. The profile is
#draft.
Overview
The request a client submits to send one message by fax, SMS or email: the recipients and the
address to use for each, the channel and the clinic sending account, and what to send. It is the
input to the message exchange service's $send-message operation, which validates it against this
profile and does not store it; nothing refers back to it. Each send is recorded as an
outbound-delivery Communication, one per
recipient per channel, and that Communication is the record of what was sent, including a failure.
One channel, or fax with email. A fax with an email faxes the one document to the fax recipients and attaches it for the email recipients; the body string goes only in the email.
No SMART on FHIR scope names this type: a request to send a message is not stored, so there is
nothing in the store to reach. A message is sent by posting the request to $send-message, and a
resend by the service's $resend-message operation. The operations' definitions (where they are
served, what they answer) are not in this guide yet; what is settled is the request's shape.
How each fact is carried
| Fact | Element |
|---|---|
| Who asked, and when | the authenticated caller; requester and authoredOn are allowed but not must-support, and the send operation does not read them |
| The patient the message is about | subject (absent for a message about no patient) |
| Status | status is always active: a request is posted to be sent and has no lifecycle of its own |
| Each channel | one medium entry: the HL7 ParticipationMode kind (FAXWRIT, EMAILWRIT, SMSWRIT) and the sending account under nexus-message-integration |
| Each recipient, and the address to use | a contained Organization with name and one telecom per channel; recipient is a local reference to it, with the name as display |
| What to send | payload: for a fax, one version-specific DocumentReference reference; for an SMS, one string; for an email, at most one body string plus one reference per attachment |
| The email's subject | the nexus-communication-email-subject extension |
Recipients are contained
The number or address chosen for a recipient is copied into a contained Organization rather than
read off a stored Practitioner, Organization or Patient, because a stored record's contact details
can change after the send. A bare number carries the number as its name. A message to a
known practitioner or patient is therefore addressed, on the request, to an Organization named for
them. Each Communication copies the address into its delivery-address extension and the name into
recipient.display.
What the profile does not check
Whether a sending account belongs to the clinic, and whether it sends the channel kind it is paired with, are checked by the service that sends the message, not by this profile.
Terminology bindings
| Path | Strength | Value set |
|---|---|---|
CommunicationRequest.medium.coding |
required | Communication Medium Value Set |