---
title: "Entity: Consent"
canonical: "https://wiki.patientsknowbest.com/space/api/3750297601/Entity%3A%20Consent"
format: markdown
---
> Macro (toc)
# Class Diagram
[Consent & Opt out](https://miro.com/app/board/uXjVMNTdobM=/?share_link_id=656742452724)
# Display
Consent information appears in the Sharing 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)[the manual](https://manual.patientsknowbest.com/patient/sharing) for more information.
# Mappings
| | | | | |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**
(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
| | | **Facade (STU3)** | **Aggregated (R4)** | | |
| **Summary of interactions** |
| Create | | | | [Sharing](https://manual.patientsknowbest.com/patient/sharing) | [/v1/consents/forPatient/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Consent/setConsentsByPatientId_1) |
| Read | | [/Consent](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | [Sharing](https://manual.patientsknowbest.com/patient/sharing) | [/v1/consents/byPatient/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Consent/getConsentsByPatientId_1) |
| Update | | | | [Sharing](https://manual.patientsknowbest.com/patient/sharing) | [/v1/consents/forPatient/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Consent/setConsentsByPatientId_1) |
| Delete | | | | | |
| **Entity: Consent Record** |
| **Public ID** `String`
An ID for this Consent Record. | | [Consent.id](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | Not shown. | |
| **Aggregated ID** `String`
Consent Records that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated. | | | | Not shown. | |
| **Legacy ID** `String`
An ID for this Consent Record. | | | | Not shown. | id |
| **General Health Granted** `Boolean`
Whether or not the patient has granted access to the general health portion of their medical record. | | [Consent.except](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | Shown. | generalHealthConsentGranted |
| **Mental Health Granted** `Boolean`
Whether or not the patient has granted access to the mental health portion of their medical record. | | [Consent.except](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | Shown. | mentalHealthConsentGranted |
| **Sexual Health Granted** `Boolean`
Whether or not the patient has granted access to the sexual health portion of their medical record. | | [Consent.except](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | Shown. | sexualHealthConsentGranted |
| **Social Care Granted** `Boolean`
Whether or not the patient has granted access to the social care portion of their medical record. | | [Consent.except](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | Shown. | socialCareConsentGranted |
| **Discharged** `Boolean`
Indicates whether the actor is currently providing care to the patient. | | [Consent.status](http://fhir.patientsknowbest.com/structuredefinition/facade-consent) | | When true, the relevant entries are shown in the Past sharing section.
A patient can “discharge” themselves from individual professionals or carers, but only a professional can [discharge a patient from a team](https://manual.patientsknowbest.com/professional/how-to-discharge-a-patient). | |
| **Professional Edit Only** `Boolean`
Indicates whether this Consent Record has been locked. See the [manual on Paediatric Records](https://manual.patientsknowbest.com/professional/paediatric-records#h.p_g0uKIqJzFdwm) for more information. | | | | Shown. | |
| **Added** `Timestamp`
When the Consent Record was first recorded. | | | | Not shown. | |
| **Updated** `Timestamp`
When the Consent Record was last updated. | | | | Not shown. | |
| | | | | |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**
(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
| | | **Facade (STU3)** | **Aggregated (R4)** | | |
| **Summary of interactions** |
| Create | | | | | |
| Read | | | | | |
| Update | | | | | |
| Delete | | | | | |
| **Entity: Consent Reason - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Event Text** `String` | | | | | |
| **General Health Consent Granted** `Boolean` | | | | | |
| **General Health Reason Code** `Enum`
- MIGRATED
- CREATED_ACCOUNT
- REFERRAL
- POWER_OF_ATTORNEY
- COURT_ORDER
- EXPLICIT_CONSENT
- DISCHARGE
- SAFEGUARDING
- PATIENT_OPT_OUT
- EXPIRED | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | generalHealthConsentGrantedReason |
| **General Health Reason Text** `String` | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | generalHealthConsentGrantedReasonText |
| **Mental Health Consent Granted** `Boolean` | | | | | |
| **Mental Health Reason Code** `Enum`
As for General Health Reason Code. | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | mentalHealthConsentGrantedReason |
| **Mental Health Reason Text** `String` | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | mentalHealthConsentGrantedReasonText |
| **Sexual Health Consent Granted** `Boolean` | | | | | |
| **Sexual Health Reason Code** `Enum`
As for General Health Reason Code. | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | sexualHealthConsentGrantedReason |
| **Sexual Health Reason Text** `String` | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | sexualHealthConsentGrantedReasonText |
| **Social Care Consent Granted** `Boolean` | | | | | |
| **Social Care Reason Code** `Enum`
As for General Health Reason Code. | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | socialCareConsentGrantedReason |
| **Social Care Reason Text** `String` | | | | Patients are not required to provide a reason.
Once provided, the value is not shown. | socialCareConsentGrantedReasonText |
| **Professional Edit Only** `Boolean` | | | | | |
| **Professional Edit Only Reason Text **`String` | | | | | |
| | | | | |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**
(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
| | | **Facade (STU3)** | **Aggregated (R4)** | | |
| **Summary of interactions** |
| Create | | | | [Sharing](https://manual.patientsknowbest.com/professional/paediatric-records#h.xlkbwjwsg5zp) | |
| Read | | | | [Sharing](https://manual.patientsknowbest.com/professional/paediatric-records#h.xlkbwjwsg5zp) | |
| Update | | | | [Sharing](https://manual.patientsknowbest.com/professional/paediatric-records#h.xlkbwjwsg5zp) | |
| Delete | | | | | |
| **Entity: Consent Expiry Decision** |
| **ID** `String`
An ID for this Consent Expiry Decision. | | | | | |
| **Patient Age Criterion** `Number`
The age in years to which this decision applies. | | | | | |
| **Expires **`Boolean` | | | | | |
| **Entered By **`Ref: [[User.Legacy User ID]]` | | | | | |
| **Entered Date **`Timestamp` | | | | | |
| **Consent Deleted At **`Timestamp` | | | | | |
| **Reason** `String`
Justification for why this decision was made. | | | | | |
| | | | | |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**
(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
| | | **Facade (STU3)** | **Aggregated (R4)** | | |
| **Summary of interactions** |
| Create | | | | | [/v1/consents/additional/forPatient/[id]](https://sandbox.patientsknowbest.com/api/index.html#!/Consent/setAdditionalConsentsByPatientId_1) |
| Read | | | | | [/v1/consents/additional/forPatient/[id]](https://sandbox.patientsknowbest.com/api/index.html#!/Consent/getAdditionalConsentsByPatientId_1) |
| Update | | | | | [/v1/consents/additional/forPatient/[id]](https://sandbox.patientsknowbest.com/api/index.html#!/Consent/setAdditionalConsentsByPatientId_1) |
| Delete | | | | | |
| **Entity: Additional Consent** |
| **Option** `Enum`
- CONTACT_BY_EMAIL
- CONTACT_BY_SMS
- CONTACT_BY_POST
- CONTACT_FOR_RESEARCH
- SAMPLE_STORAGE | | | | Shown. | |
| **Granted **`Boolean`
Whether or not the patient has granted this option. | | | | Shown. | |
| | | | | |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**
(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
| | | **Facade (STU3)** | **Aggregated (R4)** | | |
| **Summary of interactions** |
| Create | | | | [Disable sharing](https://manual.patientsknowbest.com/privacy-officer/disabled-sharing) | |
| Read | | | | [Disable sharing](https://manual.patientsknowbest.com/privacy-officer/disabled-sharing) | |
| Update | | | | [Disable sharing](https://manual.patientsknowbest.com/privacy-officer/disabled-sharing) | |
| Delete | | | | | |
| **Entity: Patient Opt Out Record** |
| **Public ID** `String`
An ID for this Consent Record. | | | | | |
| **Aggregated ID** `String`
Consent Records that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated. | | | | | |
| **Sharing Enabled **`Boolean`
Indicates whether or not the patient has enabled sharing. If the patient has not opted out then a Patient Opt Out Record might not exist. A patient who has opted out might change their mind and choose to opt in again. | | | | | |
| | | | | |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**
(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
| | | **Facade (STU3)** | **Aggregated (R4)** | | |
| **Summary of interactions** |
| Create | | | | [Disable sharing](https://manual.patientsknowbest.com/privacy-officer/disabled-sharing) | |
| Read | | | | [Disable sharing](https://manual.patientsknowbest.com/privacy-officer/disabled-sharing) | |
| Update | | | | [Disable sharing](https://manual.patientsknowbest.com/privacy-officer/disabled-sharing) | |
| Delete | | | | | |
| **Entity: Patient Opt Out Documentation - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Sharing Enabled** `Boolean`
See [[Patient Opt Out Record.Sharing Enabled]] | | | | | |