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.

Elements / Snapshot

The full effective definition: base CommunicationRequest with this profile's constraints applied.

Element Flags Card. Type Description & Constraints
CommunicationRequest 0..* Nexus EMR request to send a fax, SMS or email
Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, 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
id 0..1 http://hl7.org/fhirpath/System.String Logical id of this artifact i
meta 0..1 Meta Metadata about the resource
Invariants: ele-1
implicitRules ?! 0..0 uri A set of rules under which this content was created i
Invariants: ele-1
language 0..1 code Language of the resource content i
Binding: languages (preferred)
Invariants: ele-1
text 0..1 Narrative Text summary of the resource, for human interpretation i
Invariants: ele-1
contained S 1..* Organization The recipients: one Organization each, with a name and the address to use i
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
extension:emailSubject S 0..1 Extension(Communication Email Subject Extension) The subject line of the email i
Invariants: ele-1, ext-1
modifierExtension ?! 0..0 Extension Extensions that cannot be ignored i
Invariants: ele-1, ext-1
identifier 0..* Identifier Unique identifier i
Invariants: ele-1
basedOn 0..0 Reference(Resource) Fulfills plan or proposal
Invariants: ele-1
replaces 0..0 Reference(CommunicationRequest) Request(s) replaced by this request i
Invariants: ele-1
groupIdentifier 0..0 Identifier Composite request this is part of i
Invariants: ele-1
status S ?! 1..1 code active i
Binding: request-status (required)
Invariants: ele-1
statusReason 0..0 CodeableConcept Reason for current status i
Invariants: ele-1
category 0..0 CodeableConcept Message category i
Binding: communication-category (example)
Invariants: ele-1
priority 0..0 code routine | urgent | asap | stat
Binding: request-priority (required)
Invariants: ele-1
doNotPerform ?! 0..0 boolean True if request is prohibiting action i
Invariants: ele-1
medium S 1..2 CodeableConcept One entry per channel: the kind (FAXWRIT | EMAILWRIT | SMSWRIT) and the account that sends it i
Binding: v3-ParticipationMode (example)
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
coding 2..* Coding Code defined by a terminology system i
Slicing: value:system (closed)
Invariants: ele-1
coding:kind S 1..1 Coding FAXWRIT | EMAILWRIT | SMSWRIT i
Binding: Communication Medium Value Set (required)
e.g. FAXWRIT · EMAILWRIT · SMSWRIT
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
system 1..1 uri Identity of the terminology system i
Pattern: http://terminology.hl7.org/CodeSystem/v3-ParticipationMode
Invariants: ele-1
version 0..1 string Version of the system - if relevant i
Invariants: ele-1
code 1..1 code Symbol in syntax defined by the system
Invariants: ele-1
display 0..1 string Representation defined by the system
Invariants: ele-1
userSelected 0..1 boolean If this coding was chosen directly by the user i
Invariants: ele-1
coding:integration S 1..1 Coding The clinic sending account that carries this channel i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
system 1..1 uri Identity of the terminology system i
Pattern: https://fhir.apps.health/CodeSystem/nexus-message-integration
Invariants: ele-1
version 0..1 string Version of the system - if relevant i
Invariants: ele-1
code 1..1 code Symbol in syntax defined by the system
Invariants: ele-1
display 0..1 string Representation defined by the system
Invariants: ele-1
userSelected 0..1 boolean If this coding was chosen directly by the user i
Invariants: ele-1
text 0..1 string Plain text representation of the concept i
Invariants: ele-1
subject S 0..1 Reference(Patient Profile) The patient the message is about i
Invariants: ele-1
about 0..0 Reference(Resource) Resources that pertain to this communication request i
Invariants: ele-1
encounter 0..0 Reference(Encounter) Encounter created as part of i
Invariants: ele-1
payload S 1..* BackboneElement What to send i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
content[x] 1..1 string, Reference(DocumentReference) Message part content
Invariants: ele-1
occurrence[x] 0..0 dateTime, Period When scheduled
Invariants: ele-1
authoredOn 0..1 dateTime When the request was made i
Invariants: ele-1
requester 0..1 Reference(Practitioner Profile | PractitionerRole Profile | Device) Who asked for the message to be sent i
Invariants: ele-1
recipient S 1..* Reference(Organization) A local reference to a contained recipient i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
reference 0..1 string Literal reference, Relative, internal or absolute URL i
Invariants: ele-1
type 0..1 uri Type the reference refers to (e.g. "Patient") i
Binding: resource-types (extensible)
Invariants: ele-1
identifier 0..1 Identifier Logical reference, when literal reference is not known i
Invariants: ele-1
display S 1..1 string Text alternative for the resource i
Invariants: ele-1
sender 0..0 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
Invariants: ele-1
reasonCode 0..0 CodeableConcept Why is communication needed? i
Binding: v3-ActReason (example)
Invariants: ele-1
reasonReference 0..0 Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
Invariants: ele-1
note 0..0 Annotation Comments made about communication request
Invariants: ele-1