Communication Request Profile
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.
Elements / Differential
Overview Elements Invariants Examples FSH Salient fields Access
Differential Key elements Snapshot Details
What this profile constrains beyond CommunicationRequest. Anything not listed is unchanged from the base; muted type/cardinality values are the base's, shown for context.
Element
Flags
Card.
Type
Description & Constraints
CommunicationRequest
Nexus EMR request to send a fax, SMS or email Invariants: nexus-note-extension-not-where-native , nexus-commreq-status , nexus-commreq-channels , nexus-commreq-recipient-contained , nexus-commreq-recipient-named , nexus-commreq-address-matches-medium , nexus-commreq-one-address-per-channel , nexus-commreq-channel-has-addressee , nexus-commreq-email-subject , nexus-commreq-fax-document , nexus-commreq-email-body , nexus-commreq-sms-text
implicitRules
0..0
uri
i
contained
S
1..*
Organization
The recipients: one Organization each, with a name and the address to use i
extension
0..*
Extension
i Slicing: value:url (open)
extension:emailSubject
S
0..1
Extension(Communication Email Subject Extension )
The subject line of the email i
modifierExtension
0..0
Extension
i
basedOn
0..0
Reference(Resource )
replaces
0..0
Reference(CommunicationRequest )
i
groupIdentifier
0..0
Identifier
i
status
S
1..1
code
active i
statusReason
0..0
CodeableConcept
i
category
0..0
CodeableConcept
i
priority
0..0
code
doNotPerform
0..0
boolean
i
medium
S
1..2
CodeableConcept
One entry per channel: the kind (FAXWRIT | EMAILWRIT | SMSWRIT) and the account that sends it i
coding
2..*
Coding
i Slicing: value:system (closed)
coding:kind
S
1..1
Coding
FAXWRIT | EMAILWRIT | SMSWRIT i Binding: Communication Medium Value Set (required)e.g. FAXWRIT · EMAILWRIT · SMSWRIT
system
1..1
uri
i Pattern: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode
code
1..1
code
coding:integration
S
1..1
Coding
The clinic sending account that carries this channel i
system
1..1
uri
i Pattern: https://fhir.apps.health/CodeSystem/nexus-message-integration
code
1..1
code
subject
S
0..1
Reference(Patient Profile )
The patient the message is about i
about
0..0
Reference(Resource )
i
encounter
0..0
Reference(Encounter )
i
payload
S
1..*
BackboneElement
What to send i
content[x]
1..1
string, Reference(DocumentReference )
occurrence[x]
0..0
dateTime, Period
authoredOn
0..1
dateTime
When the request was made i
requester
0..1
Reference(Practitioner Profile | PractitionerRole Profile | Device )
Who asked for the message to be sent i
recipient
S
1..*
Reference(Organization )
A local reference to a contained recipient i
display
S
1..1
string
i
sender
0..0
Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService )
reasonCode
0..0
CodeableConcept
i
reasonReference
0..0
Reference(Condition | Observation | DiagnosticReport | DocumentReference )
note
0..0
Annotation