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

Communication

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

Status

In development. API spec subject to change.

Overview

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

These are normally human-authored but can sometimes be generated in other situations, e.g. when a patient completes a consultation.

Relevant PKB Entities

Endpoints

Interaction HTTP URL Supported Search Params Permitted User Types Description Examples
search GET /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

FHIR PKB Notes
Resource id [[Message.Data Point ID]]  
Resource meta
  • meta: Meta
    • lastUpdated = [[Data Point.Persisted Timestamp]]
    • security: Coding
      • system = "http://fhir.patientsknowbest.com/codesystem/privacy-label"
      • code = [[Data Point.Privacy Label]]
[[Data Point.Privacy Label]] code mappings (PKB → FHIR):
  • GENERAL_HEALTH → GENERAL_HEALTH
  • MENTAL_HEALTH → MENTAL_HEALTH
  • SEXUAL_HEALTH → SEXUAL_HEALTH
  • SOCIAL_CARE → SOCIAL_CARE

Communication.extension
  • extension[0]: Extension
    • url = "http://fhir.patientsknowbest.com/structuredefinition/communication-title"
    • valueString = [[Message.Subject]]
 
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.payload For 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