Developer documentation‎ > ‎FHIR API‎ > ‎Roadmap‎ > ‎

Communication

This is a draft document. Please be aware that the contents are subject to change.

FHIR Communication Resource

https://www.hl7.org/fhir/communication.html

Overview

A human-authored [[Message]] (i.e. one where [[Message.Type]] = MESSAGE) is represented in our FHIR API as a Communication.

Relevant Entities

Endpoints

Protection CategoryInteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
ClinicalsearchGET/Communication
  • encounter. Required. Multi-value support: none. Modifier support: [<type>].
  • Patient
  • Professional
Retrieve Communication resources for a specific Encounter./Communication?encounter=Encounter/58d34fa8-f802-4a2e-9535-47ab5c462ef4

Mappings

FHIRPKBNotes
Resource id[[Message.Data Point ID]] 
Communication.status
"unknown"

Communication.subject
  • subject: Reference
    • reference = the relative URL of the Patient resource
 
Communication.recipient
For each [[Message->Recipient]] who was not the Communication.sender, add an entry to the recipient list.
  • recipient: Reference
    • reference = <conditional>
    • If Recipient is a Professional:
      • reference = the relative URL of the Practitioner resource
    • Else if Recipient is a Patient: <conditional>
      • If Recipient is same as Communication.subject:
        • reference = the relative URL of the Patient resource
      • Else:
        • reference = a reference to a contained RelatedPerson instance (see RelatedPerson mappings)
 
Communication.context
  • context: Reference
    • reference = the relative URL of the Encounter resource

Communication.sent[[Message.Timestamp]]
Communication.sender
  • sender: Reference
    • reference = <conditional>
    • If [[Message.Sender]] is a Professional:
      • reference = the relative URL of the Practitioner resource
    • Else if [[Message.Sender]] is a Patient: <conditional>
      • If [[Message.Sender]] is same as Communication.subject:
        • reference = the relative URL of the Patient resource
      • Else:
        • reference = a reference to a contained RelatedPerson instance (see RelatedPerson mappings)
 
Communication.payloadFor each [[Attachment]], add an entry to the payload list:
  • payload: BackboneElement
    • contentAttachment: Attachment
      • title = [[Attachment.Filename]]
Although attachments are returned, the content of the message itself is not currently included in the response.
Comments