Data Model

Overview

Data Types

Common Entities

Administrative Entities

Clinical Entities

Attachment

Data Point

Source

Version Details

Organisation & Users

Patient & Contact

Identifiers

Allergy

Appointment

Care Plan

Consultation

Conversation

Diagnosis

Document

Encounter

Journal Entry

Lab Report

Measurement

Medication

Radiology Report

Symptom

This Data Model is currently in draft.

This data model is intended to provide a high level overview of what a PKB medical record looks like. Rather than trying to show the entire model in one diagram, partial illustrations are given below that each take one topic as their focus.

Name	Description
String	A textual value.
Local Date	A date. It contains no time information, and time zone processing is not applied.
Timestamp	A point in time with both date and time information. The point in time is evaluated within a time zone, and hence can be meaningfully displayed in an alternative time zone.
Number	A numerical value that can have a real value, i.e. not necessarily an integer.
Enum	A value that can only contain one of a predefined enumeration of values.
Boolean	A value that is either true or false.
Binary	Raw data. For example, the contents of an uploaded file.
Ref	A value which references an attribute in another entity. The data type will match that of the referenced attribute.
Coding	A compound value. Consists of: Code Code System Display Text
CodeableConcept	A compound value. Consists of: Display Text 0 or more Coding attributes
Identifier	A compound value. Consists of: System Value

Entity: Attachment

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/attachments/[id]	Various, depending on data type
Write			MDM T02/document ORU R01/radiology			Various, depending on data type
Attributes
Public ID	String	The ID of the attachment.
Filename	String	The filename of the attachment.	OBX-3.2 (ORU R01/radiology) OBX-3.5 (ORU R01/radiology) TXA-16.1 (MDM T02/document)			Various, depending on data type
Content	Binary	The content of the attachment.	OBX-5.5 (ORU R01/radiology) OBX-5.5 (MDM T02/document)		Returned in the download stream	Various, depending on data type
Media Type	String	The type of media contained in the content.	OBX-5.3 (ORU R01/radiology)

Entity: Data Point

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Identifiers
Data Point ID	String	A unique ID identifying this data point. This ID will not change even if the data point is modified.
Aggregated Data Point ID	String	Data Points that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated.
External Data Point ID	String	The ID assigned to this data point by the source system.	ORC-3.1 (ORU R01/radiology) OBR-3.1 (ORU R01/radiology) TXA-12.1 (MDM T02/care plan) TXA-12.1 (MDM T02/document) SCH-1.1 (SIU)	DocumentReference.identifier
Legacy Data Point ID	String	A unique ID for this version of this data point. This ID will change when the data point is updated.
Timestamps
Entered Timestamp	Timestamp	Flexibly used, depending on the type of data. It is broadly intended to capture the timestamp when the data point was entered into the originating system.	MSH-7 (ORU R01/lab) TXA-4.1 (MDM T02/document) TXA-6.1 (MDM T02/document) TXA-7.1 (MDM T02/document) TXA-8.1 (MDM T02/document)
Persisted Timestamp	Timestamp	The timestamp when the data point was persisted in PKB.
Other
Privacy Label	Enum	GENERAL_HEALTH MENTAL_HEALTH SEXUAL_HEALTH SOCIAL_CARE		meta.security Cosent.except.securityLabel		Various, depending on data type
Specialty	String	The specialty associated with the data point.	PV1-10.1	specialty		Various, depending on data type

Entity: Source

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Source Organisation	Ref : [[Organisation.Public ID]]	The organisation which created the data point.	This is derived from the HL7 connection. See here for more information.	source-organisation search param: source-organisation		Various, depending on data type
Source Team	Ref : [[Team.Public ID]]	The team which created the data point.	This is derived from the HL7 connection. See here for more information.	source-team		Various, depending on data type
Source Person	Ref : [[User.Public ID]]	The PKB user who created the data point.	This value is never set for data sent via HL7.	source-person		Various, depending on data type
Source Text	String	Other source information that does not fit into one of the other source attributes.	NTE-5 (ADT A28) DG1-16 (ADT A28) ZRX-13 (ADT A28) OBR-16 (ORU R01) TXA-5 (MDM T02/care plan)			Various, depending on data type
Connecting Organisation	Ref: [[Organisation.Public ID]]	The organisation which connected to PKB in order to send the data point. Currently, this cannot differ from the Source Organisation.	This is derived from the HL7 partner information.			Various, depending on data type
HL7 Partner	Ref : [[HL7 Partner.Public ID]]	The HL7 Partner which delivered the data.	Identified automatically from the authenticated connection.			Various, depending on data type
Responsible Organisation Identifier	String	An identifier for the organisation responsible for the data point.	MSH-22.10			Various, depending on data type
Access Route	Enum	Represents the route used to access the PKB system when writing the data point. For example, this can be used to differentiate between data that was entered manually in the web interface from data added by an API.				Various, depending on data type
Uploaded Data ID	String	The message which led to this data point.

Entity: HL7 Partner

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this HL7 Partner.
Name	String	The name of this HL7 Partner.				Various, depending on data type

Entity: Version Details

This entity is typically used to capture meta information about non-clinical entities, i.e. entities which do not have Data Point or Source object.

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Source Organisation	Ref : [[Organisation.Public ID]]	The organisation which created the data.
Source Team	Ref : [[Team.Public ID]]	The team which created the data.
Source Person	Ref : [[User.Public ID]]	The PKB user who created the data.
Source Text	String	Other source information that does not fit into one of the other source attributes.
HL7 Partner	Ref : [[HL7 Partner.Public ID]]	The HL7 Partner which delivered the data.
Responsible Organisation Identifier	String	An identifier for the organisation responsible for the data.
Access Route	Enum	Represents the route used to access the PKB system when writing the data. For example, this can be used to differentiate between data that was entered manually in the web interface from data added by an API.
Entered Timestamp	Timestamp	Flexibly used, depending on the type of data. It is broadly intended to capture the timestamp when the data was entered into the originating system.
Created Timestamp	Timestamp	When the data was first created.
Persisted Timestamp	Timestamp	When this version of the data was persisted.

Class Diagram

Organisation & Users

Entity: Organisation

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this Organisation.		Organization.id
Name	String	The name of this Organisation.		Organization.name

Entity: Team

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this Team.		Organization.id
Name	String	The name of this Team.		Organization.name

Entity: Person

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this Person.

Entity: User

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Legacy User ID	String	An ID for this User.
Public ID	String	An ID for this User.	For Patient PID-2.1 PID-3.1 ZID-1.1	For Patient Patient.id Else Practitioner.id
Title	String	Title.	For Patient PID-5.5	For Patient Patient.name Else Practitioner.name		Profile page
Given Name	String	The first name of the User.	For Patient PID-5.2	For Patient Patient.name Else Practitioner.name		Profile page Dashboard page
Family Name	String	The last name of the User.	For Patient PID-5.1	For Patient Patient.name Else Practitioner.name		Profile page Dashboard page

Entity: Privacy Officer - Extends: User

No attributes.

Entity: Organisation Administrator - Extends: User

No attributes.

Entity: Team Coordinator - Extends: User

No attributes.

Entity: Professional - Extends: User

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Address Line 1	String	First line of the address.
Address Line 2	String	Second line of the address.
City	String	The nearest city or town.
State	String	The state.
Postal Code	String	The postal code.
Date of Birth	Local Date	Date of birth.
Phone	String	The phone number of the professional.
Job Title	String	What the professional does.
Email	String	The email address of the professional.

Entity: Role

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this Role.

Class Diagram

Patient & Contact

Display

Demographics appear in the Settings page of the patient's record.

Please see the manual for more information.

Entity: Patient - Extends: User

Patient

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read			QRY A19	/Patient	/users/self /users/myCarers /users/myPatients /v1/users/[userId] /v1/users/self/patients /v2-beta/users/byNationalId/[nationalId]/[nationalIdType]	Profile Sharing
Write			ADT A28 ADT A31	/Patient/$process-message	/v1/users	Profile Add carer
Attributes
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

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
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

Class Diagram

Consent and Opt Out

Entity: Consent Record

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read				/Consent	/v1/consents/byPatient/[patientId]	Sharing
Write					/v1/consents/forPatient/[patientId]	Sharing
Attributes
Public ID	String	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.

Entity: Patient Opt Out Record

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read
Write
Attributes
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.

Entity: Patient Opt Out Documentation - Extends: Data Point

Class Diagram

Identifiers

Entity: National ID

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Value	String	The value of the ID.	PID-2.1 PID-3.1 QRD-8.1 PID-4.1 / ADR A19	Patient.identifier		Profile page

Entity: National ID Type

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Name	String	The name of this specific ID type.				Profile page
Country Codes	Enum	Each National ID Type is associated with one or more countries.
HL7 Assigning Authority	String	This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the assigning authority must match this value.	PID-2.4 PID-3.4 PID-4.4 / ADR A19
HL7 Type Code	String	This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the type code must match this value.	PID-2.5 PID-3.5 PID-4.5 / ADR A19
FHIR Identifier System	String	Used by the FHIR API to indicate that an identifier belongs to this National ID Type.		Patient.identifier

Entity: Local ID

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Value	String	The value of the ID.	PID-2.1 PID-3.1 QRD-8.1 PID-4.1 / ADR A19	Patient.identifier		Profile page

Entity: Local ID Type

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	The ID of the Local ID Type.		Patient.identifier
Name	String	The name of this specific ID type, to help distinguish between several. For example, Hospital XYZ ID.				Profile page
HL7 Assigning Authority	String	This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the assigning authority must match this value.	PID-2.4 PID-3.4 PID-4.4 / ADR A19
HL7 Type Code	String	This is only used by the HL7 API. When receiving an ID of this type in an HL7 message, the type code must match this value.	PID-2.5 PID-3.5 PID-4.5 / ADR A19

Entity: Organisation Level ID - Extends: Local ID

No attributes.

Entity: Organisation Level ID Type - Extends: Local ID Type

No attributes.

Entity: Team Level ID - Extends: Local ID

No attributes.

Entity: Team Level ID Type - Extends: Local ID Type

No attributes.

Entity: Country

No attributes.

Class Diagram

Allergy

Display

Allergies appear in the Health > Allergies page of the patient's record.

Please see the manual for more information.

Entity: Allergy - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/v2-beta/allergies/forPatient/[patientId]	Allergies
Write			ADT A28 ADT A31			Allergies
Attributes
Allergen	CodeableConcept	The allergen.	AL1-3		ApiAllergy.substanceCode	Allergy listing page Allergy details page
Onset Timestamp	Timestamp	When the symptoms began.	AL1-6.1		ApiAllergy.onsetOfSymptoms	Allergy listing page Allergy details page
Reactions	CodeableConcept List	The reactions to the allergen.	AL1-5.1		ApiAllergy.reactions	Allergy listing page Allergy details page
Severity	CodeableConcept	How severe the reaction to the allergen is.	AL1-4		ApiAllergy.severity	Allergy listing page Allergy details page

Class Diagram

Appointment

Display

Appointments appear in the Diary > Calendar page of the patient's record.

Please see the manual for more information.

Entity: Appointment - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read				/Appointment		Appointments
Write			SIU S12 /S13 /S14 /S15 /S26 ADT A05 /A14 /A27 /A38			Appointments
Attributes
Type	Coding	The type of appointment.	SCH-8 ZSC-8			Appointment details page
Start Timestamp	Timestamp	When the appointment starts.	SCH-11.4 EVN-3.1 (ADT) PV1-44.1 (ADT) PV2-8.1 (ADT)	Appointment.start		Appointment listing page Appointment details page
End Timestamp	Timestamp	When the appointment ends.	SCH-11.5	Appointment.end		Appointment details page
Subject	String	A brief reason for the appointment.	SCH-7.2 PV1-2.1 (ADT)	Appointment.reason		Appointment listings page Appointment details page
Description	String	A longer explanation of the appointment.	NTE-3.1 (SIU)	Appointment.comment		Appointment details page
Location	String	Where the appointment is to be held.	PV1-3.9 (SIU) PV1-3.9 (ADT)	Appointment.participant		Appointment details page
Status	Enum	ACTIVE CANCELLED DNA	SIU	Appointment.status		Appointment listings page
External Management URL	String	A deep link URL to an external appointment interface, where this appointment can be managed.	SIU			The presence of a link will enable the “Manage” option.

Entity: Appointment Participant

Attribute

Type

Description

HL7 API

FHIR API (Facade)

Custom REST API

Web (Patient)

User Public ID

Ref :
[[User.Public ID]]

The PKB user who is participating in the appointment.

When appointments are created via the HL7 API, the patient will be added as the only Appointment Participant.

Use the AIP segment to add External Appointment Participants; the names of these attendees will be added to the Appointment without any link to a PKB User.

Appointment.participant

Appointment details page

Status

Enum

ACCEPTED

The status is always Accepted.

Appointment.participant

The status is always Accepted.

Entity: External Appointment Participant

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Name	String	The name of the participant (optionally including their role).	AIP-3 AIP-4	Appointment.participant

Class Diagram

Care Plan

Display

Care Plans appear in the Treatment > Plans page of the patient's record.

Please see the manual for more information.

Entity: Care Plan - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/v2-beta/careplans/[patientId] /treatmentPlans/forPatient/[id] /v1/treatmentPlans/mine	Plans
Write			MDM T02/care plan		/v1/treatmentPlans	Plans
Attributes
Name	String	The name of the care plan.	OBX-3.2 (MDM T02/care plan) OBX-3.5 (MDM T02/care plan)			Care plan listing page Care plan details page
Created Timestamp	Timestamp	The timestamp when the care plan was first created.	TXA-4.1 (MDM T02/care plan)			Care plan listing page Care plan details page
Last Edited Timestamp	Timestamp	The timestamp when the care plan was last edited.	TXA-4.1 (MDM T02/care plan)			Care plan listing page Care plan details page
Action Plan	String or Binary	The main body of the care plan. This can be plaintext, HTML or a PDF file.	OBX-5.5 (MDM T02/care plan)			Care plan details page
Green	String	An explanation of what to expect when the condition is under control.				Care plan details page
Amber	String	An explanation of what might need attention.				Care plan details page
Red	String	An explanation of what needs urgent attention.				Care plan details page

Entity: Care Plan Template

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
ID	String	An ID for this template.
Status	Enum	ACTIVE INDRAFT INACTIVE

Entity: Care Plan Metric

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
ID	String	An ID for this metric.
Type	Enum	LAB_TEST MEASUREMENT SYMPTOM
Name	String	A display name for the metric.
Data Type ID	String	An identifier which uniquely identifies the specific data type instance. For example, this would be the ID of the relevant LOINC test entry for a metric type of LAB_TEST.

Class Diagram

Consultation

Display

Team Coordinators can manage Consultations from the "Consultations" tab. Patients can complete a Consultation from the Events & messages page.

Please see the manual for more information.

Entity: Consultation

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this Consultation.		Questionnaire.id
Name	String	A textual name for this Consultation.		Questionnaire.title
Creation Timestamp	Timestamp	When the Consultation was created.		Questionnaire.date
Privacy Label	Enum	GENERAL_HEALTH MENTAL_HEALTH SEXUAL_HEALTH SOCIAL_CARE		Questionnaire.meta.security

Entity: Consultation Item

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
ID	String	An ID for this Consultation Item, unique only within this Consultation.		Questionnaire.item.linkId
Text	String	The text to display.		Questionnaire.item.text
Type	Enum	TITLE TEXT RADIO CHECKBOX		Questionnaire.item.type

Entity: Consultation Item Option

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Text	String	The value of the option.		Questionnaire.item.option

Entity: Consultation Request

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read				/ProcedureRequest
Write				$send-questionnaire-request
Public ID	String	An ID for this Consultation Request.
Request Timestamp	Timestamp	When the Consultation Request was created.
External Identifier	Identifier	An externally specified identifier to identify this request.

Entity: Consultation Response

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Public ID	String	An ID for this Consultation Response.		QuestionnaireResponse.id
Request Timestamp	Timestamp	When the Consultation Response was requested.
Completion Timestamp	Timestamp	When the Consultation Response was completed.		QuestionnaireResponse.authored

Entity: Consultation Response Item

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Text	String	The value of the response.		QuestionnaireResponse.item.answer

Class Diagram

Conversation

Display

Conversations appear in the Events & messages page of a patient's record.

Please see the manual for more information.

Entity: Conversation

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Conversation ID	String	A unique ID identifying this conversation. This ID will not change even if the conversation is modified.		conversation-id

Entity: Message - Extends: Data Point

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Timestamp	Timestamp	When the message was sent.		Communication.sent		Conversation page
Subject	String	A brief description of what the message is about.		communication-title		Inbox page Conversation page
Content	String	The content of the message.				Conversation page
Sender	Ref : [[User.Public ID]]	The PKB user who sent the message.		Communication.sender
Private	Boolean	Whether or not the message is available to non-participants. Note: This is a legacy feature. Messages can no longer be marked as private.
Status	Enum	DRAFT SENT UNREAD READ

Entity: Recipient

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
User Public ID	Ref : [[User.Public ID]]	A PKB user who received the message.		Communication.recipient		Conversation page

Class Diagram

Diagnosis

Display

Diagnoses appear in the Health > Diagnosis page of the patient's record.

Please see the manual for more information.

Entity: Diagnosis - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/v2-beta/diagnoses/forPatient/[patientId]	Diagnoses
Write			ADT A28 ADT A31			Diagnoses
Attributes
Diagnosis	CodeableConcept	The diagnosis.	DG1-3		ApiDiagnosis.diagnosis	Diagnosis listing page Diagnosis details page
Start Timestamp	Timestamp	When the condition began.	DG1-5.1		ApiDiagnosis.startDate	Diagnosis listing page Diagnosis details page
End Timestamp	Timestamp	When the condition ended.			ApiDiagnosis.endDate	Diagnosis listing page Diagnosis details page
Details	String	Additional information about this diagnosis.			ApiDiagnosis.details	Diagnosis details page
Status	Enum	ACTIVE INACTIVE
Date Asserted	Timestamp

Class Diagram

Document

Display

Documents appear in the Events & messages page of a patient's record.

Please see the manual for more information.

Entity: Document - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read				/DocumentReference		Events & messages
Write			MDM T02/document
Attributes
Class	Enum	IN_PATIENT OUT_PATIENT AMBULATORY EMERGENCY HOME FIELD DAYTIME VIRTUAL OTHER	PV1-2.1 (MDM T02/document)			Inbox page Conversation page
Timestamp	Timestamp	The document timestamp.	TXA-8,7,6,4	DocumentReference.created		Conversation page
Document Type	Enum	ADMISSION_TCI_LETTER ALERT_NOTIFICATION APPOINTMENT_LETTER BIRTH_REPORT CLINIC_LETTER DISCHARGE_LETTER DISCHARGE_SUMMARY MULTI_DISCIPLINARY_TEAM_MEETING_NOTES REFERRAL_LETTER	TXA-2.1 (MDM T02/document)	DocumentReference.type
Status	Enum	READ UNREAD		document-status search param: document-status
Planned Postal Date	Timestamp	When this document would need to be posted. This field forms part of the Mail Management workflow.	ZPM-1
Delay	Number	The number of days for which the content of the data point should be hidden from the patient and carers.	OBX-13 (MDM T02/document)			Conversation page A placeholder is shown to the patient and carers, letting them know when the content will be displayed.

Class Diagram

Encounter

Display

Encounters appear in the Events & messages page of a patient's record.

Please see the manual for more information.

Entity: Encounter

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Encounter ID	String	A unique ID identifying this encounter. This ID will not change even if the encounter is modified.		Encounter.id
External Encounter ID	String	The ID assigned to this encounter by the source system.	PV1-19.1 (ADT)

Entity: Encounter Event - Extends: Data Point

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Type	Enum	PRE_ADMIT PENDING_ADMIT ADMIT TRANSFER DISCHARGE UPDATE
Class	Enum	IN_PATIENT OUT_PATIENT AMBULATORY EMERGENCY HOME FIELD DAYTIME VIRTUAL OTHER	PV1-2.1 (ADT)	Encounter.class Encounter.classHistory		Inbox page Conversation page
Timestamp	Timestamp	The relevant timestamp will vary depending on the type of message. For HL7 ADT messages this will normally be the timestamp of the relevant event.	PV1-44.1 (ADT) EVN-3.1 (ADT) EVN-6.1 (ADT) PV1-45.1 (ADT) PV2-8.1 (ADT)	Encounter.period		Conversation page

Entity: Location

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Name	String	The name.
Description	String	A brief description.	PV1-3.9 (ADT)	Encounter.location		Conversation page
Address	String	The address.

Entity: External Participant

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Role	Enum	ATTENDER REFERRER CONSULTANT		Encounter.participant		Conversation page
Name	String	The name of the participant.	PV1-7 (ADT) PV1-8 (ADT) PV1-9 (ADT)	Encounter.participant		Conversation page

Class Diagram

Journal Entry

Display

Journal entries appear in the Diary > Journal page of a patient's record.

Please see the manual for more information.

Entity: Journal Entry - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read						Journal
Write					/v1/journal	Journal
Attributes
Subject	String	What the entry is about.
Entry	String	The content of the entry.

Class Diagram

Lab Report

Display

Test results appear in the Health > Laboratory page of the patient's record.

Please see the manual for more information.

Entity: Lab Report

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
External ID	String	An ID provided by the sender. This ID allows a sender to modify the data point.	ORC-3.1 (ORU R01/lab) OBR-3.1 (ORU R01/lab)
Enterer Location	String	A description of the location of the person who entered the request.	ORC-13.9 (ORU R01/lab)
Received Timestamp	Timestamp	When the lab received the specimen.	OBR-14 (ORU R01/lab)
Discipline	String	The diagnostic service.	OBR-24 (ORU R01/lab)

Entity: Lab Result - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read				/Observation	/v1/tests/results/forPatient/byTestIds /v2-beta/tests/results	Tests
Write			ORU R01/lab			Tests
Attributes
Service	String	The overarching service of the lab results.	OBR-4.2 (ORU R01/lab) OBR-4.5 (ORU R01/lab)			Lab result listings page
Test Code	String	The code of the test that was performed. This captures the raw value as provided by the input source, for example from an HL7 message. It is not populated when the user enters a result directly into the PKB web UI, which asks them to select a type from a dropdown.	OBR-4.1 (ORU R01/lab:textual) OBX-3.1 (ORU R01/lab)
Test Coding System	String	The coding system of the test that was performed. This captures the raw value as provided by the input source, for example from an HL7 message. It is not populated when the user enters a result directly into the PKB web UI, which asks them to select a type from a dropdown.	OBR-4.3 (ORU R01/lab:textual) OBX-3.3 (ORU R01/lab)
Timestamp	Timestamp	The clinically relevant timestamp of the lab result.	OBR-7.1 (ORU R01/lab) OBX-14.1 (ORU R01/lab)	Observation.effectiveDateTime		Lab result details page
Value	Number	The result value. This will not always be populated. If the result does not parse as a number, or if numeric values are not valid for this test type, then Value Text will be populated instead. Alternatively, if an HL7 message contained the single textual report content pattern, then the text of that report will be populated in the Comments attribute, rather than the Value.	OBX-5.1 (ORU R01/lab)			Lab results details page
Value Text	String	The textual result value. This will not always be populated. If a numeric Value has been assigned then the textual representation is not stored.	OBX-5.1 (ORU R01/lab)			Lab results details page
Comments	String	Any comments associated with the lab result.	NTE-3.1 (ORU R01/lab) OBX-5.1 (ORU R01/lab)			Lab result details page
Range Low	Number	The lowest expected value for this lab result.	OBX-7.1 (ORU R01/lab)			Lab result details page
Range Low Inclusive	Boolean	Whether or not the Range Low value is inclusive.	OBX-7.1 (ORU R01/lab)
Range High	Number	The highest expected value for this lab result.	OBX-7.1 (ORU R01/lab)			Lab result details page
Range High Inclusive	Boolean	Whether or not the Range High value is inclusive.	OBX-7.1 (ORU R01/lab)
Textual Range	String	A textual range is used to indicate the expected outcome for a non-numeric test result.	OBX-7.1 (ORU R01/lab)			Lab results details page
Comparator	Enum	GREATER_OR_EQUAL LESS_OR_EQUAL GREATER LESS	OBX-5.1 (ORU R01/lab)			Lab results details page
Delay	Number	The number of days for which the content of the data point should be hidden from the patient and carers.	OBX-13 (ORU R01/lab)			Lab result details page A placeholder is shown to the patient and carers, letting them know when the content will be displayed.

Entity: Local Test Type

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read
Write			ORU R01/lab
Attributes
ID	Number	An ID for this Local Test Type.
Source Organisation	Ref : [[Organisation.Public ID]]	The organisation which sent this lab result.
Test Code	String	The test code.
Test Coding System	String	The coding system from which the test code was drawn.
Units	String	The units for the test.
Test Name	String	The display name provided for the most recently received test result of this type.
Service Name	String	The display name provided for the service (a.k.a. panel) which contained the most recently received test result of this type.
Expected Value Type	Enum	TEXT POSNEG NUMERIC VARIES

Entity: LOINC Test Type

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
ID	Number	An ID for this LOINC Test Type.
LOINC Code	String	The LOINC code.
Units	String	The units for the test.
Name	String	The display name of the test.
Expected Value Type	Enum	TEXT POSNEG NUMERIC VARIES

Entity: Common LOINC Panel Form

Attribute	Type	Description	HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
ID	Number	An ID for this Common LOINC Panel Form.
Name	String	The name of the panel.

Class Diagram

Measurement

Display

Measurements appear in the Health > Measurements page of the patient's record.

Please see the manual for more information.

Entity: Measurement Report

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Attributes
External ID	String	An ID provided by the sender.	ORC-3.1 (ORU R01/lab) OBR-3.1 (ORU R01/lab)

Entity: Measurement - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/v2-beta/measurements/[patientId] /v2-beta/measurements	Measurements
Write			ORU R01/lab		/v1/measurements /v1/measurements/[measurementId] /v2-beta/measurements/[patientId]	Measurements
Attributes
Name	String	The name of the type of measurement.
Code System	String	The code system used.				Measurement listing page Measurement details page
Code of Whole	String	The code representing the overall measurement.
Code	String	The code of the first value, if this is a multi-valued measurement.
Code2	String	The code of the second value, if this is a multi-valued measurement.
Unit	String	The units of the value.				Measurement listing page Measurement details page
Unit2	String	The units of the second value.
Timestamp	Timestamp	The timestamp when the measurement was taken.	OBR-7.1 (ORU R01/lab) OBX-14.1 (ORU R01/lab)			Measurement details page
Value	Number	The value of the measurement.	OBX-5.1 (ORU R01/lab)			Measurement listing page Measurement details page
Value2	Number	The second value, if relevant. This is intended to allow two related measurements to be grouped together, e.g.diastolic and systolic blood pressure. This is not a second reading of the first value.	OBX-5.1 (ORU R01/lab)			Measurement listing page Measurement details page
Value Non-Numeric	String	The value of the measurement if it is not numeric.				Measurement listing page Measurement details page

Class Diagram

Medication

Display

Medications appear in the Treatments > Medicines page of the patient's record.

Please see the manual for more information.

Entity: Medication - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/v1/medications /v1/medications/active /v1/medications/forPatient/[patientId]/active /v1/medications/forPatient/[patientId]	Medicines
Write			ADT A28 ADT A31		/v1/medications	Medicines
Attributes
Status	Enum	ACTIVE INACTIVE
Substance	CodeableConcept	The medication.	ZRX-2			Medication listing page Medication details page
Start Timestamp	Timestamp	When the medication was started.	ZRX-1.4			Medication listing page Medication details page
End Timestamp	Timestamp	When the medication was finished.	ZRX-1.5			Medication listing page Medication details page
Frequency Text	String	How frequently the medication should be taken.	ZRX-1.2			Medication listing page Medication details page
Frequency Value	Number	A representation of how frequently the medication should be taken, when combined with Frequency Units.
Frequency Units	Enum	HOUR
Frequency Priority	Enum	Can be used to capture a frequency instruction of: AS_DIRECTED AS_NEEDED
Dose Value	Number	How much should be taken.	ZRX-3.1			Medication listing page Medication details page
Dose Units	CodeableConcept	The units of the Dose Value.	ZRX-5			Medication listing page Medication details page
Medication Unit	Enum	MG ML UNITS TABLETS MCG DAYS DROPS INJECTION PATCHES PUFFS MEQ MEQL MGML GRAMS LMIN NGHR MGHR SACHETS NG SPRAY MILLION_UNITS MCG_HR CAPSULES DOSES MMOL APPLICATIONS
Instructions	String	How to take the medication.	ZRX-7.2			Medication listing page Medication details page

Class Diagram

Radiology Report

Display

Radiology reports appear in the Health > Imaging page of the patient's record.

Please see the manual for more information.

Entity: Radiology Report - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read				/DiagnosticReport		Imaging
Write			OBR-7.1 (ORU R01/radiology)			Imaging
Attributes
Timestamp	Timestamp	The clinically relevant timestamp of the report.	OBR-7.1 (ORU R01/radiology)	DiagnosticReport.effectiveDateTime		Radiology report listing page Radiology report details page
Title	String	A title for the report.	OBR-4.2 (ORU R01/radiology) OBR-4.5 (ORU R01/radiology)			Radiology report listing page Radiology report details page
Description	String	The report contents.	NTE-3.1 (ORU R01/radiology) OBX-5.1 (ORU R01/radiology)			Radiology report details page
Enterer Location	String	A description of the location of the person who entered the request.	ORC-13.9 (ORU R01)
Delay	Number	The number of days for which the content of the data point should be hidden from the patient and carers.	OBX-13 (ORU R01/radiology)			Radiology report details page A placeholder is shown to the patient and carers, letting them know when the content will be displayed.

HL7 API

FHIR API (Facade)

Custom REST API

Web (Patient)

Summary of interactions

Attributes

Sharing Enabled

See [[Patient Opt Out Record.Sharing Enabled]]

Class Diagram

Symptom

Display

Symptom reports appear in the Health > Symptoms page of the patient's record.

Please see the manual for more information.

Entity: Symptom Report - Extends: Data Point

			HL7 API	FHIR API (Facade)	Custom REST API	Web (Patient)
Summary of interactions
Read					/symptomReports/all /v1/symptoms/monitored /v1/symptoms/reports/after/[timestamp] /v1/symptoms/reports/forPatient/bySymptoms	Symptoms
Write					/v1/symptoms/reports	Symptoms
Attributes
Symptom	CodeableConcept	The symptom which is being reported.
Timestamp	Timestamp	Timestamp for the symptom report.
Severity	Enum	NONE MILD MODERATE SEVERE