Data Model

This Data Model is currently in draft.

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.

Entities

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
Identifier	A compound value. Consists of: System Value

Administrative Entities

Organisation & Users

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.