This page is part of the FHIR Specification (v1.0.0: DSTU 2 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 . Page versions: R5 R4B R4 R3 R2
Patient Care Work Group | Maturity Level: 0 | 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.
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, 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.
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.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | Σ | DomainResource | A record of information transmitted from a sender to a receiver | |
identifier | Σ | 0..* | Identifier | Unique identifier |
category | Σ | 0..1 | CodeableConcept | Message category |
sender | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Message sender |
recipient | Σ | 0..* | Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group) | Message recipient |
payload | Σ | 0..* | BackboneElement | Message payload |
content[x] | Σ | 1..1 | Message part content | |
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Any) | |||
medium | Σ | 0..* | CodeableConcept | A channel of communication |
status | ?! Σ | 0..1 | code | in-progress | completed | suspended | rejected | failed CommunicationStatus (Required) |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter leading to message |
sent | Σ | 0..1 | dateTime | When sent |
received | Σ | 0..1 | dateTime | When received |
reason | Σ | 0..* | CodeableConcept | Indication for message |
subject | Σ | 0..1 | Reference(Patient) | Focus of message |
requestDetail | Σ | 0..1 | Reference(CommunicationRequest) | CommunicationRequest producing this message |
Documentation for this format |
UML Diagram
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><!-- 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
{ "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 | Description & Constraints |
---|---|---|---|---|
Communication | Σ | DomainResource | A record of information transmitted from a sender to a receiver | |
identifier | Σ | 0..* | Identifier | Unique identifier |
category | Σ | 0..1 | CodeableConcept | Message category |
sender | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Message sender |
recipient | Σ | 0..* | Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group) | Message recipient |
payload | Σ | 0..* | BackboneElement | Message payload |
content[x] | Σ | 1..1 | Message part content | |
contentString | string | |||
contentAttachment | Attachment | |||
contentReference | Reference(Any) | |||
medium | Σ | 0..* | CodeableConcept | A channel of communication |
status | ?! Σ | 0..1 | code | in-progress | completed | suspended | rejected | failed CommunicationStatus (Required) |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter leading to message |
sent | Σ | 0..1 | dateTime | When sent |
received | Σ | 0..1 | dateTime | When received |
reason | Σ | 0..* | CodeableConcept | Indication for message |
subject | Σ | 0..1 | Reference(Patient) | Focus of message |
requestDetail | Σ | 0..1 | Reference(CommunicationRequest) | CommunicationRequest producing this message |
Documentation for this format |
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><!-- 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
{ "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: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
Communication.status | The status of the communication | Required | CommunicationStatus |
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.
Name | Type | Description | Paths |
category | token | Message category | Communication.category |
encounter | reference | Encounter leading to message | Communication.encounter (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 (Device, Patient, Organization, Practitioner, Group, RelatedPerson) |
request | reference | CommunicationRequest producing this message | Communication.requestDetail (CommunicationRequest) |
sender | reference | Message sender | Communication.sender (Device, Patient, Organization, Practitioner, RelatedPerson) |
sent | date | When sent | Communication.sent |
status | token | in-progress | completed | suspended | rejected | failed | Communication.status |
subject | reference | Focus of message | Communication.subject (Patient) |