STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.20 Resource Communication - Content

Patient Care Work Group Maturity Level : 1 Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson

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.

8.20.1 Scope and Usage

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:

  • A reminder or alert delivered to a responsible provider
  • A recorded notification from the nurse that a patient's temperature exceeds a value
  • A notification to a public health agency of a patient presenting with a communicable disease reportable to the public health agency
  • Patient educational material sent by a provider to a patient

Non-patient specific communication use cases may include:

  • A nurse call from a hall bathroom
  • Advisory for battery service from a pump

8.20.2 Boundaries and Relationships

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, AuditEvents are not considered to be "part" of the patient record, while Communication 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.

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 Communication where there is a specific intended sender and receiver and the information is delivered only once.

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 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.

PLANNED CHANGE:

Communication is one of the Event resources in the FHIR Workflow specification. As such, it is expected to be adjusted to align with the Event workflow pattern which will involve adding a number of additional data elements and potentially renaming a few elements. Any concerns about performing such alignment are welcome as ballot comments and/or tracker items.

8.20.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . Communication Σ DomainResource A record of information transmitted from a sender to a receiver
. . . identifier Σ 0..* Identifier Unique identifier
. . . basedOn Σ 0..* Reference ( Any ) Request fulfilled by this communication
. . . parent Σ 0..* Reference ( Any ) Part of this action
. . . status ?! Σ 0..1 code in-progress | completed | suspended | rejected | failed
CommunicationStatus ( Required )
. . . category Σ 0..1 CodeableConcept Message category
. . . medium Σ 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode ( Example )
. . . subject Σ 0..1 Reference ( Patient | Group ) Focus of message
. . . topic Σ 0..* Reference ( Any ) Focal resources
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or episode leading to message
. . . sent Σ 0..1 dateTime When sent
. . . received Σ 0..1 dateTime When received
. . . sender Σ 0..1 Reference ( Device | Organization | Patient | Practitioner | RelatedPerson ) Message sender
. . . recipient Σ 0..* Reference ( Device | Organization | Patient | Practitioner | RelatedPerson | Group ) Message recipient
. . . reason Σ 0..* CodeableConcept Indication for message
v3 Code System ActReason ( Example )
. . . payload Σ 0..* BackboneElement Message payload
. . . . content[x] Σ 1..1 Message part content
. . . . . contentString string
. . . . . contentAttachment Attachment
. . . . . contentReference Reference ( Any )
. . . note Σ 0..* Annotation Comments made about the communication

doco Documentation for this format

UML Diagram ( Legend )

Communication ( DomainResource ) Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation) identifier : Identifier [0..*] An order, proposal or plan fulfilled in whole or in part by this Communication basedOn : Reference [0..*] « Any » Part of this action parent : Reference [0..*] « Any » The status of the transmission (this element modifies the meaning of other elements) status : code [0..1] « The status of the communication. (Strength=Required) CommunicationStatus ! » The type of message conveyed such as alert, notification, reminder, instruction, etc category : CodeableConcept [0..1] A channel that was used for this communication (e.g. email, fax) medium : CodeableConcept [0..*] « Codes for communication mediums such as phone, fax, email, in person, etc. (Strength=Example) v3 Code System ParticipationM... ?? » The patient who was the focus of this communication subject : Reference [0..1] « Patient | Group » The resources which were responsible for or related to producing this communication topic : Reference [0..*] « Any » The encounter within which the communication was sent context : Reference [0..1] « Encounter | EpisodeOfCare » The time when this communication was sent sent : dateTime [0..1] The time when this communication arrived at the destination received : dateTime [0..1] The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication sender : Reference [0..1] « Device | Organization | Patient | Practitioner | RelatedPerson » The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time) recipient : Reference [0..*] « Device | Organization | Patient | Practitioner | RelatedPerson | Group » The reason or justification for the communication reason : CodeableConcept [0..*] « Codes for describing reasons for the occurrence of a communication. (Strength=Example) v3 Code System ActReason ?? » Additional notes or commentary about the communication by the sender, receiver or other interested parties note : Annotation [0..*] Payload A communicated content (or for multi-part communications, one portion of the communication) content[x] : Type [1..1] « string | Attachment | Reference ( Any ) » Text, attachment(s), or resource(s) that was communicated to the recipient payload [0..*]

XML Template 

<Communication xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <basedOn><!-- 0..* Reference(Any) Request fulfilled by this communication --></basedOn>
 <parent><!-- 0..* Reference(Any) Part of this action --></parent>
 <status value="[code]"/><!-- 0..1 in-progress | completed | suspended | rejected | failed -->
 <category><!-- 0..1 CodeableConcept Message category --></category>
 <medium><!-- 0..* CodeableConcept A channel of communication --></medium>
 <subject><!-- 0..1 Reference(Patient|Group) Focus of message --></subject>
 <topic><!-- 0..* Reference(Any) Focal resources --></topic>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or episode leading to message --></context>
 <sent value="[dateTime]"/><!-- 0..1 When sent -->
 <received value="[dateTime]"/><!-- 0..1 When received -->
 <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) Message sender --></sender>
 <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson|Group) Message recipient --></recipient>
 <reason><!-- 0..* CodeableConcept Indication for message --></reason>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]>
 </payload>
 <note><!-- 0..* Annotation Comments made about the communication --></note>
</Communication>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Communication;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Communication.identifier [ Identifier ], ... ; # 0..* Unique identifier
  fhir:Communication.basedOn [ Reference(Any) ], ... ; # 0..* Request fulfilled by this communication
  fhir:Communication.parent [ Reference(Any) ], ... ; # 0..* Part of this action
  fhir:Communication.status [ code ]; # 0..1 in-progress | completed | suspended | rejected | failed
  fhir:Communication.category [ CodeableConcept ]; # 0..1 Message category
  fhir:Communication.medium [ CodeableConcept ], ... ; # 0..* A channel of communication
  fhir:Communication.subject [ Reference(Patient|Group) ]; # 0..1 Focus of message
  fhir:Communication.topic [ Reference(Any) ], ... ; # 0..* Focal resources
  fhir:Communication.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or episode leading to message
  fhir:Communication.sent [ dateTime ]; # 0..1 When sent
  fhir:Communication.received [ dateTime ]; # 0..1 When received
  fhir:Communication.sender [ Reference(Device|Organization|Patient|Practitioner|RelatedPerson) ]; # 0..1 Message sender
  fhir:Communication.recipient [ Reference(Device|Organization|Patient|Practitioner|RelatedPerson|Group) ], ... ; # 0..* Message recipient
  fhir:Communication.reason [ CodeableConcept ], ... ; # 0..* Indication for message
  fhir:Communication.payload [ # 0..* Message payload
    # Communication.payload.content[x] : 1..1 Message part content. One of these 3
      fhir:Communication.payload.contentString [ string ]
      fhir:Communication.payload.contentAttachment [ Attachment ]
      fhir:Communication.payload.contentReference [ Reference(Any) ]
  ], ...;
  fhir:Communication.note [ Annotation ], ... ; # 0..* Comments made about the communication
]

Changes since DSTU2

Communication
Communication.basedOn added Element
Communication.parent added Element
Communication.subject Add Reference(Group)
Communication.topic added Element
Communication.context Renamed from encounter to context
Add Reference(EpisodeOfCare)
Communication.note added Element
Communication.requestDetail deleted

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . Communication Σ DomainResource A record of information transmitted from a sender to a receiver
. . . identifier Σ 0..* Identifier Unique identifier
. . . basedOn Σ 0..* Reference ( Any ) Request fulfilled by this communication
. . . parent Σ 0..* Reference ( Any ) Part of this action
. . . status ?! Σ 0..1 code in-progress | completed | suspended | rejected | failed
CommunicationStatus ( Required )
. . . category Σ 0..1 CodeableConcept Message category
. . . medium Σ 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode ( Example )
. . . subject Σ 0..1 Reference ( Patient | Group ) Focus of message
. . . topic Σ 0..* Reference ( Any ) Focal resources
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or episode leading to message
. . . sent Σ 0..1 dateTime When sent
. . . received Σ 0..1 dateTime When received
. . . sender Σ 0..1 Reference ( Device | Organization | Patient | Practitioner | RelatedPerson ) Message sender
. . . recipient Σ 0..* Reference ( Device | Organization | Patient | Practitioner | RelatedPerson | Group ) Message recipient
. . . reason Σ 0..* CodeableConcept Indication for message
v3 Code System ActReason ( Example )
. . . payload Σ 0..* BackboneElement Message payload
. . . . content[x] Σ 1..1 Message part content
. . . . . contentString string
. . . . . contentAttachment Attachment
. . . . . contentReference Reference ( Any )
. . . note Σ 0..* Annotation Comments made about the communication

doco Documentation for this format

UML Diagram ( Legend )

Communication ( DomainResource ) Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation) identifier : Identifier [0..*] An order, proposal or plan fulfilled in whole or in part by this Communication basedOn : Reference [0..*] « Any » Part of this action parent : Reference [0..*] « Any » The status of the transmission (this element modifies the meaning of other elements) status : code [0..1] « The status of the communication. (Strength=Required) CommunicationStatus ! » The type of message conveyed such as alert, notification, reminder, instruction, etc category : CodeableConcept [0..1] A channel that was used for this communication (e.g. email, fax) medium : CodeableConcept [0..*] « Codes for communication mediums such as phone, fax, email, in person, etc. (Strength=Example) v3 Code System ParticipationM... ?? » The patient who was the focus of this communication subject : Reference [0..1] « Patient | Group » The resources which were responsible for or related to producing this communication topic : Reference [0..*] « Any » The encounter within which the communication was sent context : Reference [0..1] « Encounter | EpisodeOfCare » The time when this communication was sent sent : dateTime [0..1] The time when this communication arrived at the destination received : dateTime [0..1] The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication sender : Reference [0..1] « Device | Organization | Patient | Practitioner | RelatedPerson » The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time) recipient : Reference [0..*] « Device | Organization | Patient | Practitioner | RelatedPerson | Group » The reason or justification for the communication reason : CodeableConcept [0..*] « Codes for describing reasons for the occurrence of a communication. (Strength=Example) v3 Code System ActReason ?? » Additional notes or commentary about the communication by the sender, receiver or other interested parties note : Annotation [0..*] Payload A communicated content (or for multi-part communications, one portion of the communication) content[x] : Type [1..1] « string | Attachment | Reference ( Any ) » Text, attachment(s), or resource(s) that was communicated to the recipient payload [0..*]

XML Template 

<Communication xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <basedOn><!-- 0..* Reference(Any) Request fulfilled by this communication --></basedOn>
 <parent><!-- 0..* Reference(Any) Part of this action --></parent>
 <status value="[code]"/><!-- 0..1 in-progress | completed | suspended | rejected | failed -->
 <category><!-- 0..1 CodeableConcept Message category --></category>
 <medium><!-- 0..* CodeableConcept A channel of communication --></medium>
 <subject><!-- 0..1 Reference(Patient|Group) Focus of message --></subject>
 <topic><!-- 0..* Reference(Any) Focal resources --></topic>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or episode leading to message --></context>
 <sent value="[dateTime]"/><!-- 0..1 When sent -->
 <received value="[dateTime]"/><!-- 0..1 When received -->
 <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) Message sender --></sender>
 <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson|Group) Message recipient --></recipient>
 <reason><!-- 0..* CodeableConcept Indication for message --></reason>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]>
 </payload>
 <note><!-- 0..* Annotation Comments made about the communication --></note>
</Communication>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Communication;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Communication.identifier [ Identifier ], ... ; # 0..* Unique identifier
  fhir:Communication.basedOn [ Reference(Any) ], ... ; # 0..* Request fulfilled by this communication
  fhir:Communication.parent [ Reference(Any) ], ... ; # 0..* Part of this action
  fhir:Communication.status [ code ]; # 0..1 in-progress | completed | suspended | rejected | failed
  fhir:Communication.category [ CodeableConcept ]; # 0..1 Message category
  fhir:Communication.medium [ CodeableConcept ], ... ; # 0..* A channel of communication
  fhir:Communication.subject [ Reference(Patient|Group) ]; # 0..1 Focus of message
  fhir:Communication.topic [ Reference(Any) ], ... ; # 0..* Focal resources
  fhir:Communication.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or episode leading to message
  fhir:Communication.sent [ dateTime ]; # 0..1 When sent
  fhir:Communication.received [ dateTime ]; # 0..1 When received
  fhir:Communication.sender [ Reference(Device|Organization|Patient|Practitioner|RelatedPerson) ]; # 0..1 Message sender
  fhir:Communication.recipient [ Reference(Device|Organization|Patient|Practitioner|RelatedPerson|Group) ], ... ; # 0..* Message recipient
  fhir:Communication.reason [ CodeableConcept ], ... ; # 0..* Indication for message
  fhir:Communication.payload [ # 0..* Message payload
    # Communication.payload.content[x] : 1..1 Message part content. One of these 3
      fhir:Communication.payload.contentString [ string ]
      fhir:Communication.payload.contentAttachment [ Attachment ]
      fhir:Communication.payload.contentReference [ Reference(Any) ]
  ], ...;
  fhir:Communication.note [ Annotation ], ... ; # 0..* Comments made about the communication
]

Changes since DSTU2

Communication
Communication.basedOn added Element
Communication.parent added Element
Communication.subject Add Reference(Group)
Communication.topic added Element
Communication.context Renamed from encounter to context
Add Reference(EpisodeOfCare)
Communication.note added Element
Communication.requestDetail deleted

See the Full Difference for further information

 

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ), JSON-LD (for RDF as JSON-LD ),

8.20.3.1 Terminology Bindings

Path Definition Type Reference
Communication.status The status of the communication. Required CommunicationStatus
Communication.category Codes for general categories of communications such as alerts, instruction, etc. Unknown No details provided yet
Communication.medium Codes for communication mediums such as phone, fax, email, in person, etc. Example v3 Code System ParticipationMode
Communication.reason Codes for describing reasons for the occurrence of a communication. Example v3 Code System ActReason

Notes to reviewers:

At this time, the code bindings are placeholders to be fleshed out upon further review by the community.

8.20.3.2 Communication.sender and Communication.recepient

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.

8.20.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Paths In Common
based-on reference Request fulfilled by this communication Communication.basedOn
(Any)
category token Message category Communication.category
context reference Encounter or episode leading to message Communication.context
( EpisodeOfCare , Encounter )
identifier token Unique identifier Communication.identifier
medium token A channel of communication Communication.medium
patient reference Focus of message Communication.subject
( Patient )
received date When received Communication.received
recipient reference Message recipient Communication.recipient
( Practitioner , Group , Organization , Device , Patient , RelatedPerson )
sender reference Message sender Communication.sender
( Practitioner , Organization , Device , Patient , RelatedPerson )
sent date When sent Communication.sent
status token in-progress | completed | suspended | rejected | failed Communication.status
subject reference Focus of message Communication.subject
( Group , Patient )