These entities represent abstract concepts which are extended or used by other concrete data types.
Mappings
HL7 API | FHIR API | Web | Custom REST API | ||
Facade (STU3) | Aggregated (R4) | ||||
Entity: Data Point | |||||
Identifiers | |||||
Data Point ID A unique ID identifying this data point. This ID will not change even if the data point is modified. |
|
| |||
Aggregated Data Point ID Data Points that have been exposed in the Aggregated FHIR endpoint will have this additional ID populated. | This is the resource ID. | ||||
External Data Point ID The ID assigned to this data point by the source system. | ORC-3.1 (ORU R01/radiology) | ||||
Legacy Data Point ID A unique ID for this version of this data point. This ID will change when the data point is updated. | |||||
Timestamps | |||||
Entered 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 | ||||
Persisted Timestamp The timestamp when the data point was persisted in PKB. | |||||
Other | |||||
Privacy Label
| meta.security | meta.security | Various, depending on data type | ||
Specialty The specialty associated with the data point. | PV1-10.1 | Various, depending on data type | |||
Entity: Source | |||||
Source Organisation The organisation which created the data point. | This is derived automatically from the authenticated connection. | meta.security (See also code system: source-organization) | Various, depending on data type | ||
Source Team The team which created the data point. | This is derived automatically from the authenticated connection. | meta.security (See also code system: source-team) | Various, depending on data type | ||
Source Person The PKB user who created the data point. | This value is never set for data sent via HL7. | meta.security (See also code system: source-patient, code-system: source-practitioner) | Various, depending on data type | ||
Source Text 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 The organisation which connected to PKB in order to send the data point. Currently, this cannot differ from the Source Organisation. | This is derived automatically from the authenticated connection. | meta.security (See also code system: connecting-org) | Various, depending on data type | ||
HL7 Partner The HL7 Partner which delivered the data. | This is derived automatically from the authenticated connection. | Various, depending on data type | |||
Responsible Organisation Identifier An identifier for the organisation responsible for the data point. | Various, depending on data type | ||||
Access Route 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 The message which led to this data point. | |||||
Entity: HL7 Partner | |||||
Public ID An ID for this HL7 Partner. | |||||
Name The name of this HL7 Partner. | Various, depending on data type | ||||
This entity is typically used to capture meta information about non-clinical entities, i.e. entities which do not have a Data Point or Source object.
HL7 API | FHIR API | Web | Custom REST API | ||
Facade (STU3) | Aggregated (R4) | ||||
Entity: Version Details | |||||
Source Organisation The organisation which created the data. | This is derived automatically from the authenticated connection. | ||||
Source Team The team which created the data. | This is derived automatically from the authenticated connection. | ||||
Source Person The PKB user who created the data. | This value is never set for data sent via HL7. | ||||
Source Text Other source information that does not fit into one of the other source attributes. | |||||
Connecting Organisation The organisation which connected to PKB in order to send the data point. Currently, this cannot differ from the Source Organisation. | This is derived automatically from the authenticated connection. | ||||
HL7 Partner The HL7 Partner which delivered the data. | This is derived automatically from the authenticated connection. | ||||
Responsible Organisation Identifier An identifier for the organisation responsible for the data. | |||||
Access Route 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 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 When the data was first created. | |||||
Persisted Timestamp When this version of the data was persisted. | |||||