Entity: Patient

Class Diagram

Display

Demographics appear in the Settings 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	A28/A31			Profile Add carer	/v1/users
Read	QRY A19	/Patient		Profile Sharing	/users/self /users/myCarers /users/myPatients /v1/users/[userId] /v1/users/self/patients /v2-beta/users/byNationalId/[nationalId]/[nationalIdType]
Update	A28/A31	/Patient/$process-message		Profile	/v1/users
Delete
Entity: Patient - Extends: User
Middle Names `String` Any middle names of the patient.	PID-5.3	Patient.name		Shown.
Address Line 1 `String` First line of the address.	PID-11.1	Patient.address		Shown.
Address Line 2 `String` Second line of the address.	PID-11.2	Patient.address		Shown.
City `String` The nearest city or town.	PID-11.3	Patient.address		Shown.
State `String` The state.	PID-11.4	Patient.address		Shown.
Country `String` The country.	PID-11.6	Patient.address		Shown.
Postal Code `String` The postal code.	PID-11.5	Patient.address		Shown.
Date of Birth `Local Date` Date of birth.	PID-7.1	Patient.birthDate		Shown.
Death Timestamp `Timestamp` When the patient died.	PID-29.1	Patient.deceased		A patient marked as deceased cannot log in.
Gender `Enum` This is the administrative gender of the patient. UNKNOWN MALE FEMALE INDETERMINATE	PID-8.1	Patient.gender		Shown.
Language `Enum` The primary language of the patient.	PID-15.1 PID-15.4			Shown. Also, a language dropdown is 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.				Shown.
Phone `String` The phone number of the patient.	PID-13.1 PID-14.1	Patient.telecom		Shown.
Status `Enum` The status of the patient.	PID-30.1			The status is not shown explicitly, but impacts other behaviour. For example, a patient marked as deceased cannot log in.
Notification Option `Enum` ALL_EMAILS MAX_ONE_EMAIL_PER_DAY				Not shown.
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.				A patient who is not registered cannot log in.
Registered On `Timestamp` When the patient registered.				Not shown.
Sharing Disabled `Boolean` Whether or not the patient has requested Sharing Disabled.		sharing-disabled		A message is shown when sharing has been disabled.
Access Frozen `Boolean` Whether or not access to this medical record has been frozen.				A patient whose access has been frozen cannot log in.
Access Frozen Source Team `Ref: [[Team]]` The Team which froze this patient’s access.				A patient whose access has been frozen cannot log in.
2FA State `Enum` DISABLED INITIALIZED ACTIVE				This value is not shown directly, but is evident from the authentication experience.
2FA Mandatory `Boolean` Whether or not 2FA is mandatory for this account.				This value is not shown directly, but is evident from the authentication experience.
Entity: Contact
Type `Enum` EMAIL_ADDRESS	PID-13.2 PID-14.2	Patient.telecom		Shown.
Value `String` The value of the contact information.	PID-13.1 PID-13.4 PID-14.1 PID-14.4	Patient.telecom		Shown.
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.				Shown.
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.				Shown.