---
title: "Entity: Conversation"
canonical: "https://wiki.patientsknowbest.com/space/api/3744628737/Entity%3A%20Conversation"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Conversation](https://miro.com/app/board/uXjVMNSOx1A=/?share_link_id=559740075659)</u>

# Display

Conversations appear in the Events & messages page of a patient's record.

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fevents-messages&sa=D&sntz=1&usg=AOvVaw3KGUcb-zsSj-WuyxgQ421v)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fevents-messages&sa=D&sntz=1&usg=AOvVaw3KGUcb-zsSj-WuyxgQ421v)</u> for more information.

# Solutions

PKB solutions related to this data type:

- [Secure Messaging](https://wiki.patientsknowbest.com/space/DEPLOY/3539370011/Universal+Secure+Messaging)

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  | [Events & messages](https://manual.patientsknowbest.com/patient/events-messages) |  |
| Read |  | [/Communication](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365011756) |  | [Events & messages](https://manual.patientsknowbest.com/patient/events-messages) | [/messages/after/<time>](https://sandbox.patientsknowbest.com/api/index.html#/Messages) |
| Update |  |  |  | [Events & messages](https://manual.patientsknowbest.com/patient/events-messages)<br>(only draft messages can be edited) |  |
| Delete |  |  |  | [Events & messages](https://manual.patientsknowbest.com/patient/events-messages)<br>(only draft messages can be deleted) |  |
| **Entity: Conversation** |
| **Conversation ID** `String`<br>A unique ID identifying this conversation. This ID will not change even if the conversation is modified. |  | [conversation-id](http://fhir.patientsknowbest.com/structuredefinition/conversation-id) |  | Not shown. |  |
| **Entity: Message - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Timestamp** `Timestamp`<br>When the message was sent. |  | [Communication.sent](http://fhir.patientsknowbest.com/structuredefinition/facade-communication) |  | Shown. |  |
| **Subject** `String`<br>A brief description of what the message is about. |  | [communication-title](http://fhir.patientsknowbest.com/structuredefinition/communication-title) |  | Shown. |  |
| **Content** `String`<br>The content of the message. |  |  |  | Shown. |  |
| **Is HTML** `Boolean`<br>Whether the content should be interpreted as HTML, rather than plain text. |  |  |  | The web interface adjusts automatically. |  |
| **Sender** `Ref: [[User.Public ID]]`<br>The PKB user who sent the message. |  | [Communication.sender](http://fhir.patientsknowbest.com/structuredefinition/facade-communication) |  | Shown. |  |
| **Private** `Boolean`<br>Whether or not the message is available to non-participants.<br>Note: This is a legacy feature. Messages can no longer be marked as private. |  |  |  | Legacy feature. |  |
| **Status** `Enum`<br>- DRAFT
- SENT
- UNREAD
- READ |  |  |  | An indication is shown for draft messages.<br>The colour of the conversation indicates whether or not the message has been read. |  |
| **First Read Timestamp** `Timestamp`<br>The server-assigned timestamp indicating when the patient first read the message in the PKB web interface. |  |  |  | Not shown. |  |
| **Entity: Recipient** |
| **User Public ID** `Ref: [[User.Public ID]]`<br>A PKB user who received the message. |  | [Communication.recipient](http://fhir.patientsknowbest.com/structuredefinition/facade-communication) |  | The names of the recipients are shown. |  |