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

# Class Diagram

<u>[Patient & Contact](https://miro.com/app/board/uXjVMNb-c3g=/?share_link_id=189533461934)</u>

# Display

Demographics appear in the Settings page of the patient's record.

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fupdating-your-settings&sa=D&sntz=1&usg=AOvVaw0hUh8L2m7ZKd3vUVCGanaa)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fupdating-your-settings&sa=D&sntz=1&usg=AOvVaw0hUh8L2m7ZKd3vUVCGanaa)</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 | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31) |  |  | [Profile](https://manual.patientsknowbest.com/patient/updating-your-settings)  
[Add carer](https://manual.patientsknowbest.com/patient/sharing#h.p_nQss3b23dGID) | [/v1/users](https://sandbox.patientsknowbest.com/api/index.html#!/Users/updateUser) |
| Read | [QRY A19](https://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19) | [/Patient](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | [Profile](https://manual.patientsknowbest.com/patient/updating-your-settings)  
[Sharing](https://manual.patientsknowbest.com/patient/sharing) | [/users/self](https://sandbox.patientsknowbest.com/api/index.html#!/Users/getUser)  
[/users/myCarers](https://sandbox.patientsknowbest.com/api/index.html#!/Users/getMyCarers)  
[/users/myPatients](https://sandbox.patientsknowbest.com/api/index.html#!/Users/getMyPatients)  
[/v1/users/[userId]](https://sandbox.patientsknowbest.com/api/index.html#!/Users/getUserById)  
[/v1/users/self/patients](https://sandbox.patientsknowbest.com/api/index.html#!/Users/getMyPatients_1)  
[/v2-beta/users/byNationalId/[nationalId]/[nationalIdType]](https://sandbox.patientsknowbest.com/api/index.html#!/Users/getNationalNumberByPatientId) |
| Update | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31) | [/Patient/$process-message](https://dev.patientsknowbest.com/home/fhir-api/operation/process-message) |  | [Profile](https://manual.patientsknowbest.com/patient/updating-your-settings) | [/v1/users](https://sandbox.patientsknowbest.com/api/index.html#!/Users/updateUser) |
| Delete |  |  |  |  |  |
| **Entity: Patient - Extends: ****[User](https://wiki.patientsknowbest.com/space/api/3752722465/Entity%3A+Organisation)** |
| **Middle Names** `String`<br>Any middle names of the patient. | [PID-5.3](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.name](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Address Line 1** `String`<br>First line of the address. | [PID-11.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.address](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Address Line 2** `String`<br>Second line of the address. | [PID-11.2](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.address](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **City** `String`<br>The nearest city or town. | [PID-11.3](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.address](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **State** `String`<br>The state. | [PID-11.4](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.address](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Country** `String`<br>The country. | [PID-11.6](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.address](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Postal Code** `String`<br>The postal code. | [PID-11.5](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.address](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Date of Birth** `Local Date`<br>Date of birth. | [PID-7.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.birthDate](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Death Timestamp** `Timestamp`<br>When the patient died. | [PID-29.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.deceased](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | A patient marked as deceased cannot log in. |  |
| **Gender** `Enum`<br>This is the administrative gender of the patient.<br>- UNKNOWN
- MALE
- FEMALE
- INDETERMINATE | [PID-8.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.gender](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Language** `Enum`<br>The primary language of the patient. | [PID-15.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-15.4](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) |  |  | Shown.<br>Also, a language dropdown is shown in the footer of every page. |  |
| **Time Zone** `Enum`<br>The patient's current preferred time zone. This will be used to localise times within the web interface. |  |  |  | Shown. |  |
| **Phone** `String`<br>The phone number of the patient. | [PID-13.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-14.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.telecom](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Status** `Enum`<br>The status of the patient. | [PID-30.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) |  |  | The status is not shown explicitly, but impacts other behaviour.<br>For example, a patient marked as deceased cannot log in. |  |
| **Notification Option** `Enum`<br>- ALL_EMAILS
- MAX_ONE_EMAIL_PER_DAY |  |  |  | Not shown. |  |
| **Registered** `Boolean`<br>Whether or not the patient has registered with PKB. If a patient is registered, they have the ability to log into their account. |  |  |  | A patient who is not registered cannot log in. |  |
| **Registered On** `Timestamp`<br>When the patient registered. |  |  |  | Not shown. |  |
| **Sharing Disabled** `Boolean`<br>Whether or not the [patient has requested Sharing Disabled](https://manual.patientsknowbest.com/patient/sharing#h.p_EASQwinXdzdB). |  | [sharing-disabled](http://fhir.patientsknowbest.com/structuredefinition/sharing-disabled) |  | A message is shown when sharing has been disabled. |  |
| **Access Frozen** `Boolean`<br>Whether or not [access to this medical record has been frozen](https://manual.patientsknowbest.com/professional/paediatric-records#h.p_px3B3qC1FWB_). |  |  |  | A patient whose access has been frozen cannot log in. |  |
| **Access Frozen Source Team** `Ref: [[Team]]`<br>The Team which froze this patient’s access. |  |  |  | A patient whose access has been frozen cannot log in. |  |
| **2FA State** `Enum`<br>- DISABLED
- INITIALIZED
- ACTIVE |  |  |  | This value is not shown directly, but is evident from the authentication experience. |  |
| **2FA Mandatory** `Boolean`<br>Whether or not 2FA is mandatory for this account. |  |  |  | This value is not shown directly, but is evident from the authentication experience. |  |
| **Entity: Contact** |
| **Type** `Enum`<br>- EMAIL_ADDRESS | [PID-13.2](https://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-14.2](https://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.telecom](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Value** `String`<br>The value of the contact information. | [PID-13.1](https://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-13.4](https://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-14.1](https://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-14.4](https://dev.patientsknowbest.com/home/hl7-api/segments/pid) | [Patient.telecom](http://fhir.patientsknowbest.com/structuredefinition/facade-patient) |  | Shown. |  |
| **Is Primary** `Boolean`<br>Indicates whether this is primary. For example, if a patient has several email addresses, exactly one must be designated as primary, and that will be the one that receives notifications from PKB. |  |  |  | Shown. |  |
| **Is Confirmed** `Boolean`<br>Indicates whether the contact has been confirmed. For example, a patient must confirm they have access to an email address by clicking a link before it is confirmed as belonging to them. |  |  |  | Shown. |  |