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.
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:
|
CodeableConcept | A compound value. Consists of:
|
Identifier | A compound value. Consists of:
|
Common Entities
Attachment
https://pkbdev.atlassian.net/wiki/spaces/api/pages/3750363137/Entity+Attachment
Data Point
https://pkbdev.atlassian.net/wiki/spaces/api/pages/3750395905/Entity+Data+Point
Administrative Entities
Organisation & Users
Class Diagram
Entity: Organisation
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Public ID | String | An ID for this Organisation. |
|
| ||
Name | String | The name of this Organisation. |
|
|
Entity: Team
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Public ID | String | An ID for this Team. |
|
| ||
Name | String | The name of this Team. |
|
|
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 Else |
| ||
Title | String | Title. | For Patient | For Patient Else | Profile page | |
Given Name | String | The first name of the User. | For Patient | For Patient Else | Profile page | |
Family Name | String | The last name of the User. | For Patient | For Patient Else | Profile 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. |
|
|
| |
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. |
|
|
|
Patient & Contact
https://pkbdev.atlassian.net/wiki/spaces/api/pages/3749543951/Entity+Patient
Consent and Opt Out
https://pkbdev.atlassian.net/wiki/spaces/api/pages/3750297601/Entity+Consent
Identifiers
Class Diagram
Entity: National ID
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Value | String | The value of the ID. | 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. |
|
| ||
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. |
|
|
Entity: Local ID
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Value | String | The value of the ID. | 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. |
|
| ||
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.
Entity: Country
No attributes.