Communication

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

Status

Released. Further enhancements planned.

Overview

A [[Message]] from a [[Conversation]] 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.

Note: messages still in draft (i.e. not yet sent) will not be returned.

Relevant PKB Entities

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescriptionExamples (more)
searchGET/Communication
  • patient. Required. Multi-value support: none. Modifier support: [<type>].
  • sent. Optional. Multi-value support: AND. Modifier support: none. Prefixes supported: [eq, gt, lt, ge, le].
  • _revinclude=Provenance:target
  • Patient
  • Professional
Retrieve Communication resources for a specific patient.

In addition, can optionally include source information.		/Communication?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01

/Communication?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01&_revinclude=Provenance:target

Mappings

FHIRPKBNotes
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]]
  • extension[1]: Extension
    • url = "http://fhir.patientsknowbest.com/structuredefinition/conversation-id"
    • valueString = [[Message->Conversation.Conversation ID]]
 
Communication.status"unknown"
Communication.subject
  • subject: Reference
    • reference = the relative URL of the Patient resource
    • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
 
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 or a Team Coordinator:
      • reference = the relative URL of the Practitioner resource
      • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
    • Else if Recipient is a Patient: <conditional>
      • If Recipient is same as Communication.subject:
        • reference = the relative URL of the Patient resource
        • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
      • Else:
        • reference = a reference to a contained RelatedPerson instance (see RelatedPerson mappings)
        • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
 
Communication.sent[[Message.Timestamp]]
Communication.sender
  • sender: Reference
    • reference = <conditional>
    • If [[Message.Sender]] is a Professional or a Team Coordinator:
      • reference = the relative URL of the Practitioner resource
      • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
    • Else if [[Message.Sender]] is a Patient: <conditional>
      • If [[Message.Sender]] is same as Communication.subject:
        • reference = the relative URL of the Patient resource
        • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
      • Else:
        • reference = a reference to a contained RelatedPerson instance (see RelatedPerson mappings)
        • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]
 
Communication.payloadFor each [[Attachment]], add an entry to the payload list:
  • payload: BackboneElement
    • contentAttachment: Attachment
      • title = [[Attachment.Filename]]
      • creation = [[Message.Persisted Timestamp]]
Only attachment metadata is returned; the content of any attachments, or of the message itself, is not currently returned.
Subpages (1): Examples
Comments