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.
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
Entity: Attachment
| HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| Various, depending on data type | |||
Write |
|
| 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) |
|
| Various, depending on data type |
Content | Binary | The content of the attachment. |
| Returned in the download stream | Various, depending on 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 (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) |
|
| |
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) |
|
|
|
Persisted Timestamp | Timestamp | The timestamp when the data point was persisted in PKB. |
|
|
|
|
Other | ||||||
Privacy Label | Enum |
|
| meta.security |
| Various, depending on data type |
Specialty | String | The specialty associated with the data point. | PV1-10.1 |
| Various, depending on data type |
Source
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. |
| Various, depending on data type | |
Source Team | Ref : | The team which created the data point. | This is derived from the HL7 connection. See here for more information. |
| Various, depending on data type | |
Source Person | Ref : | The PKB user who created the data point. | This value is never set for data sent via HL7. |
| 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) |
|
| 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. |
|
| 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 |
Version Details
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 : | The team which created the data. |
|
|
|
|
Source Person | Ref : | 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. |
|
|
|
|
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
Class Diagram
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 | /users/self | |||||
Write | ||||||
Attributes | ||||||
Middle Names | String | Any middle names of the patient. |
| Profile page | ||
Address Line 1 | String | First line of the address. |
| Profile page | ||
Address Line 2 | String | Second line of the address. |
| Profile page | ||
City | String | The nearest city or town. |
| Profile page | ||
State | String | The state. |
| Profile page | ||
Country | String | The country. |
| Profile page | ||
Postal Code | String | The postal code. |
| Profile page | ||
Date of Birth | Local Date | Date of birth. |
| Profile page | ||
Death Timestamp | Timestamp | When the patient died. |
|
| ||
Gender | Enum | This is the administrative gender of the patient.
|
| Profile page | ||
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. |
|
|
| Profile page |
Skype ID | String | How to contact the patient on Skype. |
|
|
| Profile page |
Phone | String | The phone number of the patient. |
| Profile page | ||
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. |
|
|
| |
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 (Facade) | Custom REST API | Web (Patient) |
Type | Enum |
|
|
| ||
Value | String | The value of the contact information. |
| 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 |
Consent and Opt Out
Class Diagram
Entity: Consent 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. |
|
|
|
|
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. |
|
| ||
Mental Health Granted | Boolean | Whether or not the patient has granted access to the mental health portion of their medical record. |
|
| ||
Sexual Health Granted | Boolean | Whether or not the patient has granted access to the sexual health portion of their medical record. |
|
| ||
Social Care Granted | Boolean | Whether or not the patient has granted access to the social care portion of their medical record. |
|
| ||
Reason Code | Enum |
|
|
|
|
|
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. |
|
| ||
Professional Edit Only | Boolean | Indicates whether this Consent Record has been locked. See the manual on Paediatric Records for more information. |
|
|
| |
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
| HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
|
|
| ||
Write |
|
|
|
| ||
Attributes | ||||||
Sharing Enabled | Boolean | See [[Patient Opt Out Record.Sharing Enabled]] |
|
|
|
|
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.
Clinical Entities
Allergy
Class Diagram
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 |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Allergen | CodeableConcept | The allergen. |
| Allergy listing page | ||
Onset Timestamp | Timestamp | When the symptoms began. |
| Allergy listing page | ||
Reactions | CodeableConcept List | The reactions to the allergen. |
| Allergy listing page | ||
Severity | CodeableConcept | How severe the reaction to the allergen is. |
| Allergy listing page |
Appointment
Class Diagram
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 |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Type | Coding | The type of appointment. |
|
| Appointment details page | |
Start Timestamp | Timestamp | When the appointment starts. |
| Appointment listing page | ||
End Timestamp | Timestamp | When the appointment ends. |
| Appointment details page | ||
Subject | String | A brief reason for the appointment. |
| Appointment listings page | ||
Description | String | A longer explanation of the appointment. |
| Appointment details page | ||
Location | String | Where the appointment is to be held. |
| Appointment details page | ||
Status | Enum |
|
| Appointment listings page | ||
External Management URL | String | A deep link URL to an external appointment interface, where this appointment can be managed. |
|
| 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 : | 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 details page | |
Status | Enum |
| The status is always Accepted. |
| 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). |
|
|
Care Plan
Class Diagram
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] | |||
Write |
| |||||
Attributes | ||||||
Name | String | The name of the care plan. |
|
| Care plan listing page | |
Created Timestamp | Timestamp | The timestamp when the care plan was first created. |
|
| Care plan listing page | |
Last Edited Timestamp | Timestamp | The timestamp when the care plan was last edited. |
|
| Care plan listing page | |
Action Plan | String or Binary | The main body of the care plan. This can be plaintext, HTML or a PDF file. |
|
| 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 |
|
|
|
|
|
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 |
|
|
|
|
|
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. |
|
|
|
|
Consultation
Class Diagram
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. |
|
|
| |
Name | String | A textual name for this Consultation. |
|
|
| |
Creation Timestamp | Timestamp | When the Consultation was created. |
|
|
| |
Privacy Label | Enum |
|
|
|
|
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. |
|
|
| |
Text | String | The text to display. |
|
|
| |
Type | Enum |
|
|
|
|
Entity: Consultation Item Option
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Text | String | The value of the option. |
|
|
|
Entity: Consultation Request
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Summary of interactions | ||||||
Read |
|
|
|
|
| |
Write |
|
|
|
|
| |
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. |
|
|
| |
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 (Facade) | Custom REST API | Web (Patient) |
Text | String | The value of the response. |
|
|
|
Conversation
Class Diagram
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. |
|
|
|
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. |
|
| Conversation page | |
Subject | String | A brief description of what the message is about. |
|
| Inbox page | |
Content | String | The content of the message. |
|
|
| Conversation page |
Sender | Ref : | The PKB user who sent the message. |
|
|
| |
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 |
|
|
|
|
|
Entity: Recipient
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
User Public ID | Ref : | A PKB user who received the message. |
|
| Conversation page |
Diagnosis
Class Diagram
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 |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Diagnosis | CodeableConcept | The diagnosis. |
| Diagnosis listing page | ||
Start Timestamp | Timestamp | When the condition began. |
| Diagnosis listing page | ||
End Timestamp | Timestamp | When the condition ended. |
|
| Diagnosis listing page | |
Details | String | Additional information about this diagnosis. |
|
| Diagnosis details page | |
Status | Enum |
|
|
|
|
|
Date Asserted | Timestamp |
|
|
|
|
|
Document
Class Diagram
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 |
|
| ||||
Write |
|
|
| |||
Attributes | ||||||
Class | Enum |
|
|
| Inbox page | |
Timestamp | Timestamp | The document timestamp. |
| Conversation page | ||
Document Type | Enum |
|
|
| ||
Status | Enum |
|
|
|
| |
Planned Postal Date | Timestamp | When this document would need to be posted. This field forms part of the Mail Management workflow. |
|
|
| |
Delay | Number | The number of days for which the content of the data point should be hidden from the patient and carers. |
|
| Conversation page A placeholder is shown to the patient and carers, letting them know when the content will be displayed. |
Encounter
Class Diagram
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. |
|
|
| |
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 (Facade) | Custom REST API | Web (Patient) |
Type | Enum |
|
|
|
|
|
Class | Enum |
|
| Inbox 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) |
| 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. |
| Conversation page | ||
Address | String | The address. |
|
|
|
|
Entity: External Participant
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
Role | Enum |
|
|
| Conversation page | |
Name | String | The name of the participant. |
| Conversation page |
Journal Entry
Class Diagram
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 |
|
|
| |||
Write |
|
| ||||
Attributes | ||||||
Subject | String | What the entry is about. |
|
|
|
|
Entry | String | The content of the entry. |
|
|
|
|
Lab Report
Class Diagram
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. |
|
|
| |
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
| HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
| /v1/tests/results/forPatient/byTestIds | ||||
Write |
|
| ||||
Attributes | ||||||
Service | String | The overarching service of the lab results. |
|
| 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. |
|
|
| |
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. |
|
|
| |
Timestamp | Timestamp | The clinically relevant timestamp of the lab result. |
| 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. |
|
| Lab result details page | |
Range Low | Number | The lowest expected value for this lab result. |
|
| Lab result details page | |
Range Low Inclusive | Boolean | Whether or not the Range Low value is inclusive. |
|
|
| |
Range High | Number | The highest expected value for this lab result. |
|
| Lab result details page | |
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 |
|
|
| 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. |
|
| 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 |
|
|
| |||
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 |
|
|
|
|
|
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 |
|
|
|
|
|
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. |
|
|
|
|
Measurement
Class Diagram
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. |
|
|
|
Entity: Measurement - Extends: Data Point
| HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
| ||||
Write |
| /v1/measurements | ||||
Attributes | ||||||
Name | String | The name of the type of measurement. |
|
|
|
|
Code System | String | The code system used. |
|
|
| Measurement listing 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 |
Unit2 | String | The units of the second value. |
|
|
|
|
Timestamp | Timestamp | The timestamp when the measurement was taken. |
|
| Measurement details page | |
Value | Number | The value of the measurement. |
|
| Measurement listing 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. |
|
| Measurement listing page | |
Value Non-Numeric | String | The value of the measurement if it is not numeric. |
|
|
| Measurement listing page |
Medication
Class Diagram
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 | |||
Write |
| |||||
Attributes | ||||||
Status | Enum |
|
|
|
|
|
Substance | CodeableConcept | The medication. |
|
| Medication listing page | |
Start Timestamp | Timestamp | When the medication was started. |
|
| Medication listing page | |
End Timestamp | Timestamp | When the medication was finished. |
|
| Medication listing page | |
Frequency Text | String | How frequently the medication should be taken. |
|
| Medication listing page | |
Frequency Value | Number | A representation of how frequently the medication should be taken, when combined with Frequency Units. |
|
|
|
|
Frequency Units | Enum |
|
|
|
|
|
Frequency Priority | Enum | Can be used to capture a frequency instruction of:
|
|
|
|
|
Dose Value | Number | How much should be taken. |
|
| Medication listing page | |
Dose Units | CodeableConcept | The units of the Dose Value. |
|
| Medication listing page | |
Medication Unit | Enum |
|
|
|
|
|
Instructions | String | How to take the medication. |
|
| Medication listing page |
Radiology Report
Class Diagram
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 |
|
| ||||
Write |
|
| ||||
Attributes | ||||||
Timestamp | Timestamp | The clinically relevant timestamp of the report. |
| Radiology report listing page | ||
Title | String | A title for the report. |
|
| Radiology report listing page | |
Description | String | The report contents. |
|
| Radiology report details page | |
Enterer Location | String | A description of the location of the person who entered the request. |
|
|
| |
Delay | Number | The number of days for which the content of the data point should be hidden from the patient and carers. |
|
| Radiology report details page A placeholder is shown to the patient and carers, letting them know when the content will be displayed. |
Symptom
Class Diagram
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 | |||
Write |
|
| ||||
Attributes | ||||||
Symptom | CodeableConcept | The symptom which is being reported. |
|
|
|
|
Timestamp | Timestamp | Timestamp for the symptom report. |
|
|
|
|
Severity | Enum |
|
|
|
|
|