FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.5.0: R4 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

8.20 8.23 Resource Communication - Content

Patient Care Work Group Maturity Level : 2   Trial Use 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 8.23.1 Scope and Usage

Communication is one of the event resources in the FHIR workflow specification.

This resource is a record of a communication. communication even if it is planned or has failed. 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 to the on call physician (or any other specified person) 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
  • Unable to deliver lab results to ordering physician

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 8.23.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 might not be known. As well, AuditEvents are not considered to be "part" "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" "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 might or may might 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, transferred but are not ideal to represent the call itself. A better mechanism for handling such calls will be explored in a future release.

This resource is referenced by itself

8.20.3 8.23.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . Communication I TU DomainResource A record of information transmitted from a sender to a receiver
+ Not Done Reason can only be specified if NotDone is "true" Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . definition instantiatesCanonical Σ 0..* Reference canonical ( PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire ) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
. . . basedOn Σ 0..* Reference ( Any ) Request fulfilled by this communication
. . . partOf Σ 0..* Reference ( Any ) Part of this action
. . . inResponseTo 0..* Reference ( Communication ) Reply to
.. . status ?! Σ 1..1 code preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
EventStatus ( Required )
. . notDone . statusReason ?! Σ 0..1 boolean CodeableConcept Communication did not occur Reason for current status
CommunicationNotDoneReason ( Example )
. . . notDoneReason category Σ I 0..1 0..* CodeableConcept Why communication did not occur Message category
CommunicationNotDoneReason CommunicationCategory ( Example )
. . category . priority Σ 0..* 0..1 CodeableConcept code Message category urgency
CommunicationCategory Request priority ( Example Required )
. . . medium 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode ( Example )
. . . subject Σ 0..1 Reference ( Patient | Group ) Focus of message
. . recipient . topic 0..* 0..1 Reference ( Device | Organization | Patient | Practitioner | RelatedPerson | Group CodeableConcept ) Message recipient Description of the purpose/content
CommunicationTopic ( Example )
. . . topic about 0..* Reference ( Any ) Focal resources Resources that pertain to this communication
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or episode leading to message
. . . sent 0..1 dateTime When sent
. . . received 0..1 dateTime When received
. . . recipient 0..* Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService ) Message recipient
... sender 0..1 Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService ) Message sender
. . . reasonCode Σ 0..* CodeableConcept Indication for message
SNOMED CT Clinical Findings ( Example )
. . . reasonReference Σ 0..* Reference ( Condition | Observation | DiagnosticReport | DocumentReference ) Why was communication done?
. . . 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 Business identifiers assigned to this Communication that are defined communication by business processes and/ the performer or used to refer to it when a direct URL reference to other systems which remain constant as the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation) updated and propagates from server to server identifier : Identifier [0..*] A The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that was is adhered to in whole or in part by this communication event Communication definition instantiatesCanonical : Reference canonical [0..*] « PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire » The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication instantiatesUri : uri [0..*] An order, proposal or plan fulfilled in whole or in part by this Communication basedOn : Reference [0..*] « Any » Part of this action partOf : Reference [0..*] « Any » Prior communication that this communication is in response to inResponseTo : Reference [0..*] « Communication » The status of the transmission (this element modifies the meaning of other elements) status : code [1..1] « The status of the communication. (Strength=Required) EventStatus ! » If true, indicates that Captures the described communication event did not actually occur (this element modifies reason for the meaning current state of other elements) notDone : boolean [0..1] Describes why the communication event did not occur in coded and/or textual form Communication notDoneReason statusReason : CodeableConcept [0..1] « Codes for the reason why a communication was not done. (Strength=Example) CommunicationNotDoneReason ?? » The type of message conveyed such as alert, notification, reminder, instruction, etc category : CodeableConcept [0..*] « Codes for general categories of communications such as alerts, instruction, etc. (Strength=Example) CommunicationCategory ?? » Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine priority : code [0..1] « Codes indicating the relative importance of a communication. (Strength=Required) RequestPriority ! » 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... v3.ParticipationMode ?? » The patient or group that was the focus of this communication subject : Reference [0..1] « Patient | Group » Description of the purpose/content, similar to a subject line in an email topic : CodeableConcept [0..1] « Codes describing the purpose or content of the communication. (Strength=Example) CommunicationTopic ?? » Other resources that pertain to this communication and to which this communication should be associated about : 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, care team 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 | PractitionerRole | RelatedPerson | 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 CareTeam [0..1] | The time when this communication arrived at the destination received : dateTime HealthcareService [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 | PractitionerRole | RelatedPerson | HealthcareService » The reason or justification for the communication reasonCode : CodeableConcept [0..*] « Codes for describing reasons for the occurrence of a communication. (Strength=Example) SNOMED CT Clinical Findings SNOMEDCTClinicalFindings ?? » Indicates another resource whose existence justifies this communication reasonReference : Reference [0..*] « Condition | Observation | DiagnosticReport | DocumentReference » 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>
 <</definition>

 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <instantiatesCanonical><!-- 0..* canonical(PlanDefinition|ActivityDefinition|
   Measure|OperationDefinition|Questionnaire) Instantiates FHIR protocol or definition --></instantiatesCanonical>

 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->

 <basedOn><!-- 0..* Reference(Any) Request fulfilled by this communication --></basedOn>
 <partOf><!-- 0..* Reference(Any) Part of this action --></partOf>
 <
 <
 <</notDoneReason>

 <inResponseTo><!-- 0..* Reference(Communication) Reply to --></inResponseTo>
 <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>

 <category><!-- 0..* CodeableConcept Message category --></category>
 <priority value="[code]"/><!-- 0..1 Message urgency -->

 <medium><!-- 0..* CodeableConcept A channel of communication --></medium>
 <subject><!-- 0..1 Reference(Patient|Group) Focus of message --></subject>
 <|
   </recipient>
 <</topic>

 <topic><!-- 0..1 CodeableConcept Description of the purpose/content --></topic>
 <about><!-- 0..* Reference(Any) Resources that pertain to this communication --></about>

 <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 -->
 <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) Message recipient --></recipient>
 <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   </sender>

   PractitionerRole|RelatedPerson|HealthcareService) Message sender --></sender>
 <reasonCode><!-- 0..* CodeableConcept Indication for message --></reasonCode>
 <</reasonReference>

 <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) Why was communication done? --></reasonReference>
 <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>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Communication",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "|
   
  "
  "
  "
  "
  "|
   
  "
  "
  "

  "identifier" : [{ Identifier }], // Unique identifier
  "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
   Measure|OperationDefinition|Questionnaire) }], // Instantiates FHIR protocol or definition

  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this communication
  "partOf" : [{ Reference(Any) }], // Part of this action
  "inResponseTo" : [{ Reference(Communication) }], // Reply to
  "status" : "<code>", // R!  preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
  "statusReason" : { CodeableConcept }, // Reason for current status
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // Message urgency
  "medium" : [{ CodeableConcept }], // A channel of communication
  "subject" : { Reference(Patient|Group) }, // Focus of message
  "topic" : { CodeableConcept }, // Description of the purpose/content
  "about" : [{ Reference(Any) }], // Resources that pertain to this communication
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode leading to message
  "sent" : "<dateTime>", // When sent
  "received" : "<dateTime>", // When received
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) }], // Message recipient

  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|HealthcareService) }, // Message sender

  "reasonCode" : [{ CodeableConcept }], // Indication for message
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // Why was communication done?

  "payload" : [{ // Message payload

    // content[x]: Message part content. One of these 3:
    ">"
    " }
    " }

    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }

  }],
  "

  "note" : [{ Annotation }] // Comments made about the 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:
  fhir:

  fhir:Communication.identifier [ Identifier ], ... ; # 0..* Unique identifier
  fhir:Communication.instantiatesCanonical [ canonical(PlanDefinition|ActivityDefinition|Measure|OperationDefinition|Questionnaire) ], ... ; # 0..* Instantiates FHIR protocol or definition
  fhir:Communication.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition

  fhir:Communication.basedOn [ Reference(Any) ], ... ; # 0..* Request fulfilled by this communication
  fhir:Communication.partOf [ Reference(Any) ], ... ; # 0..* Part of this action
  fhir:
  fhir:
  fhir:

  fhir:Communication.inResponseTo [ Reference(Communication) ], ... ; # 0..* Reply to
  fhir:Communication.status [ code ]; # 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
  fhir:Communication.statusReason [ CodeableConcept ]; # 0..1 Reason for current status

  fhir:Communication.category [ CodeableConcept ], ... ; # 0..* Message category
  fhir:Communication.priority [ code ]; # 0..1 Message urgency

  fhir:Communication.medium [ CodeableConcept ], ... ; # 0..* A channel of communication
  fhir:Communication.subject [ Reference(Patient|Group) ]; # 0..1 Focus of message
  fhir:
  fhir:

  fhir:Communication.topic [ CodeableConcept ]; # 0..1 Description of the purpose/content
  fhir:Communication.about [ Reference(Any) ], ... ; # 0..* Resources that pertain to this communication

  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:

  fhir:Communication.recipient [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Group|
  CareTeam|HealthcareService) ], ... ; # 0..* Message recipient

  fhir:Communication.sender [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|
  HealthcareService) ]; # 0..1 Message sender
  fhir:Communication.reasonCode [ CodeableConcept ], ... ; # 0..* Indication for message
  fhir:

  fhir:Communication.reasonReference [ Reference(Condition|Observation|DiagnosticReport|DocumentReference) ], ... ; # 0..* Why was communication done?

  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 R3

Communication
Communication.definition Communication.instantiatesCanonical
  • Added Element
Communication.basedOn Communication.instantiatesUri
  • Renamed from requestDetail to basedOn Added Element
Communication.inResponseTo
  • Max Cardinality changed from 1 to * Added Element
Communication.statusReason
  • Type changed from Reference(CommunicationRequest) to Reference(Resource) Added Element
Communication.partOf Communication.priority
  • Added Element
Communication.status Communication.topic
  • Min Max Cardinality changed from 0 * to 1
  • Change value set Type changed from http://hl7.org/fhir/ValueSet/communication-status Reference(Resource) to http://hl7.org/fhir/ValueSet/event-status Communication.notDone Added Element CodeableConcept
Communication.notDoneReason Communication.about
  • Added Element
Communication.category Communication.recipient
  • Max Cardinality Type changed from 1 Reference(Device|Organization|Patient|Practitioner|RelatedPerson|Group) to * Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService)
Communication.subject Communication.sender
  • Add Reference(Group) Type changed from Reference(Device|Organization|Patient|Practitioner|RelatedPerson) to Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|HealthcareService)
Communication.topic Communication.reasonReference
  • Added Element Type changed from Reference(Condition|Observation) to Reference(Condition|Observation|DiagnosticReport|DocumentReference)
Communication.context Communication.payload.content[x]
  • Renamed from encounter to context Remove Reference(Resource), Add Reference(EpisodeOfCare) Reference(Resource)
Communication.reasonCode Communication.definition
  • Renamed from reason to reasonCode deleted
Communication.reasonReference Communication.notDone
  • Added Element deleted
Communication.note Communication.notDoneReason
  • Added Element deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 2 3 tests that all of which 3 fail to execute ok. All tests pass round-trip testing and all r3 resources are valid.). .)

Structure

Name Flags Card. Type Description & Constraints doco
. . Communication I TU DomainResource A record of information transmitted from a sender to a receiver
+ Not Done Reason can only be specified if NotDone is "true" Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . definition instantiatesCanonical Σ 0..* Reference canonical ( PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire ) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
. . . basedOn Σ 0..* Reference ( Any ) Request fulfilled by this communication
. . . partOf Σ 0..* Reference ( Any ) Part of this action
. . . inResponseTo 0..* Reference ( Communication ) Reply to
.. . status ?! Σ 1..1 code preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
EventStatus ( Required )
. . notDone . statusReason ?! Σ 0..1 boolean CodeableConcept Communication did not occur Reason for current status
CommunicationNotDoneReason ( Example )
. . . notDoneReason category Σ I 0..1 0..* CodeableConcept Why communication did not occur Message category
CommunicationNotDoneReason CommunicationCategory ( Example )
. . category . priority Σ 0..* 0..1 CodeableConcept code Message category urgency
CommunicationCategory Request priority ( Example Required )
. . . medium 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode ( Example )
. . . subject Σ 0..1 Reference ( Patient | Group ) Focus of message
. . recipient . topic 0..* 0..1 Reference ( Device | Organization | Patient | Practitioner | RelatedPerson | Group CodeableConcept ) Message recipient Description of the purpose/content
CommunicationTopic ( Example )
. . . topic about 0..* Reference ( Any ) Focal resources Resources that pertain to this communication
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or episode leading to message
. . . sent 0..1 dateTime When sent
. . . received 0..1 dateTime When received
. . . recipient 0..* Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService ) Message recipient
... sender 0..1 Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService ) Message sender
. . . reasonCode Σ 0..* CodeableConcept Indication for message
SNOMED CT Clinical Findings ( Example )
. . . reasonReference Σ 0..* Reference ( Condition | Observation | DiagnosticReport | DocumentReference ) Why was communication done?
. . . 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 Business identifiers assigned to this Communication that are defined communication by business processes and/ the performer or used to refer to it when a direct URL reference to other systems which remain constant as the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation) updated and propagates from server to server identifier : Identifier [0..*] A The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that was is adhered to in whole or in part by this communication event Communication definition instantiatesCanonical : Reference canonical [0..*] « PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire » The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication instantiatesUri : uri [0..*] An order, proposal or plan fulfilled in whole or in part by this Communication basedOn : Reference [0..*] « Any » Part of this action partOf : Reference [0..*] « Any » Prior communication that this communication is in response to inResponseTo : Reference [0..*] « Communication » The status of the transmission (this element modifies the meaning of other elements) status : code [1..1] « The status of the communication. (Strength=Required) EventStatus ! » If true, indicates that Captures the described communication event did not actually occur (this element modifies reason for the meaning current state of other elements) notDone : boolean [0..1] Describes why the communication event did not occur in coded and/or textual form Communication notDoneReason statusReason : CodeableConcept [0..1] « Codes for the reason why a communication was not done. (Strength=Example) CommunicationNotDoneReason ?? » The type of message conveyed such as alert, notification, reminder, instruction, etc category : CodeableConcept [0..*] « Codes for general categories of communications such as alerts, instruction, etc. (Strength=Example) CommunicationCategory ?? » Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine priority : code [0..1] « Codes indicating the relative importance of a communication. (Strength=Required) RequestPriority ! » 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... v3.ParticipationMode ?? » The patient or group that was the focus of this communication subject : Reference [0..1] « Patient | Group » Description of the purpose/content, similar to a subject line in an email topic : CodeableConcept [0..1] « Codes describing the purpose or content of the communication. (Strength=Example) CommunicationTopic ?? » Other resources that pertain to this communication and to which this communication should be associated about : 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, care team 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 | PractitionerRole | RelatedPerson | 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 CareTeam [0..1] | The time when this communication arrived at the destination received : dateTime HealthcareService [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 | PractitionerRole | RelatedPerson | HealthcareService » The reason or justification for the communication reasonCode : CodeableConcept [0..*] « Codes for describing reasons for the occurrence of a communication. (Strength=Example) SNOMED CT Clinical Findings SNOMEDCTClinicalFindings ?? » Indicates another resource whose existence justifies this communication reasonReference : Reference [0..*] « Condition | Observation | DiagnosticReport | DocumentReference » 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>
 <</definition>

 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <instantiatesCanonical><!-- 0..* canonical(PlanDefinition|ActivityDefinition|
   Measure|OperationDefinition|Questionnaire) Instantiates FHIR protocol or definition --></instantiatesCanonical>

 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->

 <basedOn><!-- 0..* Reference(Any) Request fulfilled by this communication --></basedOn>
 <partOf><!-- 0..* Reference(Any) Part of this action --></partOf>
 <
 <
 <</notDoneReason>

 <inResponseTo><!-- 0..* Reference(Communication) Reply to --></inResponseTo>
 <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>

 <category><!-- 0..* CodeableConcept Message category --></category>
 <priority value="[code]"/><!-- 0..1 Message urgency -->

 <medium><!-- 0..* CodeableConcept A channel of communication --></medium>
 <subject><!-- 0..1 Reference(Patient|Group) Focus of message --></subject>
 <|
   </recipient>
 <</topic>

 <topic><!-- 0..1 CodeableConcept Description of the purpose/content --></topic>
 <about><!-- 0..* Reference(Any) Resources that pertain to this communication --></about>

 <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 -->
 <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) Message recipient --></recipient>
 <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   </sender>

   PractitionerRole|RelatedPerson|HealthcareService) Message sender --></sender>
 <reasonCode><!-- 0..* CodeableConcept Indication for message --></reasonCode>
 <</reasonReference>

 <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) Why was communication done? --></reasonReference>
 <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>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Communication",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "|
   
  "
  "
  "
  "
  "|
   
  "
  "
  "

  "identifier" : [{ Identifier }], // Unique identifier
  "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
   Measure|OperationDefinition|Questionnaire) }], // Instantiates FHIR protocol or definition

  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this communication
  "partOf" : [{ Reference(Any) }], // Part of this action
  "inResponseTo" : [{ Reference(Communication) }], // Reply to
  "status" : "<code>", // R!  preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
  "statusReason" : { CodeableConcept }, // Reason for current status
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // Message urgency
  "medium" : [{ CodeableConcept }], // A channel of communication
  "subject" : { Reference(Patient|Group) }, // Focus of message
  "topic" : { CodeableConcept }, // Description of the purpose/content
  "about" : [{ Reference(Any) }], // Resources that pertain to this communication
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode leading to message
  "sent" : "<dateTime>", // When sent
  "received" : "<dateTime>", // When received
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) }], // Message recipient

  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|HealthcareService) }, // Message sender

  "reasonCode" : [{ CodeableConcept }], // Indication for message
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // Why was communication done?

  "payload" : [{ // Message payload

    // content[x]: Message part content. One of these 3:
    ">"
    " }
    " }

    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }

  }],
  "

  "note" : [{ Annotation }] // Comments made about the 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:
  fhir:

  fhir:Communication.identifier [ Identifier ], ... ; # 0..* Unique identifier
  fhir:Communication.instantiatesCanonical [ canonical(PlanDefinition|ActivityDefinition|Measure|OperationDefinition|Questionnaire) ], ... ; # 0..* Instantiates FHIR protocol or definition
  fhir:Communication.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition

  fhir:Communication.basedOn [ Reference(Any) ], ... ; # 0..* Request fulfilled by this communication
  fhir:Communication.partOf [ Reference(Any) ], ... ; # 0..* Part of this action
  fhir:
  fhir:
  fhir:

  fhir:Communication.inResponseTo [ Reference(Communication) ], ... ; # 0..* Reply to
  fhir:Communication.status [ code ]; # 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
  fhir:Communication.statusReason [ CodeableConcept ]; # 0..1 Reason for current status

  fhir:Communication.category [ CodeableConcept ], ... ; # 0..* Message category
  fhir:Communication.priority [ code ]; # 0..1 Message urgency

  fhir:Communication.medium [ CodeableConcept ], ... ; # 0..* A channel of communication
  fhir:Communication.subject [ Reference(Patient|Group) ]; # 0..1 Focus of message
  fhir:
  fhir:

  fhir:Communication.topic [ CodeableConcept ]; # 0..1 Description of the purpose/content
  fhir:Communication.about [ Reference(Any) ], ... ; # 0..* Resources that pertain to this communication

  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:

  fhir:Communication.recipient [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Group|
  CareTeam|HealthcareService) ], ... ; # 0..* Message recipient

  fhir:Communication.sender [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|
  HealthcareService) ]; # 0..1 Message sender
  fhir:Communication.reasonCode [ CodeableConcept ], ... ; # 0..* Indication for message
  fhir:

  fhir:Communication.reasonReference [ Reference(Condition|Observation|DiagnosticReport|DocumentReference) ], ... ; # 0..* Why was communication done?

  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 Release 3

Communication
Communication.definition Communication.instantiatesCanonical
  • Added Element
Communication.basedOn Communication.instantiatesUri
  • Renamed from requestDetail to basedOn Added Element
Communication.inResponseTo
  • Max Cardinality changed from 1 to * Added Element
Communication.statusReason
  • Type changed from Reference(CommunicationRequest) to Reference(Resource) Added Element
Communication.partOf Communication.priority
  • Added Element
Communication.status Communication.topic
  • Min Max Cardinality changed from 0 * to 1
  • Change value set Type changed from http://hl7.org/fhir/ValueSet/communication-status Reference(Resource) to http://hl7.org/fhir/ValueSet/event-status Communication.notDone Added Element CodeableConcept
Communication.notDoneReason Communication.about
  • Added Element
Communication.category Communication.recipient
  • Max Cardinality Type changed from 1 Reference(Device|Organization|Patient|Practitioner|RelatedPerson|Group) to * Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService)
Communication.subject Communication.sender
  • Add Reference(Group) Type changed from Reference(Device|Organization|Patient|Practitioner|RelatedPerson) to Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|HealthcareService)
Communication.topic Communication.reasonReference
  • Added Element Type changed from Reference(Condition|Observation) to Reference(Condition|Observation|DiagnosticReport|DocumentReference)
Communication.context Communication.payload.content[x]
  • Renamed from encounter to context Remove Reference(Resource), Add Reference(EpisodeOfCare) Reference(Resource)
Communication.reasonCode Communication.definition
  • Renamed from reason to reasonCode deleted
Communication.reasonReference Communication.notDone
  • Added Element deleted
Communication.note Communication.notDoneReason
  • Added Element deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 2 3 tests that all of which 3 fail to execute ok. All tests pass round-trip testing and all r3 resources are valid.). .)

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

8.20.3.1 8.23.3.1 Terminology Bindings

Path Definition Type Reference
Communication.status The status of the communication. Required EventStatus
Communication.notDoneReason Communication.statusReason Codes for the reason why a communication was not done. Example CommunicationNotDoneReason
Communication.category Codes for general categories of communications such as alerts, instruction, etc. Example CommunicationCategory
Communication.priority Codes indicating the relative importance of a communication. Required RequestPriority
Communication.medium Codes for communication mediums such as phone, fax, email, in person, etc. Example v3 Code System ParticipationMode v3.ParticipationMode
Communication.topic Codes describing the purpose or content of the communication. Example CommunicationTopic
Communication.reasonCode Codes for describing reasons for the occurrence of a communication. Example SNOMED CT Clinical Findings SNOMEDCTClinicalFindings

8.20.3.2 Constraints com-1 : Not Done Reason can only be specified if NotDone is "true" ( expression : notDone or notDoneReason.exists().not() )

Notes to reviewers:

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

8.20.3.3 8.23.3.2 Communication.sender and Communication.recepient Communication.recipient

Communication.sender allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService and Communication.recipient allow Patient|Practitioner|RelatedPerson allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService - 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 8.23.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 Expression 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 )
definition encounter reference Instantiates protocol or definition Encounter leading to message Communication.definition Communication.context.where(resolve() is Encounter)
( PlanDefinition , ActivityDefinition Encounter )
encounter identifier token Unique identifier Communication.identifier
instantiates-canonical reference Encounter leading to message Instantiates FHIR protocol or definition Communication.context Communication.instantiatesCanonical
( Encounter Questionnaire , Measure , PlanDefinition , OperationDefinition , ActivityDefinition )
identifier instantiates-uri token uri Unique identifier Instantiates external protocol or definition Communication.identifier Communication.instantiatesUri
medium token A channel of communication Communication.medium
part-of reference Part of this action Communication.partOf
(Any)
patient reference Focus of message Communication.subject Communication.subject.where(resolve() is Patient)
( Patient )
received date When received Communication.received
recipient reference Message recipient Communication.recipient
( Practitioner , Group , Organization , CareTeam , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson )
sender reference Message sender Communication.sender
( Practitioner , Organization , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson )
sent date When sent Communication.sent
status token preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error Communication.status
subject reference Focus of message Communication.subject
( Group , Patient )