Entity: Consent

Class Diagram

Display

Consent information appears in the Sharing page of the patient's record.

Please see the manual 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	/v1/consents/forPatient/[patientId]
Read		/Consent		Sharing	/v1/consents/byPatient/[patientId]
Update				Sharing	/v1/consents/forPatient/[patientId]
Delete
Entity: Consent Record
Public ID `String` An ID for this Consent Record.		Consent.id		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		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		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		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		Shown.	socialCareConsentGranted
Discharged `Boolean` Indicates whether the actor is currently providing care to the patient.		Consent.status		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.
Professional Edit Only `Boolean` Indicates whether this Consent Record has been locked. See the manual on Paediatric Records 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
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
Read				Sharing
Update				Sharing
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]
Read					/v1/consents/additional/forPatient/[id]
Update					/v1/consents/additional/forPatient/[id]
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
Read				Disable sharing
Update				Disable 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
Read				Disable sharing
Update				Disable sharing
Delete
Entity: Patient Opt Out Documentation - Extends: Data Point
Sharing Enabled `Boolean` See [[Patient Opt Out Record.Sharing Enabled]]