Page Comparison

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

Please see the manual for more information.

	HL7 API	FHIR API		Web	Custom REST API
		Facade (STU3)	Aggregated (R4)
Summary of interactions
Read

QRY A19

/

PatientProfile

Consent

Sharing

/users/self
/users/myCarers

/users

/

myPatients
/

v1/

users/[userId]
/v1/users/self/patients
/v2-beta/users/byNationalId/[nationalId]/[nationalIdType

consents/byPatient/[patientId]
Write

Patient/$process-message

Profile
Add carer

/v1/users

v1/consents/forPatient/[patientId]
Delete
Entity:

Patient - Extends: UserMiddle Names

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

Consent
Public ID	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

An ID for this Consent Record.		Consent.id
Aggregated ID	String	Consent Records that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated.
Legacy ID	String	An ID for this Consent Record.
General Health Granted	Boolean	Whether or not the patient has granted access to the general health portion of their medical record.	Consent.except	Sharing
Mental Health Granted	Boolean	Whether or not the patient has granted access to the mental health portion of their medical record.	Consent.except	Sharing
Sexual Health Granted	Boolean	Whether or not the patient has granted access to the sexual health portion of their medical record.	Consent.except	Sharing
Social Care Granted	Boolean	Whether or not the patient has granted access to the social care portion of their medical record.	Consent.except	Sharing
Reason Code	Enum	MIGRATED CREATED_ACCOUNT REFERRAL POWER_OF_ATTORNEY COURT_ORDER EXPLICIT_CONSENT DISCHARGE SAFEGUARDING PATIENT_OPT_OUT
Reason Text	String	A description justifying why these consent values were set.
Discharged	Boolean	Indicates whether the actor is currently providing care to the patient.	Consent.status	Sharing
Professional Edit Only	Boolean	Indicates whether this Consent Record has been locked. See the manual on Paediatric Records for more information.		Sharing
Added	Timestamp	When the Consent Record was first recorded.
Updated	Timestamp	When the Consent Record was last updated.

			HL7 API	FHIR API		Web	Custom REST API
				Facade (STU3)	Aggregated (R4)
Summary of interactions
Read
Write
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		Web	Custom REST API
				Facade (STU3)	Aggregated (R4)
Summary of interactions
Read
Write
Delete
Entity: Patient Opt Out Documentation - Extends: Data Point
Sharing Enabled	Boolean	See [[Patient Opt Out Record.Sharing Enabled]]

Versions Compared

Old Version 1

New Version 2

Key

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Class Diagram

Display

Mappings