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

# Class Diagram

<u>[Document](https://miro.com/app/board/uXjVMNRdhiw=/?share_link_id=855924033575)</u>

# Display

Documents 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:

- [Hybrid mail management](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363405873)

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create | [T02(document)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/document) |  |  |  |  |
| Read |  | [/DocumentReference](http://fhir.patientsknowbest.com/structuredefinition/facade-documentreference) |  | [Events & messages](https://manual.patientsknowbest.com/patient/events-messages) | [/messages/after/<time>](https://sandbox.patientsknowbest.com/api/index.html#/Messages)<br>[/attachments/id](https://sandbox.patientsknowbest.com/api/index.html#/Attachments) |
| Update | [T02(document)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/document) |  |  |  |  |
| Delete | [T11](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364947080) |  |  |  |  |
| **Entity: Document - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Class** `Enum`<br>- IN_PATIENT
- OUT_PATIENT
- AMBULATORY
- EMERGENCY
- HOME
- FIELD
- DAYTIME
- VIRTUAL
- OTHER | [PV1-2.1 (MDM T02/document)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/document) |  |  | Shown. |  |
| **Timestamp** `Timestamp`<br>The document timestamp. | <u>[TXA-8,7,6,4](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/document)</u> | [DocumentReference.created](http://fhir.patientsknowbest.com/structuredefinition/facade-documentreference) |  | Shown. |  |
| **Document Type** `Enum`<br>- ADMISSION_TCI_LETTER
- ALERT_NOTIFICATION
- APPOINTMENT_LETTER
- BIRTH_REPORT
- CLINIC_LETTER
- DISCHARGE_LETTER
- DISCHARGE_SUMMARY
- MULTI_DISCIPLINARY_TEAM_MEETING_NOTES
- REFERRAL_LETTER | [TXA-2.1 (MDM T02/document)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/document) | [DocumentReference.type](http://fhir.patientsknowbest.com/structuredefinition/facade-documentreference) |  | Shown. |  |
| **Status** `Enum`<br>- READ
- UNREAD |  | [document-status](http://fhir.patientsknowbest.com/structuredefinition/document-status)   
[search param: document-status](http://fhir.patientsknowbest.com/searchparameter/document-status) |  | The colour of the conversation indicates whether or not the message has been read. |  |
| **Planned Postal Date** `Timestamp`<br>When this document would need to be posted. This field forms part of the [Mail Management](http://dev.patientsknowbest.com/home/developer-tutorial/mail-management-apis) workflow. | [ZPM-1](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/document) |  |  | Not shown. |  |
| **Delay** `Number`<br>The number of days for which the content of the data point should be hidden from the patient and carers. | [OBX-13 (MDM T02/document)](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848860) |  |  | A placeholder is shown to the patient and carers, letting them know when the content will be displayed. |  |