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

# Class Diagram

<u>[Consultation](https://miro.com/app/board/uXjVMNSp_XE=/?share_link_id=309740957983)</u>

# Display

Team Coordinators can manage Consultations from the "Consultations" tab. Patients can complete a Consultation from the Events & messages page.

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

# Solutions

PKB solutions related to this data type:

- [Advanced Questionnaires](https://wiki.patientsknowbest.com/space/api/3691937900/Advanced+Questionnaires)

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  |  |  |
| Read |  | [/Questionnaire](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364946445) |  |  |  |
| Update |  |  |  |  |  |
| Delete |  |  |  |  |  |
| **Entity: Consultation** |
| **Public ID** `String`<br>An ID for this Consultation. |  | [Questionnaire.id](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Name** `String`<br>A textual name for this Consultation. |  | [Questionnaire.title](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Creation Timestamp** `Timestamp`<br>When the Consultation was created. |  | [Questionnaire.date](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Privacy Label** `Enum`<br>- GENERAL_HEALTH
- MENTAL_HEALTH
- SEXUAL_HEALTH
- SOCIAL_CARE |  | [Questionnaire.meta.security](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Entity: Consultation Item** |
| **ID** `String`<br>An ID for this Consultation Item, unique only within this Consultation. |  | [Questionnaire.item.linkId](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Text** `String`<br>The text to display. |  | [Questionnaire.item.text](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Type** `Enum`<br>- TITLE
- TEXT
- RADIO
- CHECKBOX |  | [Questionnaire.item.type](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |
| **Entity: Consultation Item Option** |
| **Text** `String`<br>The value of the option. |  | [Questionnaire.item.option](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire) |  |  |  |


|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  | [$send-questionnaire-request](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012087) |  |  |  |
| Read |  | [/ProcedureRequest](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848105) |  |  |  |
| Update |  |  |  |  |  |
| Delete |  |  |  |  |  |
| **Entity: Consultation Request** |
| **Public ID** `String`<br>An ID for this Consultation Request. |  |  |  |  |  |
| **Request Timestamp** `Timestamp`<br>When the Consultation Request was created. |  |  |  |  |  |
| **External Identifier** `Identifier`<br>An externally specified identifier to identify this request. |  |  |  |  |  |


|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  |  |  |
| Read |  | [/QuestionnaireResponse](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364946477) |  |  |  |
| Update |  |  |  |  |  |
| Delete |  |  |  |  |  |
| **Entity: Consultation Response** |
| **Public ID** `String`<br>An ID for this Consultation Response. |  | [QuestionnaireResponse.id](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaireresponse) |  |  |  |
| **Request Timestamp** `Timestamp`<br>When the Consultation Response was requested. |  |  |  |  |  |
| **Completion Timestamp** `Timestamp`<br>When the Consultation Response was completed. |  | [QuestionnaireResponse.authored](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaireresponse) |  |  |  |
| **Entity: Consultation Response Item** |
| **Text** `String`<br>The value of the response. |  | [QuestionnaireResponse.item.answer](http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaireresponse) |  |  |  |