Class Diagram
Patient Consent & ContactOpt out
Display
Demographics appear Consent information appears in the Settings Sharing page of the patient's record.
Please seethe 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 | |||||
Read
Create |
/users/myPatients
/v1/users/[userId]
Read |
|
/v2-beta/users/byNationalId/[nationalId]/[nationalIdType]
Write
Update |
|
| |||
Delete | |||||
Entity: | |||||
Middle Names
String
Any middle names of the patient.
Profile page
Address Line 1
String
First line of the address.
Profile page
Address Line 2
String
Second line of the address.
Profile page
City
String
The nearest city or town.
Profile page
State
String
The state.
Profile page
Country
String
The country.
Profile page
Postal Code
String
The postal code.
Profile page
Date of Birth
Local Date
Date of birth.
Profile page
Death Timestamp
Timestamp
When the patient died.
Gender
Enum
This is the administrative gender of the patient.
UNKNOWN
MALE
FEMALE
INDETERMINATE
Profile page
Language
Enum
The primary language of the patient.
Language dropdown shown in the footer of every page.
Time Zone
Enum
The patient's current preferred time zone. This will be used to localise times within the web interface.
Profile page
Skype ID
String
How to contact the patient on Skype.
Profile page
Phone
String
The phone number of the patient.
Profile page
Status
Enum
The status of the patient.
Registered
Boolean
Whether or not the patient has registered with PKB. If a patient is registered, they have the ability to log into their account.
Sharing Disabled
Boolean
Whether or not the patient has requested Sharing Disabled.
Access Frozen
Boolean
Whether or not access to this medical record has been frozen.
Entered Timestamp
Timestamp
Flexibly used, depending on the type of data. It is broadly intended to capture the timestamp when the information was entered into the originating system.
Persisted Timestamp
Timestamp
The timestamp when the information was persisted in PKB.
Entity: Contact
Type
Enum
EMAIL_ADDRESS
Value
String
The value of the contact information.
Profile page
Is Primary
Boolean
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.
Profile page
Is Confirmed
Boolean
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.
Consent Record | |||||
Public ID An ID for this Consent Record. |
| Not shown. |
| ||
Aggregated ID Consent Records that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated. | Not shown. | ||||
Legacy ID An ID for this Consent Record. | Not shown. | id | |||
General Health Granted Whether or not the patient has granted access to the general health portion of their medical record. |
| Shown. | generalHealthConsentGranted | ||
Mental Health Granted Whether or not the patient has granted access to the mental health portion of their medical record. |
| Shown. | mentalHealthConsentGranted | ||
Sexual Health Granted Whether or not the patient has granted access to the sexual health portion of their medical record. |
| Shown. | sexualHealthConsentGranted | ||
Social Care Granted Whether or not the patient has granted access to the social care portion of their medical record. |
| Shown. | socialCareConsentGranted | ||
Discharged Indicates whether the actor is currently providing care to the patient. |
| 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 Indicates whether this Consent Record has been locked. See the manual on Paediatric Records for more information. | Shown. | ||||
Added When the Consent Record was first recorded. | Not shown. | ||||
Updated 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 | |||||
General Health Consent Granted | |||||
General Health Reason Code
| Patients are not required to provide a reason. Once provided, the value is not shown. | generalHealthConsentGrantedReason | |||
General Health Reason Text | Patients are not required to provide a reason. Once provided, the value is not shown. | generalHealthConsentGrantedReasonText | |||
Mental Health Consent Granted | |||||
Mental Health Reason Code 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 | Patients are not required to provide a reason. Once provided, the value is not shown. | mentalHealthConsentGrantedReasonText | |||
Sexual Health Consent Granted | |||||
Sexual Health Reason Code 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 | Patients are not required to provide a reason. Once provided, the value is not shown. | sexualHealthConsentGrantedReasonText | |||
Social Care Consent Granted | |||||
Social Care Reason Code 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 | Patients are not required to provide a reason. Once provided, the value is not shown. | socialCareConsentGrantedReasonText | |||
Professional Edit Only | |||||
Professional Edit Only Reason Text | |||||
| 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 Expiry Decision | |||||
ID An ID for this Consent Expiry Decision. | |||||
Patient Age Criterion The age in years to which this decision applies. | |||||
Expires | |||||
Entered By | |||||
Entered Date | |||||
Consent Deleted At | |||||
Reason 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 | |||||
Read | |||||
Update | |||||
Delete | |||||
Entity: Additional Consent | |||||
Option
| Shown. | ||||
Granted 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 | |||||
Read | |||||
Update | |||||
Delete | |||||
Entity: Patient Opt Out Record | |||||
Public ID An ID for this Consent Record. | |||||
Aggregated ID Consent Records that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated. | |||||
Sharing Enabled 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 | |||||
Read | |||||
Update | |||||
Delete | |||||
Entity: Patient Opt Out Documentation - Extends: Data Point | |||||
Sharing Enabled See [[Patient Opt Out Record.Sharing Enabled]] | |||||