Data Model

This Data Model is currently in draft.

Contents

  1. 1 Overview
  2. 2 Notation
    1. 2.1 Cardinality
    2. 2.2 Specialization
  3. 3 Data Types
  4. 4 Relationships
  5. 5 Common Entities
    1. 5.1 Attachment
    2. 5.2 Data Point
    3. 5.3 Source
  6. 6 Administrative, User & Identifier Entities
    1. 6.1 Administrative
    2. 6.2 Patient & Contact
    3. 6.3 Identifiers
  7. 7 Core Medical Entities
    1. 7.1 Allergy
    2. 7.2 Appointment
    3. 7.3 Care Plan
    4. 7.4 Consultation
    5. 7.5 Conversation
    6. 7.6 Diagnosis
    7. 7.7 Document
    8. 7.8 Encounter
    9. 7.9 Lab Report
    10. 7.10 Measurement
    11. 7.11 Medication
    12. 7.12 Radiology Report
    13. 7.13 Symptom

Overview

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.

Notation

Cardinality

Cardinality is indicated through the following symbols.
 
Exactly One Zero or One Zero or More One or More

Specialization

The example below indicates that Entity B is a more specialized version of Entity A.

 

Data Types

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

Relationships

Administrative, Roles & Consent Record
Identifiers

Common Entities

Attachment

Entity: Attachment

Attribute Type Description HL7 API FHIR API GUI: Patient
Public ID String The ID of the attachment.      
Filename String
  • The filename of the attachment.
   Various, depending on associated data type
Content Binary The content of the attachment.   Various, depending on associated data type
Media Type String The type of media contained in the content.  

Data Point

Entity: Data Point

Attribute Type Description HL7 API FHIR API GUI: Patient
Data Point ID String A unique ID identifying this data point. This ID will not change even if the data point is modified.      
External Data Point ID String The ID assigned to this data point by the source system. DocumentReference.identifier  
Privacy Label Enum
  • GENERAL_HEALTH
  • MENTAL_HEALTH
  • SEXUAL_HEALTH
  • SOCIAL_CARE
     Various, depending on associated data type
Specialty String The specialty associated with the data point.
  • PV1-10.1
 specialty Various, depending on associated data type
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.
 
Persisted Timestamp Timestamp The timestamp when the data point was persisted in PKB.      

Source

Entity: Source

Attribute Type Description HL7 API FHIR API GUI: 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 Various, depending on associated 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 associated 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 associated data type
Source Text String Source information, other than organisation, team, or person.   Various, depending on associated data type

Administrative, User & Identifier Entities

Administrative

Entity: Organisation

Attribute Type Description HL7 API FHIR API GUI: 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 GUI: 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 GUI: Patient
Public ID String An ID for this Person.    

Entity: User

Attribute Type Description HL7 API FHIR API GUI: Patient
Public ID String An ID for this User.
 For Patient
For Patient

Patient.id

Else

Practitioner.id
Title String Title. For Patient
 For Patient

Patient.name

Else

Practitioner.name
Given Name String The first name of the User. For Patient
 For Patient

Patient.name

Else

Practitioner.name
Family Name String The last name of the User. For Patient
 For Patient

Patient.name

Else

Practitioner.name

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 GUI: 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 GUI: Patient
Public ID String An ID for this Role.    

Entity: Country

No attributes.

Entity: Consent Record

Attribute Type Description HL7 API FHIR API GUI: Patient
Public ID String An ID for this Consent Record.
   Consent.id  
General Health Granted Boolean Whether or not the patient has granted access to the general health portion of their medical record.   Consent.except  
Mental Health Granted Boolean Whether or not the patient has granted access to the mental health portion of their medical record.   Consent.except  
Sexual Health Granted Boolean Whether or not the patient has granted access to the sexual health portion of their medical record.   Consent.except  
Social Care Granted Boolean Whether or not the patient has granted access to the social care portion of their medical record.   Consent.except  
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 where set.      
Discharged Boolean Indicates whether the actor is currently providing care to the patient.   Consent.status  

Patient & Contact

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
Attribute Type Description HL7 API FHIR API GUI: Patient
Middle Names String Any middle names of the patient.    
Address Line 1 String First line of the address. Patient.address
Address Line 2 String Second line of the address. Patient.address
City String The nearest city or town. Patient.address
State String The state. Patient.address
Country String The country. Patient.address
Postal Code String The postal code. Patient.address
Date of Birth Local Date Date of birth. Patient.birthDate
Death Timestamp Timestamp When the patient died. Patient.deceased  
Gender Enum This is the administrative gender of the patient.
  • UNKNOWN
  • MALE
  • FEMALE
  • INDETERMINATE
 Patient.gender
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.    
Skype ID String How to contact the patient on Skype.    
Phone String The phone number of the patient. Patient.telecom
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.   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

Attribute Type Description HL7 API FHIR API GUI: Patient
Public ID String The ID of the contact.    
Type Enum
  • EMAIL_ADDRESS
 Patient.telecom
Value String The value of the contact information. Patient.telecom
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.    
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.    

Identifiers

Diagram

Identifiers

Entity: National ID

Attribute Type Description HL7 API FHIR API GUI: Patient
Value String The value of the ID. Patient.identifier
  • Profile page

Entity: National ID Type

Attribute Type Description HL7 API FHIR API GUI: 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.    
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.    
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 GUI: Patient
Value String The value of the ID. Patient.identifier
  • Profile page

Entity: Local ID Type

Attribute Type Description HL7 API FHIR API GUI: 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.    
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.    

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.

Core Medical Entities

Allergy

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Allergen CodeableConcept The allergen.  
Onset Timestamp Timestamp When the symptoms began.  
Reactions CodeableConcept List The reactions to the allergen.  
Severity CodeableConcept How severe the reaction to the allergen is.  

Appointment

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Type Coding The type of appointment.  
Start Timestamp Timestamp When the appointment starts. Appointment.start
End Timestamp Timestamp When the appointment ends. Appointment.end
Subject String A brief reason for the appointment. Appointment.reason
Description String A longer explanation of the appointment. Appointment.comment
Location String Where the appointment is to be held.

 Appointment.participant
Status Enum
  • ACTIVE
  • CANCELLED
  • DNA
 Appointment.status

Entity: Appointment Participant

Attribute Type Description HL7 API FHIR API GUI: 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
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 GUI: Patient
Name String The name of the participant (optionally including their role). Appointment.participant  

Care Plan

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Name String The name of the care plan.  
Created Timestamp Timestamp The timestamp when the care plan was first created.  
Last Edited Timestamp Timestamp The timestamp when the care plan was last edited.  
Action Plan String or Binary The main body of the care plan. This can be plaintext, HTML or a PDF file.  
Green String An explanation of what to expect when the condition is under control.    
Amber String An explanation of what might need attention.    
Red String An explanation of what needs urgent attention.    

Consultation

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 GUI: Patient
Public ID String An ID for this Consultation.      
External ID String An ID for this Consultation, assigned by the owning organisation.       
Name String A textual name for this Consultation.      
Creation Timestamp Timestamp When the Consultation was created.      
Privacy Label Enum
  • GENERAL_HEALTH
  • MENTAL_HEALTH
  • SEXUAL_HEALTH
  • SOCIAL_CARE
      

Entity: Consultation Item

Attribute Type Description HL7 API FHIR API GUI: Patient
ID String An ID for this Consultation Item, unique only within this Consultation.      
Text String The text to display.      
Type Enum
  • TITLE
  • TEXT
  • RADIO
  • CHECKBOX
      

Entity: Consultation Item Option

Attribute  Type Description HL7 API FHIR API GUI: Patient
Text String The value of the option.      

Entity: Consultation Request

Attribute Type Description HL7 API FHIR API GUI: Patient
Public ID String An ID for this Consultation Request.      
Request Timestamp Timestamp When the Consultation Request was created.      
Privacy Label Enum
  • GENERAL_HEALTH
  • MENTAL_HEALTH
  • SEXUAL_HEALTH
  • SOCIAL_CARE
      

Entity: Consultation Response

Attribute Type Description HL7 API FHIR API GUI: Patient
Status Enum
  • DRAFT
  • SENT
      
Request Timestamp Timestamp When the Consultation Response was requested.      
Completion Timestamp Timestamp When the Consultation Response was completed.      

Entity: Consultation Response Item

Attribute Type Description HL7 API FHIR API GUI: Patient
Text String The value of the response.      

Conversation

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 GUI: 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 GUI: 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 GUI: Patient
User Public ID Ref :
[[User.Public ID]]		 A PKB user who received the message.   Communication.recipient
  • Conversation page

Diagnosis

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Diagnosis CodeableConcept The diagnosis.  
Start Timestamp Timestamp When the condition began.  
End Timestamp Timestamp When the condition ended.    
Details String Additional information about this diagnosis.    
  • Diagnosis details page

Document

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Class Enum
  • IN_PATIENT
  • OUT_PATIENT
  • AMBULATORY
  • EMERGENCY
  • HOME
  • FIELD
  • DAYTIME
  • VIRTUAL
  • OTHER
  
Timestamp Timestamp The document timestamp. DocumentReference.created
  • Conversation page
Document Type Enum
  • DISCHARGE_SUMMARY
  • CLINIC_LETTER
  • REFERRAL_LETTER
  • APPOINTMENT_LETTER
  • ADMISSION_TCI_LETTER
  • MULTI_DISCIPLINARY_TEAM_MEETING_NOTES
 DocumentReference.type  
Status Enum
  • READ
  • UNREAD
   document-status
Planned Postal Date Local Date The date on which this document would need to be posted. This field forms part of the Mail Management workflow.
 

Encounter

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 GUI: 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.    

Entity: Encounter Event - Extends: Data Point

Attribute Type Description HL7 API FHIR API GUI: Patient
Type Enum
  • PRE_ADMIT
  • PENDING_ADMIT
  • ADMIT
  • TRANSFER
  • DISCHARGE
  • UPDATE
      
Class Enum
  • IN_PATIENT
  • OUT_PATIENT
  • AMBULATORY
  • EMERGENCY
  • HOME
  • FIELD
  • DAYTIME
  • VIRTUAL
  • OTHER
 Encounter.class
Encounter.classHistory
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. Encounter.period
  • Conversation page

Entity: Location

Attribute Type Description HL7 API FHIR API GUI: Patient
Name String The name.      
Description String A brief description. Encounter.location
  • Conversation page
Address String The address.      

Entity: External Participant

Attribute Type Description HL7 API FHIR API GUI: Patient
Role Enum
  • ATTENDER
  • REFERRER
  • CONSULTANT
   Encounter.participant
  • Conversation page
Name String The name of the participant. Encounter.participant
  • Conversation page

Lab Report

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 GUI: Patient
External ID String An ID provided by the sender. This ID allows a sender to modify the data point.    
Enterer Location String A description of the location of the person who entered the request.    
Received Timestamp Timestamp When the lab received the specimen.    
Discipline String The diagnostic service.    

Entity: Lab Result - Extends: Data Point

Attribute Type Description HL7 API FHIR API GUI: Patient
Service String The overarching service of the lab results.  
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.		  
This value is not shown in the web UI.

Instead, the information is taken from the Initial Test Type.
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.		  
This value is not shown in the web UI.

Instead, the information is taken from the Initial Test Type.
Timestamp Timestamp The clinically relevant timestamp of the lab result. 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.		  
  • 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.		  
  • Lab results details page
Comments String Any comments associated with the lab result.  
Range Low Number The lowest expected value for this lab result.  
Range Low Inclusive Boolean Whether or not the Range Low value is inclusive.    
Range High Number The highest expected value for this lab result.  
Range High Inclusive Boolean Whether or not the Range High value is inclusive.    
Textual Range String A textual range is used to indicate the expected outcome for a non-numeric test result.  
  • Lab results details page
Comparator Enum
  • GREATER_OR_EQUAL
  • LESS_OR_EQUAL
  • GREATER
  • LESS
  
  • Lab results details page

Entity: Initial Test Type

This entity represents the type of test that was performed that resulted in a given Lab Result.

Entity: Common LOINC ITT - Extends: Initial Test Type

Attribute Type Description HL7 API FHIR API GUI: Patient
ID Number

   
LOINC Code String

   
Units String

   
Name String

   
Expected Value Type Enum
  • TEXT
  • POSNEG
  • NUMERIC
  • VARIES
    

Entity: Other ITT - Extends Initial Test Type

Attribute Type Description HL7 API FHIR API GUI: Patient
ID Number

   
Source Organisation Ref : [[Organisation.Public ID]]

   
Test Code String

   
Test Coding System String

   
Units String
     
Name String
     
Expected Value Type Enum
  • TEXT
  • POSNEG
  • NUMERIC
  • VARIES
      

Entity: Common LOINC Panel Form

Attribute Type Description HL7 API FHIR API GUI: Patient
ID Number

   
Name String

   

Measurement

Diagram

Measurement

Display

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

Please see the manual for more information.

Entity: Measurement - Extends: Data Point

Attribute Type Description HL7 API FHIR API GUI: Patient
Name String The name of the type of measurement.      
Code System String The code system used.    
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.    
Unit2 String The units of the second value.      
Timestamp Timestamp The timestamp when the measurement was taken.  
Value Number The value of the measurement.  
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.  
Value Non-Numeric String The value of the measurement if it is not numeric.    

Medication

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Status Enum
  • ACTIVE
  • INACTIVE
      
Substance CodeableConcept The medication.  
Start Timestamp Timestamp When the medication was started.  
End Timestamp Timestamp When the medication was finished.  
Frequency Text String How frequently the medication should be taken.  
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.  
Dose Units CodeableConcept The units of the Dose Value.  
Instructions String How to take the medication.  

Radiology Report

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Timestamp Timestamp The clinically relevant timestamp of the report. DiagnosticReport.effectiveDateTime
Title String A title for the report.  
Description String The report contents.  
Enterer Location String A description of the location of the person who entered the request.    

Symptom

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

Attribute Type Description HL7 API FHIR API GUI: Patient
Symptom CodeableConcept The symptom which is being reported.      
Timestamp Timestamp Timestamp for the symptom report.      
Severity Enum
  • NONE
  • MILD
  • MODERATE
  • SEVERE
      
Comments