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

# Class Diagram

<u>[File](https://miro.com/app/board/uXjVMhW1O88=/?share_link_id=85370099629)</u>

# Display

Files appear in the Files page of a patient's record.

Please note that the File data type is different from the [Document](https://pkbdev.atlassian.net/wiki/spaces/api/pages/3743121409/Entity+Document) data type.

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://manual.patientsknowbest.com/patient/files)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  | [Files](https://manual.patientsknowbest.com/patient/files) |  |
| Read |  |  |  | [Files](https://manual.patientsknowbest.com/patient/files) |  |
| Update |  |  |  | [Files](https://manual.patientsknowbest.com/patient/files) (only Date and Notes can be updated) |  |
| Delete |  |  |  | [Files](https://manual.patientsknowbest.com/patient/files) |  |
| **Entity: File - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Filename **`String`<br>Name of the file. |  |  |  | Shown. |  |
| **Date** `Timestamp`<br>A meaningful time stamp for the contents of the file. |  |  |  | Shown.<br>The web interface permits entry of date but not time. |  |
| **Notes **`String`<br>Notes accompanying the file. |  |  |  | Shown. |  |
| **Content** `Binary`<br>The content of the file. |  |  |  | Can be viewed or downloaded, depending on the type of content. |  |
| **Media Type** `String`<br>The type of media contained in the content. |  |  |  | Not shown. |  |