DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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

5.21 Resource Communication - Content

This resource maintained by the Patient Care Work Group

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.

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

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

5.21.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication DomainResourceA record of information transmitted from a sender to a receiver
... identifier 0..*IdentifierUnique identifier
... category 0..1CodeableConceptMessage category
... sender 0..1Device | Organization | Patient | Practitioner | RelatedPersonMessage sender
... recipient 0..*Device | Organization | Patient | Practitioner | RelatedPersonMessage recipient
... payload 0..*ElementMessage payload
.... content[x] Message part content
..... contentString1..1string
..... contentAttachment1..1Attachment
..... contentReference1..1Any
... medium 0..*CodeableConceptCommunication medium
... status ?!0..1codein-progress | completed | suspended | rejected | failed
CommunicationStatus (Required)
... encounter 0..1EncounterEncounter leading to message
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... reason 0..*CodeableConceptIndication for message
... subject 0..1PatientFocus of message

UML Diagram

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..*The type of message conveyed such as alert, notification, reminder, instruction, etccategory : CodeableConcept 0..1The entity (e.g., person, organization, clinical information system, or device) which was the source of the communicationsender : Reference(Device|Organization|Patient| Practitioner|RelatedPerson) 0..1The entity (e.g., person, organization, clinical information system, or device) which was the target of the communicationrecipient : Reference(Device|Organization|Patient| Practitioner|RelatedPerson) 0..*The communication medium, e.g., email, faxmedium : CodeableConcept 0..*The status of the transmission (this element modifies the meaning of other elements)status : code 0..1 « The status of the communicationCommunicationStatus »The encounter within which the communication was sentencounter : Reference(Encounter) 0..1The time when this communication was sentsent : dateTime 0..1The time when this communication arrived at the destinationreceived : dateTime 0..1The reason or justification for the communicationreason : CodeableConcept 0..*The patient who was the focus of this communicationsubject : Reference(Patient) 0..1PayloadAn individual message part for multi-part messagescontent[x] : string|Attachment|Reference(Any) 1..1Text, attachment(s), or resource(s) that was communicated to the recipientpayload0..*

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>
 <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) Message recipient --></recipient>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]>
 </payload>
 <medium><!-- 0..* CodeableConcept Communication medium --></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>
</Communication>

JSON Template

{doco
  "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) }], // Message recipient
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }
  }],
  "medium" : [{ CodeableConcept }], // Communication medium
  "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
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication DomainResourceA record of information transmitted from a sender to a receiver
... identifier 0..*IdentifierUnique identifier
... category 0..1CodeableConceptMessage category
... sender 0..1Device | Organization | Patient | Practitioner | RelatedPersonMessage sender
... recipient 0..*Device | Organization | Patient | Practitioner | RelatedPersonMessage recipient
... payload 0..*ElementMessage payload
.... content[x] Message part content
..... contentString1..1string
..... contentAttachment1..1Attachment
..... contentReference1..1Any
... medium 0..*CodeableConceptCommunication medium
... status ?!0..1codein-progress | completed | suspended | rejected | failed
CommunicationStatus (Required)
... encounter 0..1EncounterEncounter leading to message
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... reason 0..*CodeableConceptIndication for message
... subject 0..1PatientFocus of message

UML Diagram

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..*The type of message conveyed such as alert, notification, reminder, instruction, etccategory : CodeableConcept 0..1The entity (e.g., person, organization, clinical information system, or device) which was the source of the communicationsender : Reference(Device|Organization|Patient| Practitioner|RelatedPerson) 0..1The entity (e.g., person, organization, clinical information system, or device) which was the target of the communicationrecipient : Reference(Device|Organization|Patient| Practitioner|RelatedPerson) 0..*The communication medium, e.g., email, faxmedium : CodeableConcept 0..*The status of the transmission (this element modifies the meaning of other elements)status : code 0..1 « The status of the communicationCommunicationStatus »The encounter within which the communication was sentencounter : Reference(Encounter) 0..1The time when this communication was sentsent : dateTime 0..1The time when this communication arrived at the destinationreceived : dateTime 0..1The reason or justification for the communicationreason : CodeableConcept 0..*The patient who was the focus of this communicationsubject : Reference(Patient) 0..1PayloadAn individual message part for multi-part messagescontent[x] : string|Attachment|Reference(Any) 1..1Text, attachment(s), or resource(s) that was communicated to the recipientpayload0..*

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>
 <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) Message recipient --></recipient>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]>
 </payload>
 <medium><!-- 0..* CodeableConcept Communication medium --></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>
</Communication>

JSON Template

{doco
  "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) }], // Message recipient
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }
  }],
  "medium" : [{ CodeableConcept }], // Communication medium
  "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
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)

5.21.3.1 Terminology Bindings

PathDefinitionTypeReference
Communication.status The status of the communicationRequiredhttp://hl7.org/fhir/communication-status

Notes to reviewers:

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

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

NameTypeDescriptionPaths
categorytokenMessage categoryCommunication.category
encounterreferenceEncounter leading to messageCommunication.encounter
(Encounter)
identifiertokenUnique identifierCommunication.identifier
mediumtokenCommunication mediumCommunication.medium
patientreferenceFocus of messageCommunication.subject
(Patient)
receiveddateWhen receivedCommunication.received
recipientreferenceMessage recipientCommunication.recipient
(Device, Patient, Organization, Practitioner, RelatedPerson)
senderreferenceMessage senderCommunication.sender
(Device, Patient, Organization, Practitioner, RelatedPerson)
sentdateWhen sentCommunication.sent
statustokenin-progress | completed | suspended | rejected | failedCommunication.status
subjectreferenceFocus of messageCommunication.subject
(Patient)