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		Web	Custom REST API
				Facade (STU3)	Aggregated (R4)
Summary of interactions
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]
Write			ADT A28 ADT A31	/Patient/$process-message		Profile Add carer	/v1/users
Delete
Entity: Patient
Middle Names	String	Any middle names of the patient.	PID-5.3	Patient.name		Profile page
Address Line 1	String	First line of the address.	PID-11.1	Patient.address		Profile page
Address Line 2	String	Second line of the address.	PID-11.2	Patient.address		Profile page
City	String	The nearest city or town.	PID-11.3	Patient.address		Profile page
State	String	The state.	PID-11.4	Patient.address		Profile page
Country	String	The country.	PID-11.6	Patient.address		Profile page
Postal Code	String	The postal code.	PID-11.5	Patient.address		Profile page
Date of Birth	Local Date	Date of birth.	PID-7.1	Patient.birthDate		Profile page
Death Timestamp	Timestamp	When the patient died.	PID-29.1	Patient.deceased
Gender	Enum	This is the administrative gender of the patient. UNKNOWN MALE FEMALE INDETERMINATE	PID-8.1	Patient.gender		Profile page
Language	Enum	The primary language of the patient.	PID-15.1 PID-15.4			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.	PID-13.1 PID-14.1	Patient.telecom		Profile page
Status	Enum	The status of the patient.	PID-30.1
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.		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.	MSH-7
Persisted Timestamp	Timestamp	The timestamp when the information was persisted in PKB.
Entity: Contact
Type	Enum	EMAIL_ADDRESS	PID-13.2 PID-14.2	Patient.telecom
Value	String	The value of the contact information.	PID-13.1 PID-13.4 PID-14.1 PID-14.4	Patient.telecom		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.				Profile page