This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
This resource is a record of a communication. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The sender and receivers may be patients, practitioners, related persons, organizations, or devices. Communication use cases include:
Non-patient specific communication use cases may include:
This resource is a record of a communication that has occurred. It does not represent the actual flow of communication. While
AuditEvent
can
track
electronic
disclosures
of
information,
it
cannot
track
conversations,
phone
calls,
letters
and
other
interactions
that
are
not
system-to-system.
And
even
for
system-to-system
communications,
the
specific
end
recipients
may
not
be
known.
As
well,
can track electronic disclosures of information, it cannot track conversations, phone calls, letters and other interactions that are not system-to-system. And even for system-to-system communications, the specific end recipients may not be known. As well,
AuditEvents
are
not
considered
to
be
"part"
of
the
patient
record,
while
are not considered to be "part" of the patient record, while
Communication
instances
are.
The
instances are. The
Communication
resource
is
not
used
as
a
general
audit
mechanism
to
track
every
disclosure
of
every
record.
Rather,
it
is
used
when
a
clinician
or
other
user
wants
to
ensure
a
record
of
a
particular
communication
is
itself
maintained
as
part
of
the
reviewable
health
record.
resource is not used as a general audit mechanism to track every disclosure of every record. Rather, it is used when a clinician or other user wants to ensure a record of a particular communication is itself maintained as part of the reviewable health record.
Flag
resources
represent
a
continuous
ongoing
"communication"
alerting
anyone
dealing
with
the
patient
of
certain
precautions
to
take
or
issues
to
be
aware
of.
The
flags
are
continuously
present
as
an
ongoing
reminder.
This
is
distinct
from
resources represent a continuous ongoing "communication" alerting anyone dealing with the patient of certain precautions to take or issues to be aware of. The flags are continuously present as an ongoing reminder. This is distinct from
Communication
where
there
is
a
specific
intended
sender
and
receiver
and
the
information
is
delivered
only
once.
where there is a specific intended sender and receiver and the information is delivered only once.
Communication
and
Encounter
Communication and Encounter
The
Communication
is
about
the
transfer
of
information
(which
may
or
may
not
occur
as
part
of
an
encounter),
while
Encounter
is
about
the
coming
together
(in
person
or
virtually)
of
a
Patient
with
a
Practitioner.
Communication
does
not
deal
with
the
duration
of
a
call,
it
represents
the
fact
that
information
was
transferred
at
a
particular
point
in
time.
The
phone
calls
involving
the
Patient
should
be
handled
using
The Communication is about the transfer of information (which may or may not occur as part of an encounter), while Encounter is about the coming together (in person or virtually) of a Patient with a Practitioner. Communication does not deal with the duration of a call, it represents the fact that information was transferred at a particular point in time.
The phone calls involving the Patient should be handled using
Encounter
.
Phone
calls
not
involving
the
patient
(e.g.
between
practitioners
or
practitioner
to
relative)
that
are
tracked
for
billing
or
other
purposes
can
use
Communication
to
represent
the
information
transferred,
but
are
not
ideal
to
represent
the
call
itself.
A
better
mechanism
for
handling
such
calls
will
be
explored
in
a
future
release.
. Phone calls not involving the patient (e.g. between practitioners or practitioner to relative) that are tracked for billing or other purposes can use Communication to represent the information transferred, but are not ideal to represent the call itself. A better mechanism for handling such calls will be explored in a future release.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 0..* | Identifier |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 |
Reference
(
Device
|
|
|
Σ | 0..* |
Reference
(
Device
|
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 |
|
|
|
string | |||
|
Attachment | |||
|
Reference ( Any ) | |||
|
Σ | 0..* | CodeableConcept |
|
|
|
0..1 | code |
CommunicationStatus |
|
Σ | 0..1 | Reference ( Encounter ) |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..* | CodeableConcept |
|
|
Σ | 0..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | Reference ( CommunicationRequest ) |
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<Communication xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique identifier --></identifier> <category><!-- 0..1 CodeableConcept Message category --></category> <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| RelatedPerson) Message sender --></sender>
<|<recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner| RelatedPerson|Group) Message recipient --></recipient> <payload> <!-- 0..* Message payload --> <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]> </payload><</medium><medium><!-- 0..* CodeableConcept A channel of communication --></medium> <status value="[code]"/><!-- 0..1 in-progress | completed | suspended | rejected | failed --> <encounter><!-- 0..1 Reference(Encounter) Encounter leading to message --></encounter> <sent value="[dateTime]"/><!-- 0..1 When sent --> <received value="[dateTime]"/><!-- 0..1 When received --> <reason><!-- 0..* CodeableConcept Indication for message --></reason> <subject><!-- 0..1 Reference(Patient) Focus of message --></subject> <requestDetail><!-- 0..1 Reference(CommunicationRequest) CommunicationRequest producing this message --></requestDetail> </Communication>
JSON
Template
JSON Template
{
"resourceType" : "Communication",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique identifier
"category" : { CodeableConcept }, // Message category
"sender" : { Reference(Device|Organization|Patient|Practitioner|
RelatedPerson) }, // Message sender
"|
"recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
RelatedPerson|Group) }], // Message recipient
"payload" : [{ // Message payload
// content[x]: Message part content. One of these 3:
"contentString" : "<string>"
"contentAttachment" : { Attachment }
"contentReference" : { Reference(Any) }
}],
"
"medium" : [{ CodeableConcept }], // A channel of communication
"status" : "<code>", // in-progress | completed | suspended | rejected | failed
"encounter" : { Reference(Encounter) }, // Encounter leading to message
"sent" : "<dateTime>", // When sent
"received" : "<dateTime>", // When received
"reason" : [{ CodeableConcept }], // Indication for message
"subject" : { Reference(Patient) }, // Focus of message
"requestDetail" : { Reference(CommunicationRequest) } // CommunicationRequest producing this message
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 0..* | Identifier |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 |
Reference
(
Device
|
|
|
Σ | 0..* |
Reference
(
Device
|
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 |
|
|
|
string | |||
|
Attachment | |||
|
Reference ( Any ) | |||
|
Σ | 0..* | CodeableConcept |
|
|
|
0..1 | code |
CommunicationStatus |
|
Σ | 0..1 | Reference ( Encounter ) |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..* | CodeableConcept |
|
|
Σ | 0..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | Reference ( CommunicationRequest ) |
|
Documentation for this format
|
||||
XML
Template
XML Template
<Communication xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique identifier --></identifier> <category><!-- 0..1 CodeableConcept Message category --></category> <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| RelatedPerson) Message sender --></sender>
<|<recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner| RelatedPerson|Group) Message recipient --></recipient> <payload> <!-- 0..* Message payload --> <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]> </payload><</medium><medium><!-- 0..* CodeableConcept A channel of communication --></medium> <status value="[code]"/><!-- 0..1 in-progress | completed | suspended | rejected | failed --> <encounter><!-- 0..1 Reference(Encounter) Encounter leading to message --></encounter> <sent value="[dateTime]"/><!-- 0..1 When sent --> <received value="[dateTime]"/><!-- 0..1 When received --> <reason><!-- 0..* CodeableConcept Indication for message --></reason> <subject><!-- 0..1 Reference(Patient) Focus of message --></subject> <requestDetail><!-- 0..1 Reference(CommunicationRequest) CommunicationRequest producing this message --></requestDetail> </Communication>
JSON
Template
JSON Template
{
"resourceType" : "Communication",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique identifier
"category" : { CodeableConcept }, // Message category
"sender" : { Reference(Device|Organization|Patient|Practitioner|
RelatedPerson) }, // Message sender
"|
"recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
RelatedPerson|Group) }], // Message recipient
"payload" : [{ // Message payload
// content[x]: Message part content. One of these 3:
"contentString" : "<string>"
"contentAttachment" : { Attachment }
"contentReference" : { Reference(Any) }
}],
"
"medium" : [{ CodeableConcept }], // A channel of communication
"status" : "<code>", // in-progress | completed | suspended | rejected | failed
"encounter" : { Reference(Encounter) }, // Encounter leading to message
"sent" : "<dateTime>", // When sent
"received" : "<dateTime>", // When received
"reason" : [{ CodeableConcept }], // Indication for message
"subject" : { Reference(Patient) }, // Focus of message
"requestDetail" : { Reference(CommunicationRequest) } // CommunicationRequest producing this message
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Unknown |
|
|
|
|
Example |
|
|
|
|
Required | CommunicationStatus |
|
|
|
Unknown |
|
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
Communication.sender and Communication.recipient allow Patient|Practitioner|RelatedPerson - but it is not unusual to have a communication target - even a defined one - where it is unknown what kind of role the person is playing.
If the communication is to or from an individual, whose role is not known (practitioner, patient or related person), - for example, only email address is captured in the system; then RelatedPerson should be used by default.
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| category | token |
|
Communication.category |
| encounter | reference |
|
Communication.encounter
( Encounter ) |
| identifier | token |
|
Communication.identifier |
| medium | token |
|
Communication.medium |
| patient | reference |
|
Communication.subject
( Patient ) |
| received | date |
|
Communication.received |
| recipient | reference |
|
Communication.recipient
( Device |
| request | reference |
|
Communication.requestDetail
( CommunicationRequest ) |
| sender | reference |
|
Communication.sender
( Device |
| sent | date |
|
Communication.sent |
| status | token |
|
Communication.status |
| subject | reference |
|
Communication.subject
( Patient ) |