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

# Class Diagram

<u>[Organisation & Users](https://miro.com/app/board/uXjVMNUR7sM=/?share_link_id=985355055571)</u>

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API** | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Entity: Organisation** |
| **Public ID** `String`<br>An ID for this Organisation. |  | [Organization.id](http://fhir.patientsknowbest.com/structuredefinition/facade-organization) |  |  |  |
| **Aggregated ID** `String`<br>Organisations that have been exposed in the [Aggregated FHIR endpoint](https://wiki.patientsknowbest.com/space/api/3364388935) will have this additional ID populated. |  |  |  |  |  |
| **Legacy Organisation ID** `String`<br>An ID for this Organisation. |  |  |  |  |  |
| **Name** `String`<br>The name of this Organisation. |  | [Organization.name](http://fhir.patientsknowbest.com/structuredefinition/facade-organization) |  |  |  |
| **Code** `String`<br>A PKB-assigned identifier for this Organisation. |  |  |  |  |  |
| **Time Zone** `String`<br>The default time zone for time stamps from this Organisation. |  |  |  |  |  |
| **Active** `Boolean`<br>Whether this Organisation is currently using PKB. |  |  |  |  |  |
| **Type** `Enum`<br>- prov
- dept
- team
- govt
- ins
- pay
- edu
- reli
- crs
- cg
- bus
- other |  |  |  |  |  |
| **Entity: Team** |
| **Public ID** `String`<br>An ID for this Team. |  | [Organization.id](http://fhir.patientsknowbest.com/structuredefinition/facade-organization) |  |  |  |
| **Aggregated ID** `String`<br>Teams that have been exposed in the [Aggregated FHIR endpoint](https://wiki.patientsknowbest.com/space/api/3364388935) will have this additional ID populated. |  |  |  |  |  |
| **Legacy Team ID** `String`<br>An ID for this Team. |  |  |  |  |  |
| **Name** `String`<br>The name of this Team. |  | [Organization.name](http://fhir.patientsknowbest.com/structuredefinition/facade-organization) |  |  |  |
| **Code** `String`<br>A PKB-assigned identifier for this Team. |  |  |  |  |  |
| **Time Zone** `String`<br>The default time zone for time stamps from this Team. |  |  |  |  |  |


|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API** | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Entity: Person** |
| **Public ID** `String`<br>An ID for this Person. |  |  |  |  |  |
| **Entity: User** |
| **Legacy User ID** `String`<br>An ID for this User. |  |  |  |  |  |
| **Public ID** `String`<br>An ID for this User. | <u>For Patient</u>   
[PID-2.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[PID-3.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid)  
[ZID-1.1](http://dev.patientsknowbest.com/home/hl7-api/messages/qry-a19#TOC-QRY-A19:-Query-for-patient-registration-status) | <u>For Patient</u><br>[Patient.id](http://fhir.patientsknowbest.com/structuredefinition/facade-patient)<br><u>Else</u><br>[Practitioner.id](http://fhir.patientsknowbest.com/structuredefinition/facade-practitioner) |  |  |  |
| **Aggregated ID** `String`<br>Users that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated. |  |  |  |  |  |
| **Title** `String`<br>Title. | <u>For Patient</u><br>[PID-5.5](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | <u>For Patient</u><br>[Patient.name](http://fhir.patientsknowbest.com/structuredefinition/facade-patient)<br><u>Else</u><br>[Practitioner.name](http://fhir.patientsknowbest.com/structuredefinition/facade-practitioner) |  | Profile page |  |
| **Given Name** `String`<br>The first name of the User. | <u>For Patient</u><br>[PID-5.2](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | <u>For Patient</u><br>[Patient.name](http://fhir.patientsknowbest.com/structuredefinition/facade-patient)<br><u>Else</u><br>[Practitioner.name](http://fhir.patientsknowbest.com/structuredefinition/facade-practitioner) |  | Profile page  
Dashboard page |  |
| **Family Name** `String`<br>The last name of the User. | <u>For Patient</u><br>[PID-5.1](http://dev.patientsknowbest.com/home/hl7-api/segments/pid) | <u>For Patient</u><br>[Patient.name](http://fhir.patientsknowbest.com/structuredefinition/facade-patient)<br><u>Else</u><br>[Practitioner.name](http://fhir.patientsknowbest.com/structuredefinition/facade-practitioner) |  | Profile page  
Dashboard page |  |

Entity: Privacy Officer - Extends: User

No attributes.

Entity: Organisation Administrator - Extends: User

No attributes.

Entity: Team Coordinator - Extends: User

No attributes.

Entity: Professional - Extends: User

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API (Facade)** | **Custom REST API** | **Web (Patient)** |
| **Address Line 1** `String`<br>First line of the address. |  |  |  |  |
| **Address Line 2** `String`<br>Second line of the address. |  |  |  |  |
| **City** `String`<br>The nearest city or town. |  |  |  |  |
| **State** `String`<br>The state. |  |  |  |  |
| **Postal Code** `String`<br>The postal code. |  |  |  |  |
| **Date of Birth** `Local Date`<br>Date of birth. |  |  |  |  |
| **Phone** `String`<br>The phone number of the professional. |  |  |  |  |
| **Job Title** `String`<br>What the professional does. |  |  |  |  |
| **Email** `String`<br>The email address of the professional. |  |  |  |  |

Entity: Role

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| **Attribute** | **HL7 API** | **FHIR API (Facade)** | **Custom REST API** | **Web (Patient)** |
| **Public ID** `String`<br>An ID for this Role. |  |  |  |  |