Entity: Data Point

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

 

 

This is the resource ID.

 

 

External Data Point ID String

The ID assigned to this data point by the source system.

ORC-3.1 (ORU R01/radiology)
OBR-3.1 (ORU R01/radiology)
TXA-12.1 (MDM T02/care plan)
TXA-12.1 (MDM T02/document)
SCH-1.1 (SIU)

DocumentReference.identifier

Appointment.identifier

 

 

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.

 

 

Appointment.identifier

 

 

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
TXA-4.1 (MDM T02/document)
TXA-6.1 (MDM T02/document)
TXA-7.1 (MDM T02/document)
TXA-8.1 (MDM T02/document)

 

recorded-date

 

 

Persisted Timestamp Timestamp

The timestamp when the data point was persisted in PKB.

 

 

version-persisted

 

 

Other

Privacy Label Enum

  • GENERAL_HEALTH

  • MENTAL_HEALTH

  • SEXUAL_HEALTH

  • SOCIAL_CARE

 

meta.security
Cosent.except.securityLabel

meta.security

Various, depending on data type

 

Specialty String

The specialty associated with the data point.

PV1-10.1

specialty

Appointment.specialty

Various, depending on data type

 

Entity: Source

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

The organisation which created the data point.

This is derived automatically from the authenticated connection.

source-organisation
search param: source-organisation

meta.security

(See also code system: source-organization)

Various, depending on data type

 

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

The team which created the data point.

This is derived automatically from the authenticated connection.

source-team

meta.security

(See also code system: source-team)

Various, depending on 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

meta.security

(See also code system: source-patient, code-system: source-practitioner)

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)
DG1-16 (ADT A28)
ZRX-13 (ADT A28)
OBR-16 (ORU R01)
TXA-5 (MDM T02/care plan)

 

source-text

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 automatically from the authenticated connection.

 

meta.security

(See also code system: connecting-org)

Various, depending on data type

 

HL7 Partner Ref: [[HL7 Partner.Public ID]]

The HL7 Partner which delivered the data.

This is derived automatically from the authenticated connection.

 

partner-identifier

Various, depending on data type

 

Responsible Organisation Identifier String

An identifier for the organisation responsible for the data point.

MSH-22.10

 

responsible-organization

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.

 

 

access-route

Various, depending on data type

 

Uploaded Data ID String

The message which led to this data point.

 

 

uploaded-data-id

 

 

Entity: HL7 Partner

Public ID String

An ID for this HL7 Partner.

 

 

partner-identifier

 

 

Name String

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 Ref: [[Organisation.Public ID]]

The organisation which created the data.

This is derived automatically from the authenticated connection.

 

source-organization

 

 

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

The team which created the data.

This is derived automatically from the authenticated connection.

 

source-team

 

 

Source Person Ref: [[User.Public ID]]

The PKB user who created the data.

This value is never set for data sent via HL7.

 

source-patient

source-practitioner

 

 

Source Text String

Other source information that does not fit into one of the other source attributes.

 

 

source-text

 

 

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 automatically from the authenticated connection.

 

connecting-org

 

 

HL7 Partner Ref: [[HL7 Partner.Public ID]]

The HL7 Partner which delivered the data.

This is derived automatically from the authenticated connection.

 

partner-identifier

 

 

Responsible Organisation Identifier String

An identifier for the organisation responsible for the data.

MSH-22.10

 

responsible-organization

 

 

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.

 

 

access-route

 

 

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.

 

 

entered-date

 

 

Created Timestamp Timestamp

When the data was first created.

 

 

created-date

 

 

Persisted Timestamp Timestamp

When this version of the data was persisted.

 

 

version-persisted

 

Â