Information in a member's Personal Data Store (PDS) is stored as a series of datasets. There
are two basic types of datasets Metadata and Transactional.
A Metadata Dataset might, for example, represent information pertaining to the member's driver's
licence, passport or house. A member can also have multiple instances of a dataset. For instance, a member may
have a second instance of the 'Bank Account' dataset containing details of a second bank account.
A Transactional Dataset While some datasets change infrequently like the ones listed above,
other datasets are updated constantly. Examples include browser history,
bank transactions, and the call records in your mobile
bill. These are referred to as Transactional Datasets. The distinctions between an API call made to a
regular Dataset and a Transactional Dataset are given in the Personal Data eXchange API table.
Each member has control over how Subscriber organisations and services access their datasets through a Data Sharing Agreement
then creates the rules for the secure connection.
Only the datasets included in the Data Sharing Agreement can be accessed either for delivery of data or collection
of data. As part of the Data Sharing Agreement a Subscriber organisation or services declares the specific use cases for the
data and makes a GDPR declaration.
Only the member can approve a data sharing agreement.
Subscriber organisations can set up data sharing agreements via our connection manager application by requesting a dedicated
connection unique to their service.
Search
Expand
Collection
Datasets
Data Fields
Personal Records
16
166
Expand
Dataset Name
Fields Count
Activity Log
10
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Changeset
changeset
text
TBD
Changeset of the data changed.
Changetype
changetype
varchar
255
TBD
Type of change that occurred.
Dataset
dataset
varchar
255
TBD
Dataset of data changed.
Dataset instance
dataset_instance
varchar
255
TBD
Instance of data changed.
Field name
field_name
varchar
255
TBD
Field name of data changed.
New value
new_value
text
TBD
New value.
Note
note
varchar
TBD
Additional note.
Previous value
previous_value
text
TBD
Previous value.
Timestamp
timestamp
int
TBD
The timestamp of the log record.
Version
version
int
TBD
Version of the activity log format in use.
Activity Log Connection
5
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Action
action
varchar
255
TBD
Action taken by the connection.
Action from
action_from
varchar
255
TBD
From API or PDS.
Con id
con_id
varchar
255
TBD
The con_id of the connection.
Data
data
blob
TBD
The arbitrary data for the item.
Timestamp
timestamp
int
TBD
The timestamp of the log record.
Birth Details
4
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Country
field_birth_country
varchar
2000
TBD
The Country in which the member was born
England
Date Of Birth
field_birth_dob
int
TBD
The members date of birth
29222
Nationality
field_birth_nationality
varchar
2000
TBD
The nationality of the member
British
Town
field_birth_town
varchar
2000
TBD
The town in which the member was born
Manchester
Certificates
10
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
certificate
certificate
varchar
500
TBD
The hashed data.
Date created
created
int
TBD
Timestamp of creation time and date.
dataset
dataset
varchar
30
TBD
The dataset the certificate relates to.
field
field
varchar
30
TBD
The field the certificate relates to.
id
id
serial
TBD
The primary identifier for this certificate.
instance
instance
int
TBD
The instance this certificate relates to.
Reference ID
ref_id
int
1
TBD
Reference id i.e. the id of this data in its own table.
source
source
varchar
30
TBD
The con_id of the connection who created the certificate.
Valid
valid
int
1
TBD
Boolean indicating whether or not the certificate is valid.
Version Number
version
int
TBD
The version the certificate relates to.
Driving Licence
14
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Date Of Birth
field_dl_dob
date
TBD
The members date of birth
29222
Expiry Alert
field_dl_expiry_alert
date
60
TBD
Groups
field_dl_groups
field_collection_table
60
TBD
Category
field_dl_groups_category
text
60
TBD
Date From
field_dl_group_date_from
date
TBD
Date To
field_dl_group_date_to
date
TBD
Issue Country
field_dl_issue_country
text
TBD
United Kingdom
Issuing Authority
field_dl_issuing_authority
text
TBD
The authority that issued the members driving licence
DVLA
Licence Number
field_dl_licence_number
text
60
TBD
The members driving licence number
888 8888 888
Other Names
field_dl_other_names
text
60
TBD
The member's surname
Jones
Place Of Birth
field_dl_pob
text
TBD
The Country in which the member was born
England
Surname
field_dl_surname
text
60
TBD
The members surname
Jones
Valid From
field_dl_valid_from
date
TBD
The date from which the members driving dicence is Valid
29222
Valid To
field_dl_valid_to
date
TBD
The expiry date of the members driving licence
29222
Employer
6
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Employee ID
field_emp_employee_id
varchar
255
TBD
The member's employee ID.
Employer Name
field_emp_employer_name
varchar
255
TBD
The name of the member's employer.
End Date
field_emp_end_date
int
TBD
The member's end date of employment.
Job Title
field_emp_job_title
varchar
255
TBD
The member's job title.
Salary
field_emp_salary
int
TBD
The member's salary.
Start Date
field_emp_start_date
int
TBD
The member's start date of employment.
Establishment
17
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Address Country
field_edu_country
text
TBD
The establishment country
England
Address County
field_edu_county
text
60
TBD
The establishment county
Essex
Courses
field_edu_courses
field_collection_embed
TBD
Date
field_edu_course_date
date
TBD
The date the member was awarded the qualification
29222
Level
field_edu_course_level
text
60
TBD
The level of the course
A Level
Mode Of Study
field_edu_course_mode_of_study
text
TBD
The mode of study for the course
Full Time
Name
field_edu_course_name
text
60
TBD
The name of the course the member undertook
Computer Science
Results Attained
field_edu_course_results
text
60
TBD
The grades awarded
Pass
Address DateFrom
field_edu_date_from
date
TBD
The date the member started at the establishment
29222
Address DateTo
field_edu_date_to
date
TBD
The date the member left the establishment
29222
Establishment Name
field_edu_establishment_name
text
60
TBD
The name of the establishment
Kings School
Address PostCode
field_edu_postcode
text
60
TBD
The establishment postcode
NB1 1AZ
Address Street
field_edu_street
text
TBD
The establishment street name and building name/ number
1 High Street
Address Telephone
field_edu_telephone
text
60
TBD
The establishment telephone number
(44) 01234 123456
Address Town
field_edu_town
text
60
TBD
The establishment town
Watford
Type
field_edu_type
text
TBD
The type of establishment
School
Address URL
field_edu_url
text
60
TBD
The establishment URL
www.name.com
Invites
14
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1638375529
Expire Timestamp
expire_timestamp
int
TBD
Unix Timestamp of when the invite expires.
1641991375
Invites ID
id
serial
TBD
The primary identifier for this record.
2
Identifier
identifier
varchar
TBD
Unique Identifier of what the invite is inviting the member to.
1
Invites Instance
instance
int
TBD
The instance this item relates to.
3
Known As
known_as
varchar
TBD
A label for the invite so that we know who we are inviting before we have a mydexid, and for good UX
Julie
Name
name
varchar
TBD
Name of invited member
Julie Dom
One Time Code
one_time_code
varchar
TBD
One time code that is generated with the invite
1861227082
Recipient
recipient
varchar
TBD
Either phone number or email address.
dom.julie@email.com
Route
route
varchar
TBD
The route the invite used, either email, SMS or mydexId.
email
Invites Source
source
varchar
30
TBD
The source of the data - user or connection.
Status
status
varchar
TBD
The status of the invite.
received
Type
type
varchar
TBD
The type of the invite.
Invite
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1639153129
Log
4
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Cateogry
cateogry
varchar
255
TBD
Cateogry of log message, for example "user" or "connection."
Message
message
text
TBD
Text of log message.
Severity
severity
int
1
TBD
The severity level of the event; ranges from 0 (Emergency) to 7 (Debug).
Timestamp
timestamp
int
TBD
The timestamp of the log record.
National Insurance
2
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Name
field_ni_name
varchar
2000
TBD
The members surname
Jones
Number
field_ni_number
varchar
2000
TBD
A members NI Number
XX XXXXX X
Passport
13
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Code
field_pp_code
varchar
2000
TBD
Date Of Expiry
field_pp_date_expiry
int
TBD
The expiry date of the members passport
29222
Date Of Issue
field_pp_date_issue
int
TBD
The date from which the members passport is Valid
29222
Date Of Birth
field_pp_dob
int
TBD
The members date of birth
29222
Expiry Alert
field_pp_expiry_alert
int
TBD
Given Names
field_pp_given_names
varchar
2000
TBD
The members first name
Catherine
Issuing Authority
field_pp_issuing_authority
varchar
2000
TBD
The authority that issued the members passport
UKBA
Nationality
field_pp_nationality
varchar
2000
TBD
The members nationality
British
Number
field_pp_number
varchar
2000
TBD
The members passport number
123456789
Place Of Birth
field_pp_place_of_birth
varchar
2000
TBD
The city in which the member was born
Manchester
Sex
field_pp_sex
varchar
2000
TBD
The gender of the member
Female
Surname
field_pp_surname
varchar
2000
TBD
The members surname
Jones
Type
field_pp_type
varchar
2000
TBD
Personal
17
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Gender at Birth
field_gender_birth
varchar
2000
TBD
The members gender at birth
Female
Email Address
field_personal_email_address
varchar
2000
TBD
The members primary email address
katherinetsmithy@gmail.com
Race Ethnicity
field_personal_ethnicity
varchar
2000
TBD
The members ethnicity
White-Scottish
Family Name
field_personal_faname
varchar
2000
TBD
The members surname
Jones
First Name
field_personal_fname
varchar
2000
TBD
The members first name
Catherine
Gender
field_personal_gender
varchar
2000
TBD
The members gender
Female
Home Phone
field_personal_home_phone
varchar
2000
TBD
The members home phone
01234 123456
Maiden Name
field_personal_maname
varchar
2000
TBD
The members surname
Jones
Marital Status
field_personal_marital_status
varchar
2000
TBD
The members marital status
Married
Middle Name
field_personal_mname
varchar
2000
TBD
The members middle name
Anne
Mobile Phone
field_personal_mobile_phone
varchar
2000
TBD
The members mobile number
07654 321098
Nickname
field_personal_nickname
varchar
2000
TBD
The members nickname
Catherine
No of Children
field_personal_number_children
int
TBD
The number of children the member has
2
Pronouns
field_personal_pronouns
varchar
2000
TBD
The members pronouns
She/Her
Suffix
field_personal_suffix
varchar
2000
TBD
The members surname
Jones
Title
field_personal_title
varchar
2000
TBD
The members surname
Mr
Work Phone
field_personal_work_phone
varchar
2000
TBD
The work telephone number
(44) 1357 246802
Question and Answer Data
13
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Answer Question Version
answer_question_version
int
TBD
The version of the question this answer was made against.
1
Answer Result
answer_result
blob
TBD
JSON object of the structured answer result.
{""}
Answer Timestamp
answer_timestamp
varchar
100
TBD
Timestamp of when answer was made.
1639153129
Answer Version History
answer_version_history
blob
TBD
JSON BLOB, contains the question version, content, change description
{""}
Answer Version ID
answer_version_id
varchar
500
TBD
The Version ID of this question. Not Null
1
Created Timestamp
created_timestamp
varchar
100
TBD
The timestamp of when this question was created.
1639153129
Question/Answer ID
id
serial
TBD
The primary identifier for this record.
1
Instance
instance
int
TBD
The instance this item relates to.
1
Modified Timestamp
modified_timestamp
varchar
100
TBD
The timestamp of when this question was last modified.
1639153129
Question ID
question_id
varchar
500
TBD
Foreign key to id of linked question in pdx-api question_directory table.
1
Question Version History
question_version_history
blob
TBD
JSON BLOB, contains the question version, content, change description
{""}
Question Version ID
question_version_id
varchar
500
TBD
The Version ID of this question. Not Null
1
Source
source
varchar
30
TBD
The source of the data - user or connection.
Member or con_id
Questions and Answers
18
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Answer Question Version
answer_question_version
int
TBD
The version of the question this answer was made against.
What is your favourite colour?
Answer Result
answer_result
blob
TBD
JSON obejct of the structured answer result.
{colour: blue}
Answer Timestamp
answer_timestamp
varchar
100
TBD
Timestamp of when answer was made.
1638375529
Answer Version History
answer_version_history
blob
TBD
JSON BLOB, contains the question version, content, change description
"{"question_version" : "What is your favourite colour?", "content" : "blue, red, pink, yellow", "description" : "Blue."}"
Answer Version Id
answer_version_id
varchar
500
TBD
The Version ID of this question. Not Null
12
Connection ID
con_id
varchar
255
TBD
The organisation that asked this question.
Glasgow Phones
Group ID
group_id
blob
TBD
The group ID that this question belongs to.
"{"group_id" : "1"}"
Questions and Answers ID
id
serial
TBD
The primary identifier for this record.
6
Questions and Answers Instance
instance
int
TBD
The instance this item relates to.
2
Question ID
question_id
varchar
500
TBD
The identifier for a question-answer.
5
Question Label
question_label
varchar
2000
TBD
The main question label text of the queston.
Favourite Colour
Question Set Format
question_set_format
blob
TBD
JSON BLOB, contains the format of the question set
"{"questions format" : "questions"}"
Question Tags
question_tags
varchar
2000
TBD
Tags of associated with this question, comma seperated.
Preferences, Interests, Likes
Question Timestamp
question_timestamp
varchar
100
TBD
The timestamp of when this question was created.
1638375529
Question Version History
question_version_history
blob
TBD
JSON BLOB, contains the question version, content, change description
"{"question_version" : "What is your favourite colour?", "content" : "blue, red, pink, yellow", , "descriptio\" : "The preferred colour of the user."}"
Question Version Id
question_version_id
varchar
500
TBD
The Version ID of this question. Not Null
7
Question Modified Timestamp
queston_modified_timestamp
varchar
100
TBD
The timestamp of when this question was last modified.
1639153129
Questions and Answers Source
source
varchar
30
TBD
The source of the data - user or connection.
Queue
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Completed
completed
int
1
TBD
Whether or not this is a completed queue item.
Completed time
completed_time
int
TBD
Timestamp of when the queue item was completed.
Created
created
int
TBD
Timestamp when the queue item was created.
Data
data
blob
TBD
The arbitrary data for the item.
Message
message
text
TBD
Message for the queue item.
Short message
short_message
text
TBD
Short Message for the queue item.
Status type
status_type
varchar
255
TBD
status_type of the queue item."
Type
type
varchar
255
TBD
Type of the queue item"
TV Licence
11
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
County
field_tv_licence_county
varchar
255
TBD
The member's home county.
Essex
TV Licence Fee
field_tv_licence_fee
int
TBD
The TV licence fee.
Licence Holder's Name
field_tv_licence_holders_name
varchar
255
TBD
The name of licence holder.
Catherine Jones
TV Licence Number
field_tv_licence_number
varchar
255
TBD
The TV licence number.
Payment Frequency
field_tv_licence_payment_freq
varchar
255
TBD
The TV licence payment frequency.
Payment Method
field_tv_licence_payment_method
varchar
255
TBD
The TV licence payment method.
Post Code
field_tv_licence_post_code
varchar
255
TBD
The member's home postcode.
NB1 1AZ
Street
field_tv_licence_street
varchar
255
TBD
The member home house number and street name.
1 High Street
Town
field_tv_licence_town
varchar
255
TBD
The member's home town.
Watford
TV Licence Type
field_tv_licence_type
varchar
255
TBD
The TV licence type.
Valid Until
field_tv_licence_valid_until
int
TBD
The expiration date of the TV licence.
Address Book Collection
9
87
Expand
Dataset Name
Fields Count
Address
12
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Country
country
varchar
2000
TBD
Country
Spain
County
county
varchar
2000
TBD
County
Hampshire
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Name
name
varchar
2000
TBD
Name
The Oaks
Postcode
postcode
varchar
2000
TBD
Postcode
AB1 2CD
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Street
street
varchar
2000
TBD
Street
123 Sycamore Lane
Street line 2
street_line_2
varchar
2000
TBD
Second line of street
Town
town
varchar
2000
TBD
Town
Lanark
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
Communications
10
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Communication Type
comm_type
varchar
2000
TBD
Type of communication e.g. email, social media etc
Email, social media etc
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
Description
description
varchar
2000
TBD
Description
For friends only
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Organisation ID
org_id
int
TBD
Foreign key to id of the organisation in ds_organisation
2
Person ID
person_id
int
TBD
Foreign key to id of the person in ds_person
1
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
Value
value
varchar
2000
TBD
Specific value for this communication
my_name@email.com, @my_social_media_handle
Contacts
7
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Contact ID
contact_id
int
TBD
Foreign key to id of contact in either ds_person or ds_organisation
Contact Type
contact_type
varchar
2000
TBD
The type of contact i.e. "person" or "organisation
Created Time Stamp
created_timestamp
int
TBD
Created Timestamp
id
id
serial
TBD
The primary identifier for this record.
instance
instance
int
TBD
The instance this record relates to.
source
source
varchar
30
TBD
The source of the data - user or connection.
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
Organisation
7
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Organisation name
organisation_name
varchar
2000
TBD
Organisation full name
British Broadcasting Company
Short name
short_name
varchar
2000
TBD
Short name
BBC
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
Person
16
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Anniversary
anniversary
int
TBD
Anniversary
1648633780
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
Date of birth
d_o_b
int
TBD
The person's date of birth
1648633780
First name
first_name
varchar
2000
TBD
First name
Joe, Jane, Ann, Michael etc
Gender
gender
varchar
2000
TBD
Gender
Female, male, non-binary etc
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Language
language
varchar
2000
TBD
Language
English, French, Urdu etc
Middle name(s)
middle_names
varchar
2000
TBD
Middle name(s)
Joe, Jane, Ann, Michael etc
Nickname
nickname
varchar
2000
TBD
Nickname
Freddy, Pete, Soph, Mandy, Terry etc
Notes
notes
varchar
2000
TBD
Notes about this person
Lives with me
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Suffix
suffix
varchar
2000
TBD
Suffix
PhD, CCNA, OBE etc
Surname
surname
varchar
2000
TBD
Surname
Fitzpatrick, Khan, Simmons, Smith etc
Title
title
varchar
2000
TBD
Title
Ms, Mrs, Mr, Dr, Prof etc
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
Relationship
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Person 1 ID
person1_id
int
TBD
Foreign key to id of person 1
1
Person 2 ID
person2_id
int
TBD
Foreign key to id of person 2
2
Relationship type
relationship_type
varchar
2000
TBD
Describes the relationship between these two people
Sister, brother, friend, mother, uncle
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
xref_org_addr
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Address ID
address_id
int
TBD
Foreign key to id of the address in ds_address
2
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
Description
description
varchar
2000
TBD
Description
Main office
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Organisation ID
org_id
int
TBD
Foreign key to id of the organisation in ds_organisation
1
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
xref_person_addr
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Address ID
address_id
int
TBD
Foreign key to id of the address in ds_address
2
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
Description
description
varchar
2000
TBD
Description
Home
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Person ID
person_id
int
TBD
Foreign key to id of the person in ds_person
1
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
xref_person_org
11
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
Department
department
varchar
2000
TBD
Department
Development
ID
id
serial
TBD
The primary identifier for this record.
5
Instance
instance
int
TBD
The instance this record relates to.
5
Job Title
job_title
varchar
2000
TBD
Job title
Front-end developer
Manager Name
manager_name
varchar
2000
TBD
Manager name
Ben Whittly
Office
office
varchar
2000
TBD
Office
Front end devs
Organisation ID
org_id
int
TBD
Foreign key to id of the organisation in ds_organisation
2
Person ID
person_id
int
TBD
Foreign key to id of the person in ds_person
1
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id or members mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
Digital Asset Records
3
27
Expand
Dataset Name
Fields Count
Assets
13
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Addition Data
additional_data
blob
TBD
Additional associated data.
created
created
int
TBD
Timestamp when file was uploaded.
dataset
dataset
varchar
30
TBD
The dataset the asset belongs to.
File Path
file_path
varchar
100
TBD
The filepath of the record.
File Size
file_size
int
TBD
Size of file.
File Type
file_type
varchar
20
TBD
The type of file.
id
id
serial
TBD
The primary identifier for this assets data record.
instance
instance
int
TBD
The instance this assets data record relates to.
modified
modified
int
TBD
Timestamp when file was re-uploaded.
source
source
varchar
30
TBD
The source of the data - user or connection (uid or con_id).
Member Note
user_note
varchar
200
TBD
Associated user note.
verified
verified
int
1
TBD
Boolean indicating whether or not the asset is verified.
version
version
int
TBD
Version of asset.
Assets Images
6
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Asset id
asset_id
int
TBD
The ID of the associated asset.
Bits
bits
int
TBD
The number of bits for each color.
Channels
channels
int
TBD
Number of channels.
Height
height
int
TBD
The image height.
Mime type
mime_type
varchar
30
TBD
The mime type of the image.
Width
width
int
TBD
The image width.
Assets PDFs
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Asset id
asset_id
int
TBD
The ID of the associated asset.
Creation date
creation_date
int
TBD
Timestamp of creation date.
Creator
creator
varchar
100
TBD
The creator of the document.
Keywords
keywords
varchar
100
TBD
Keywords of document.
Mime type
mime_type
varchar
30
TBD
The mime type of the image.
Producer
producer
varchar
100
TBD
The document producer.
Subject
subject
varchar
100
TBD
The document subject.
Title
title
varchar
100
TBD
The document title.
Identity Collection
4
42
Expand
Dataset Name
Fields Count
Assurance Log
9
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Date Created
assurance_created
int
TBD
The timestamp of the created Assurance record.
Data Used
assurance_data_used
varchar
TBD
The actual data used to gain the assurance level.
IDP
assurance_idp
varchar
100
TBD
The IDP of the assurance record.
Assurance Level
assurance_level
int
TBD
The level of assurance.
Matching Datasets
assurance_matching_datasets
varchar
TBD
The matching datasets used for the assurance level.
PID
assurance_pid
varchar
32
TBD
The PID of the record (GOV.UK Assurance).
Assurance Log ID
id
serial
TBD
The primary identifier for Assurance record.
Assurance Log Instance
instance
int
TBD
The instance this transaction relates to.
Assurance Log Source
source
varchar
30
TBD
The source of the data - user or connection.
Identity Protocol Settings
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Identity Protocol Settings ID
id
serial
TBD
The primary identifier for Identity Service protocol.
4
Name
identity_protocol
varchar
50
TBD
The name of the Identity protocol.
Profile
Email Setting
identity_protocol_email_setting
int
TBD
The email preference for this protocol.
John@email.com
Email Setting Text
identity_protocol_email_setting_text
varchar
50
TBD
This will either be an email address or message text.
John@email.com
ID
identity_protocol_id
varchar
50
TBD
The ID used with this protocol.
2
Status
identity_protocol_status
int
TBD
Whether Identity protocol is enabled.
1
Identity Protocol Settings Instance
instance
int
TBD
The instance this transaction relates to.
3
Identity Protocol Settings Source
source
varchar
30
TBD
The source of the data - user or connection.
Identity Services Log
10
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
ID
id
serial
TBD
The primary identifier for Identity Service record.
1
Identity service annotation
identity_service_annotation
text
TBD
The service log annotation by the user.
Identity service created
identity_service_created
int
TBD
The timestamp of the created Identity Service.
Status
identity_service_status
int
TBD
Boolean indicating whether the Identity was successfully used.
1
Identity service tags
identity_service_tags
varchar
1000
TBD
The log tags comma separated.
Title
identity_service_title
varchar
50
TBD
The Identity Service Title.
Project A
Identity service type
identity_service_type
varchar
30
TBD
The Identity Service type.
Identity service url
identity_service_url
varchar
2000
TBD
The Identity Service URL.
Instance
instance
int
TBD
The instance this transaction relates to.
2
Ip address
ip_address
varchar
50
TBD
The IP address of the request.
MFA Settings
15
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
created
created
int
TBD
Created Timestamp
digest
digest
varchar
10
TBD
The digest used with this OTP.
digits
digits
int
TBD
Number of digits for the OTP code.
email
email
varchar
50
TBD
Email address.
id
id
serial
TBD
The primary identifier for Identity Service record.
instance
instance
int
TBD
The instance this transaction relates to.
mobile
mobile
varchar
50
TBD
Mobile number.
name
name
varchar
50
TBD
The name of the device
period
period
int
TBD
Period for the OTP to be valid.
preferred
preferred
int
TBD
Device is the preferred MFA device.
secret
secret
varchar
1000
TBD
OTP device secret.
source
source
varchar
30
TBD
The source of the data - user or connection.
status
status
int
TBD
Status
type
type
varchar
10
TBD
Type of OTP device.
updated
updated
int
TBD
Updated Timestamp
Financial Services
4
48
Expand
Dataset Name
Fields Count
Bank Account
18
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Account Name
field_ba_account_name
varchar
2000
TBD
The members account name
Mr Joe Bloggs
Account Number
field_ba_account_number
varchar
2000
TBD
The members account number
12345678
Bank Name
field_ba_bank_name
varchar
2000
TBD
The name of the members bank
HSBC
Branch
field_ba_branch
varchar
2000
TBD
The members branch name
Watford
Branch Address Country
field_ba_branch_country
varchar
2000
TBD
The bank country
England
Branch Address County
field_ba_branch_county
varchar
2000
TBD
The bank county
Essex
Branch Address PostCode
field_ba_branch_postcode
varchar
2000
TBD
The bank postcode
NB1 1AZ
Branch Address Street
field_ba_branch_street
varchar
2000
TBD
The bank street name and building name/ number
1 High Street
Branch Address Telephone
field_ba_branch_telephone
varchar
2000
TBD
The bank telephone number
(44) 01234 123456
Branch Address Town
field_ba_branch_town
varchar
2000
TBD
The bank town
Watford
Current Balance
field_ba_current_balance
int
TBD
The current balance on the account
23.45
Field ba current balance code
field_ba_current_balance_code
varchar
2000
TBD
The currency code from bank account balance
Date From
field_ba_date_from
int
TBD
The date the member opened the account
29222
Date To
field_ba_date_to
int
TBD
The date the member closed the account
29222
Overdraft Limit
field_ba_overdraft_limit
int
TBD
The overdraft limit on the account
200
Field ba overdraft limit code
field_ba_overdraft_limit_code
varchar
2000
TBD
The currency code from bank account overdraft
Sort Code
field_ba_sort_code
varchar
2000
TBD
The sort code on the members account
xx-xx-xx
Type
field_ba_type
varchar
2000
TBD
The type of bank account held by the member
Savings
Bank Account Transactions
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Transactions Date
ba_transaction_date
int
TBD
Transaction date - unix timestamp
29222
Transactions Description
ba_transaction_description
varchar
255
TBD
The transaction description.
Salary
Transactions Transaction Type
ba_transaction_type
varchar
255
TBD
The transaction type provided by organisation.
Direct Debit
Transactions Value
ba_transaction_value
numeric
TBD
The transaction value.
111.11
Currency Code
ba_transaction_value_currency_code
varchar
10
TBD
The transaction value currency code.
GBP
Bank Account Transaction ID
id
serial
TBD
The primary identifier for a transaction.
5
Bank Account Transaction Instance
instance
int
TBD
The instance this transaction relates to.
8
Bank Account Transaction Source
source
varchar
30
TBD
The source of the data - user or connection.
Credit Card
14
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Account Name
field_cc_account_name
varchar
255
TBD
The member's surname on the card.
Jones
Account Number
field_cc_account_number
varchar
255
TBD
The account number.
12345678
Card Type
field_cc_card_type
varchar
255
TBD
The type of credit card.
VISA
Contact Address Country
field_cc_contact_country
varchar
255
TBD
The member's contact country.
England
Contact Address County
field_cc_contact_county
varchar
255
TBD
The member's contact county.
Essex
Contact Address PostCode
field_cc_contact_postcode
varchar
255
TBD
The member's contact postcode.
NB1 1AZ
Contact Address Street
field_cc_contact_street
varchar
255
TBD
The member contact house number and street name.
1 High Street
Contact Address Telephone
field_cc_contact_telephone
varchar
255
TBD
The member's contact telephone number.
(44) 01234 123456
Contact Address Town
field_cc_contact_town
varchar
255
TBD
The member's contact town.
Watford
Credit Limit
field_cc_credit_limit
int
TBD
The credit limit.
2000
Balance
field_cc_current_balance
float
TBD
The current balance of the credit card.
245.67
Date From
field_cc_date_from
int
TBD
The date the member opened the account.
29222
Date To
field_cc_date_to
int
TBD
The date the member closed the account.
29222
Supplier
field_cc_supplier
varchar
255
TBD
The credit card supplier.
HSBC
Credit Card Transactions
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Transactions Date
cc_transaction_date
int
TBD
Transaction date - unix timestamp
29222
Transactions Description
cc_transaction_description
varchar
255
TBD
The transaction description.
Cash
Transactions Transaction Type
cc_transaction_type
varchar
255
TBD
The transaction type provided by organisation.
Transactions Value
cc_transaction_value
numeric
TBD
The transaction value.
111.11
Currency Code
cc_transaction_value_currency_code
varchar
10
TBD
The transaction value currency code.
GBP
Credit Card Transactions ID
id
serial
TBD
The primary identifier for a transaction.
5
Credit Card Transactions Instance
instance
int
TBD
The instance this transaction relates to.
8
Credit Card Transactions Source
source
varchar
30
TBD
The source of the data - user or connection.
Measurements Collection
10
164
Expand
Dataset Name
Fields Count
Blood Glucose Log
20
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Blood Glucose Level
blood_glucose_level
float
TBD
The blood glucose level or concentration
4.3
Measurement End Timestamp
blood_glucose_timestamp_end
int
TBD
End time and date of blood glucose measurement
1648633780
Measurement Start Timestamp
blood_glucose_timestamp_start
int
TBD
Start time and date of blood glucose measurement
1648633780
ID
id
serial
TBD
The primary identifier for this record.
1
Meal Type
meal_type
int
TBD
What type of meal the user ate around when the reading was taken.
3
Meal Type Description
meal_type_description
varchar
30
TBD
Description of Meal type
Lunch
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement id
measurement_id
int
TBD
The key that links to Measurement Log
Nutrition Log ID
nutrition_log_id
int
TBD
The link to the nutrition log record
1
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Specimen Source
specimen_source
int
TBD
Type of body fluid used to measure blood glucose
4
Specimen Source Description
specimen_source_description
varchar
30
TBD
Type of body fluid used to measure blood glucose
Serum
Temporal relation to meal
temporal_relation_to_meal
int
TBD
When reading taken compared to when person ate
4
Temporal relation to meal description
temporal_relation_to_meal_description
varchar
30
TBD
When reading taken compared to when person ate description
Reading was taken after a meal
Temporal relation to sleep
temporal_relation_to_sleep
int
TBD
When the reading was taken compared to when the user slept.
1
Temporal relation to sleep
temporal_relation_to_sleep_description
varchar
30
TBD
Description of when the reading was taken compared to when the user slept
User was fully awake
Blood Pressure Log
16
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Measurement Timestamp End
blood_pressure_timestamp_end
int
TBD
End time and date of blood pressure measurement
1648633780
Measurement Timestamp Start
blood_pressure_timestamp_start
int
TBD
Start time and date of blood pressure measurement
1648633780
Body Position
body_position
int
TBD
Code defining the body position
1
Body Position Description
body_position_description
varchar
30
TBD
Position of body during measurement
Standing
Diastolic
diastolic
float
TBD
The diastolic measurement in mmHg
75.7
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Measurement Location
measurement_location
int
TBD
code defing the location on the body where pressure reading taken
1
Measurement Location Description
measurement_location_description
varchar
30
TBD
Description of the location on the body where pressure reading taken
Left Wrist
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Systolic
systolic
float
TBD
The systolic measurement in mmHg
120.7
Body Temperature Log
13
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Body Temperature
body_temperature
float
TBD
Body Temperature
36.7
Body Temperature Measurement Location
body_temperature_measurement_location
int
TBD
Where temperature was taken on body
3
Body Temperature Measurement Location Description
body_temperature_measurement_location_description
varchar
30
TBD
Description of where temperature was taken on body
Forehead
End Measurement Timestamp
body_temperature_timestamp_end
int
TBD
End time and date of body temperature measurement
1648633780
Start Measurement Timestamp
body_temperature_timestamp_start
int
TBD
Start time and date of body temperature measurement
1648633780
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Cervical Mucus Log
13
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Cervical mucus amount
cervical_mucus_amount
int
TBD
Amount of cervical mucus
1
Cervical mucus amount description
cervical_mucus_amount_description
varchar
30
TBD
Description of amount of cervical mucus
Light
Cervical mucus texture
cervical_mucus_texture
int
TBD
Classification of mucus texture
1
Cervical mucus texture description
cervical_mucus_texture_description
varchar
30
TBD
Description of classification of mucus texture
Dry, little or no mucus
Measurement Timestamp
cervical_mucus_timestamp
int
TBD
Time and Date of cervical mucus measurement
1648633780
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Cervical Position Log
16
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Cervical Dilation
cervical_dilation
int
TBD
How open or dilated is cervix
2
Cervical Dilation Description
cervical_dilation_description
varchar
30
TBD
Description of how open or dilated is cervix
Partially open cervix
Cervical Firmness
cervical_firmness
int
TBD
How firm the cervix is
3
Cervical Firmness Description
cervical_firmness_description
varchar
30
TBD
Description of how firm the cervix is
Cervix is firm
Cervical Position
cervical_position
int
TBD
Position of Cervix
1
Cervical Position description
cervical_position_description
varchar
30
TBD
Description of the Position of Cervix
Cervix is Low
Measurement End Timestamp
cervical_position_measurement_timestamp_end
int
TBD
Cervical Mucus measurement end date and time
1648633780
Measurement Start Timestamp
cervical_position_measurement_timestamp_start
int
TBD
Cervical Mucus measurement start date and time
1648633780
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Measurements Log
13
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement field type
measurement_field_type
varchar
30
TBD
How to treat the value stored in measurement value
Integer
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement timestamp Stop
measurement_timestamp_end
int
TBD
The end time of the measurement
1648633780
Measurement timestamp Start
measurement_timestamp_start
int
TBD
The start time of the measurement
1648633780
Measurement Type
measurement_type
varchar
30
TBD
Specific name given to the measurement being recorded
Calories Burned
Unit Measure
measurement_unit
varchar
30
TBD
The unit of value that the measure is made in
kcal
Measure Value
measurement_value
float
TBD
The measurement itself
1648633780
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
The instance of the source type
Source Name
source_name
varchar
30
TBD
The Name given to source
Google Fit
Nutrition Consumption Log
27
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Calories
calories
float
TBD
Calories
400
Cholesterol
cholesterol
float
TBD
Cholesterol
2
Dietary Fibre
dietary_fibre
float
TBD
Dietary Fibre
1.5
Saturated Fat
fat_saturated
float
TBD
Saturated Fat
9.8
Total Fat
fat_total
float
TBD
Total Fat
33.1
Unsaturated Fat
fat_unsaturated
float
TBD
Unsaturated Fat
11.1
Food Item
food_item
varchar
30
TBD
Food item
Banana
ID
id
serial
TBD
The primary identifier for this record.
1
Meal End timestamp
meal_timestamp_end
int
TBD
End date and time of meal
1648633780
Meal Start Timestamp
meal_timestamp_start
int
TBD
Start date and time of meal
1648633780
Meal Type
meal_type
int
TBD
The type of meal
2
Meal type description
meal_type_description
varchar
30
TBD
Description of Meal type
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Monounsaturated fat
monounsaturated_fat
float
TBD
Monounsaturated fat
2
Nutrition Log ID
nutrition_log_id
int
TBD
The link to the nutrition log record
1
Polyunsaturated fat
polyunsaturated_fat
float
TBD
Polyunsaturated fat
1.5
Potassium
potassium
float
TBD
Potassium
1.8
Protein
protein
float
TBD
Protein
10
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Sodium
sodium
float
TBD
Sodium
1.1
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Sugar
sugar
float
TBD
Sugar
5
Total carbohydrates
total_carbohydrates
float
TBD
Total carbohydrates
34.7
Trans fat
trans_fat
float
TBD
Trans fat
8.7
Nutrition Log
12
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
ID
id
serial
TBD
The primary identifier for this record.
1
Meal End timestamp
meal_timestamp_end
int
TBD
End date and time of meal
1648633780
Meal Start Timestamp
meal_timestamp_start
int
TBD
Start date and time of meal
1648633780
Meal Type
meal_type
int
TBD
The type of meal
2
Meal Type Description
meal_type_description
varchar
30
TBD
Description of Meal type
Breakfast
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Oxygen Saturation Log
18
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Oxygen saturation
oxygen_saturation
float
TBD
The blood oxygen saturation reading as a percentage
95%
Oxygen saturation measurement method
oxygen_saturation_measurement_method
int
TBD
How oxygen saturation is measured.
1
Oxygen saturation measurement method Description
oxygen_saturation_measurement_method_description
varchar
30
TBD
Description of how oxygen saturation is measured.
Pulse oximetry
Measurement End timestamp
oxygen_saturation_measurement_timestamp_end
int
TBD
End time and date of oxygen saturation measurement
1648633780
Measurement Start timestamp
oxygen_saturation_measurement_timestamp_start
int
TBD
Start time and date of oxygen saturation measurement
1648633780
Oxygen saturation system
oxygen_saturation_system
int
TBD
Where oxygen saturation is measured
1
Oxygen saturation system description
oxygen_saturation_system_description
varchar
30
TBD
Description of where oxygen saturation is measured
Peripheral capillaries
Oxygen therapy administration mode
oxygen_therapy_administration_mode
int
TBD
How oxygen therapy is administered
1
Oxygen therapy administration mode description
oxygen_therapy_administration_mode_description
varchar
30
TBD
Description of How oxygen therapy is administered
Nasal Canula
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Google Account 1
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Supplemental oxygen flow rate
supplemental_oxygen_flow_rate
int
TBD
The rate additional oxygen is supplied to a user in liters per minute. Set to zero if no supplemental
0
Workout Log
16
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Exercise Description
exercise_description
varchar
30
TBD
The description of the exercise type
Back Extension
Duration
exercise_duration
int
TBD
The amount of time exercise performed
60
Repetitions
exercise_repetitions
int
TBD
Number of repetitions of an exercise.
10
Exercise end timestamp
exercise_timestamp_end
int
TBD
End time and date Exercise recorded
1648633780
Exercise start timestamp
exercise_timestamp_start
int
TBD
Start time and date Exercise recorded
1648633780
Exercise Type
exercise_type
varchar
30
TBD
Values representing different exercises
back_extension
ID
id
serial
TBD
The primary identifier for this record.
1
Measurement Group
measurement_group
varchar
30
TBD
The top level group activity belongs to
Activity
Measurement Log ID
measurement_id
int
TBD
The key that links to Measurement Log
1
Created Timestamp
record_created_timestamp
int
TBD
Date record added to PDS
1648633780
Updated Timestamp
record_updated_timestamp
int
TBD
Date record updated in the PDS
1648633780
Resistance
resistance_level
float
TBD
The resistance of the exercise (or weight), in kilograms.
20kg
Resistance Type
resistance_type
int
TBD
The type of resistance used during the exercise.
Source Device Type
source_device_type
varchar
30
TBD
States the type of source device
PDA
Source Instance
source_instance
int
TBD
the instance of the source type
Source Name
source_name
varchar
30
TBD
The name given to source
Google Fit
Online Activity
2
26
Expand
Dataset Name
Fields Count
Bookmarks
17
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Bookmark Annotation
bookmark_annotation
text
TBD
The bookmark annotation by the user.
Great stuff.
Browser
bookmark_browser
varchar
100
TBD
The browser this bookmark was captured on.
Bookmark Created
bookmark_created
int
TBD
The created timestamp.
1343844034
Bookmark Description
bookmark_description
text
TBD
The bookmark description.
The Space is a digital arts service from Arts Council England and the BBC, bringing great theatre, concerts, opera, dance, film and more to every screen.
Device Name
bookmark_device_name
varchar
100
TBD
The name of the device this bookmark was captured on.
Bookmark Media Duration
bookmark_duration
int
TBD
The media duration.
0.458321759259259
Bookmark Media Height
bookmark_height
int
TBD
The media height.
400px
Bookmark Media Type
bookmark_media_type
varchar
100
TBD
The bookmark media type.
page
Bookmark Modified
bookmark_modified
int
TBD
The modified timestamp.
1343844034
Tab
bookmark_tab
varchar
100
TBD
The tab this bookmark was captured on.
Bookmark Tags
bookmark_tags
varchar
1000
TBD
The tags comma separated.
arts, media
Bookmark Title
bookmark_title
varchar
512
TBD
The bookmark title.
The Space
Bookmark URL
bookmark_url
varchar
2000
TBD
The bookmark url.
http://thespace.org/
Bookmark Media Width
bookmark_width
int
TBD
The media width.
800px
Bookmark ID
id
serial
TBD
The primary identifier for a bookmark.
5
Bookmark Instance
instance
int
TBD
The instance this bookmark relates to.
8
Bookmark Source
source
varchar
30
TBD
The source of the data - user or connection.
Browsing History
9
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Browser
browsing_history_browser
varchar
100
TBD
The browser this history was captured on.
Device Name
browsing_history_device_name
varchar
100
TBD
The name of the device this history was captured on.
Tab
browsing_history_tab
varchar
100
TBD
The tab this history was captured on.
Browsing History Title
browsing_history_title
varchar
512
TBD
The history title.
The Space
Browsing History URL
browsing_history_url
varchar
2000
TBD
The history url.
http://thespace.org/
Browsing History Visit Date
browsing_history_visit_date
int
TBD
The visit date timestamp.
1343844034
Browsing History ID
id
serial
TBD
The primary identifier for a history item.
5
Browsing History Instance
instance
int
TBD
The instance this history item relates to.
8
Browsing History Source
source
varchar
30
TBD
The source of the data - user or connection.
Profiles Collection
4
22
Expand
Dataset Name
Fields Count
Community Profile
5
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
About Me
field_cp_about_me
TBD
Community Roles
field_cp_community_roles
TBD
Community Membership Preferences
field_cp_com_membership_prefs
TBD
Display Name
field_cp_display_name
TBD
Website
field_cp_website
TBD
Intentions
1
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
When is my travel insurance due?
field_int_travel_insurance_due
date
TBD
Date when the user's travel insurance is due
Profiles
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1641909333
Profile Content
profile_content
blob
TBD
The actual profile data mapping data from the citizens PDS and tags added and any calculated values
{"description":"This profile is for showing interest in Community Services and engagement","tags":["G41","Museums","Theatre","Music","Pop Culture"]}
Profile description
profile_description
varchar
TBD
The description of the profile
Profile ID
profile_id
varchar
TBD
The unique id for this profile
34
Profile Name
profile_name
varchar
TBD
The name of the profile
Community Services
Profile Shared With
profile_shared_with
blob
TBD
States which app this profile has been shared to
Inclued Citizen
Profile Source
profile_source
varchar
TBD
From which app the profile was created/updated from
inclued-citizen
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1641909333
Profiles Preferences
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Profiles Preferences ID
id
serial
TBD
The primary identifier for this record.
1
Profiles Preferences Instance
instance
int
TBD
The instance this item relates to.
1
Persona Name
persona_name
varchar
2000
TBD
Name of Persona this preference is associated with
Mary Led
Preference Content
preference_content
blob
TBD
Preference Content
culture, sports, art
Preference Created Timestamp
preference_created_timestamp
int
TBD
Preference Created Timestamp
1638375529
Preference Name
preference_name
varchar
2000
TBD
Name for this preference
Interests
Preference Updated Timestamp
preference_updated_timestamp
int
TBD
Preference Updated Timestamp
1639153129
Profiles Preferences Source
source
varchar
30
TBD
The source of the data - user or connection.
Connection Specific
3
14
Expand
Dataset Name
Fields Count
Connection Variables
2
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Variable Name
var_name
varchar
100
TBD
The name of the variable.
Test
Variable Value
var_value
blob
TBD
The value of the variable stored in a blob.
{"var": "test"}
Feature Access
6
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Connection ID
con_id
int
TBD
The connection id
id
id
serial
TBD
The primary identifier for this record.
instance
instance
int
TBD
The instance this record relates to.
Method
method
varchar
255
TBD
The method of the feature route
Path
path
varchar
255
TBD
The path of the feature
source
source
varchar
30
TBD
The source of the data - user or connection.
PDX Notifications
6
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Connection ID
con_id
varchar
30
TBD
The connection id
Dataset Name
dataset_machine_name
varchar
30
TBD
The dataset machine name of the dataset wanting notifications
Fields
fields
blob
TBD
JSON blob of the fields within a dataset wanting notifications
id
id
serial
TBD
The primary identifier for this record.
instance
instance
int
TBD
The instance this item relates to.
source
source
varchar
30
TBD
The source of the data - user or connection.
Device Records
3
36
Expand
Dataset Name
Fields Count
Device App Settings
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
App Name
app_setting_app_name
varchar
50
TBD
The name of the app.
Messaging app
Device Name
app_setting_device_name
varchar
50
TBD
The name of the Device.
Tablet
Setting Name
app_setting_name
varchar
100
TBD
The name of the variable.
Switched on
Setting Type
app_setting_type
varchar
50
TBD
The type of setting. Value, Boolean (yes/no, on/off), Range (0 100 45).
yes/no
Setting Value
app_setting_value
varchar
1000
TBD
The value/status of the variable.
yes
Device App Settings ID
id
serial
TBD
The primary identifier for this record.
1
Device App Settings Instance
instance
int
TBD
Instance - only because the API expects an instance.
4
Device App Settings Source
source
varchar
30
TBD
The source of the data - user or connection.
Device Log
12
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Action
action
varchar
20
TBD
Action.
45
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1642137111
End Timestamp
end_time
int
TBD
End Timestamp
1642137111
Event ID
event_id
int
TBD
Event ID.
45
External ID
external_id
text
TBD
External ID.
1
ID
id
serial
TBD
The primary identifier for this record.
Instance
instance
int
TBD
The instance this item relates to.
Log Time
log_time
int
TBD
When the sensor value was detected.
1642137111
Sensor Type ID
sensor_type_id
int
TBD
The type of the sensor (for devices with multiple sensors).
123
Sensor Value
sensor_value
float
TBD
The value of the sensor.
123
Source
source
varchar
30
TBD
The source of the data - user or connection.
Start Timestamp
start_time
int
TBD
Start Timestamp
123
Device Record
16
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Building ID
building_id
int
TBD
Building ID.
1
IMEI
device_imei
varchar
20
TBD
The IMEI of the device.
186122708298561
MAC Address
device_mac_address
varchar
80
TBD
The MAC Address of the device.
01-23-45-67-89-AB
Model Number
device_model_number
varchar
100
TBD
The model number of the device.
123AM45678
Name
device_name
varchar
50
TBD
Device Name.
Tablet-John
Phone Number
device_phone_number
varchar
15
TBD
The phone number of the device.
07123456789
Serial Number
device_serial_number
varchar
50
TBD
The serial number of the device.
AB123456BC7
Software Version Number
device_software_version_number
varchar
50
TBD
The software version number the device is running.
10.1
Type
device_type
varchar
20
TBD
Device Type.
Tablet
External ID
external_id
int
TBD
External ID.
1
Device Record ID
id
serial
TBD
The primary identifier for a device record.
1
Device Record Instance
instance
int
TBD
The instance this device record relates to.
2
Memo
memo
varchar
1000
TBD
Memo
Description of the device
Device Record Source
source
varchar
30
TBD
The source of the data - user or connection (uid or con_id).
Status
status
int
TBD
Status.
1
User ID
user_id
int
TBD
User ID.
1
Utility Services Collection
7
82
Expand
Dataset Name
Fields Count
Energy Consumption
9
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Timestamp of when record was created.
1641909333
Energy account instance
energy_account_instance
int
TBD
The energy account this data is linked to.
Home ID
field_energy_homeid
int
TBD
The HomeID where the device is located.
1
Reading timestamp
field_energy_reading_timestamp
int
TBD
The data and time for a specific reading.
1648633780
Reading Value
field_energy_reading_value
int
TBD
The energy reading value. Watt
1123.25
Source ID
field_energy_source_index_id
varchar
30
TBD
Unique identifier for the source device.
1
Source Name
field_energy_source_name
varchar
30
TBD
A human meaningful label for the source device. Source device from ds_device_record
Kettle
Source Type
field_energy_source_type
varchar
30
TBD
Identifies the type of reading device. CAD, CLIP or IAM
CAD
Updated Timestamp
updated_timestamp
int
TBD
Timestamp of when record was last updated.
1641909333
Energy Consumption Aggregated
9
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Timestamp of when record was created.
1641909333
Energy Account
energy_account_instance
int
TBD
The energy account this data is linked to.
8
Home ID
field_energy_homeid
int
TBD
The HomeID where the device is located.
1
Reading timestamp
field_energy_reading_timestamp
int
TBD
The data and time for a specific reading.
1648633780
Reading Value
field_energy_reading_value
int
TBD
The energy reading value. kWh
1123.25
Source ID
field_energy_source_index_id
varchar
30
TBD
Unique identifier for the source device.
1
Source Name
field_energy_source_name
varchar
30
TBD
A human meaningful label for the source device. Source device from ds_device_record
Kettle
Source Type
field_energy_source_type
varchar
30
TBD
Identifies the type of reading device. CAD, CLIP or IAM
CAD
Updated Timestamp
updated_timestamp
int
TBD
Timestamp of when record was last updated.
1641909333
Telephone Calls and SMS
11
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Telephone Calls ID
id
serial
TBD
The primary identifier for a utility transaction.
5
Telephone Calls Instance
instance
int
TBD
The instance this transaction relates to.
8
Telephone Calls Source
source
varchar
30
TBD
The source of the data - user or connection.
Telecoms Transactions Charge Type
utility_tel_call_charge_type
varchar
255
TBD
The charge type Variable by operator.
Included
Telecoms Transactions Cost
utility_tel_call_cost
numeric
TBD
The cost of the call.
122.22
Currency Code
utility_tel_call_currency_code
varchar
10
TBD
The call cost currency code.
GBP
Telecoms Transactions Date
utility_tel_call_date
int
TBD
Call date - unix timestamp.
29222
Telecoms Transactions Duration
utility_tel_call_duration
int
TBD
The duration of the call (seconds).
0.050138888888889
Incoming/Outgoing
utility_tel_call_incoming_outgoing
varchar
10
TBD
Is this record an incoming or outgoing call/sms.
Telecoms Transactions Number Called
utility_tel_call_number_called
varchar
255
TBD
Telephone number called
(44) 01234 123456
Telecoms Transactions Transaction Type
utility_tel_call_type
varchar
255
TBD
The call type. Variable by operator
Call or SMS
Utility Account Details
29
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Account Name
field_utility_account_name
varchar
255
TBD
The member's surname.
Jones
Account Type
field_utility_account_type
varchar
255
TBD
The type of utility account held by the member.
Pay as you go
Billing Address Country
field_utility_billing_country
varchar
255
TBD
The member's home country.
England
Billing Address County
field_utility_billing_county
varchar
255
TBD
The member's home county.
Essex
Billing Address PostCode
field_utility_billing_postcode
varchar
255
TBD
The member's home postcode.
NB1 1AZ
Billing Address Street
field_utility_billing_street
varchar
255
TBD
The member home house number and street name.
1 High Street
Billing Address Town
field_utility_billing_town
varchar
255
TBD
The member's home town.
Watford
Contact Address Country
field_utility_contact_country
varchar
255
TBD
The utility company country.
England
Contact Address County
field_utility_contact_county
varchar
255
TBD
The utility company county.
Essex
Contact Address eMail
field_utility_contact_email
varchar
255
TBD
The utility company email address.
name@utilityprovider.com
Contact Address Fax
field_utility_contact_fax
varchar
255
TBD
The utility company fax number.
(44) 01234 123456
Contact Address Contact Name
field_utility_contact_name
varchar
255
TBD
The name of the contact at the utility company.
Fred Bloggs
Contact Address PostCode
field_utility_contact_postcode
varchar
255
TBD
The utility company postcode.
NB1 1AZ
Contact Address Street
field_utility_contact_street
varchar
255
TBD
The utility company street name and building name/number.
1 High Street
Contact Address Telephone
field_utility_contact_telephone
varchar
255
TBD
The utility company telephone number.
(44) 01234 123456
Contact Address Town
field_utility_contact_town
varchar
255
TBD
The utility company town.
Watford
Customer No
field_utility_customer_num
varchar
255
TBD
The member's customer account number for the utility supply.
12345678
Date From
field_utility_date_from
varchar
255
TBD
The date supply commenced.
29222
Date To
field_utility_date_to
varchar
255
TBD
The date supply ceased.
29222
Payment Method
field_utility_payment_method
varchar
255
TBD
The payment method used by the member.
Direct Debit
Service
field_utility_service
varchar
255
TBD
The utility service supplied to the member.
Gas
Supplied Address Country
field_utility_supplied_country
varchar
255
TBD
The member's home country.
England
Supplied Address County
field_utility_supplied_county
varchar
255
TBD
The member's home county.
Essex
Supplied Address PostCode
field_utility_supplied_postcode
varchar
255
TBD
The member's home postcode.
NB1 1AZ
Supplied Address Street
field_utility_supplied_street
varchar
255
TBD
The member supplied house number and street name.
1 High Street
Supplied Address Town
field_utility_supplied_town
varchar
255
TBD
The member's home town.
Watford
Supplier Name
field_utility_supplier_name
varchar
255
TBD
The utility service supplier.
British Gas
Tariff
field_utility_tariff
varchar
255
TBD
Tariff or plan basis for consumption.
Tel Number
field_utility_tel_number
varchar
255
TBD
The member's telephone number.
(44) 01234 123456
Utility Billing Records
7
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Utility Billing ID
id
serial
TBD
The primary identifier for a utility transaction.
5
Utility Billing Instance
instance
int
TBD
The instance this transaction relates to.
8
Utility Billing Source
source
varchar
30
TBD
The source of the data - user or connection.
Utility Transactions Billing Period End
utility_billing_end
int
TBD
Billing period end - unix timestamp.
Utility Transactions Billing Period Start
utility_billing_start
int
TBD
Billing period start - unix timestamp
Utility Transactions Cost
utility_billing_total
numeric
TBD
Billing total.
122.22
Currency Code
utility_billing_total_currency_code
varchar
10
TBD
The billing total currency code.
GBP
Utility Data Usage
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Data Usage ID
id
serial
TBD
The primary identifier for a utility transaction.
5
Data Usage Instance
instance
int
TBD
The instance this transaction relates to.
8
Data Usage Source
source
varchar
30
TBD
The source of the data - user or connection.
Data Transactions Charge Type
utility_data_usage_charge_type
varchar
255
TBD
The data usage charge type. Variable by operator
Included
Data Transactions Cost
utility_data_usage_cost
numeric
TBD
The cost of the data usage.
12.45
Currency Code
utility_data_usage_currency_code
varchar
10
TBD
The call cost currency code.
GBP
Data Transactions Data Used
utility_data_usage_data_used
numeric
TBD
The amount of data used.
2MB
Data Transactions Date
utility_data_usage_date
int
TBD
Usage date - unix timestamp.
41254
Utility Meter Readings
9
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Meter Reading ID
id
serial
TBD
The primary identifier for a utility transaction.
5
Utility Meter Reading Instance
instance
int
TBD
The instance this transaction relates to.
8
Utility Meter Reading Source
source
varchar
30
TBD
The source of the data - user or connection.
Utility Transactions Meter Reading
utility_reading
numeric
TBD
Meter reading amount.
Utility Transactions Meter Read Date
utility_reading_date
int
TBD
Meter read date - unix timestamp.
Utility Transactions Estimated
utility_reading_estimated
varchar
5
TBD
Boolean indicating whether the meter reading is estimated.
Y/N
Utility Transactions Read By
utility_reading_read_by
varchar
255
TBD
Metering unit.
Auto
Meter Reading Type
utility_reading_type
varchar
20
TBD
The type of meter reading (helps to distinguish on mixed bills).
Utility Transactions Metering Unit
utility_reading_unit
varchar
255
TBD
Metering unit.
kWh
Events Collection
3
55
Expand
Dataset Name
Fields Count
Events
19
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Action
action
text
TBD
The action to be invoked when an alarm is triggered.
Reminder
Attendee
attendee
text
TBD
The event attendee.
Mary
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1638375529
Description
description
text
TBD
The description of the event.
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
End Timestamp
end_timestamp
int
TBD
Unix Timestamp of when the event will stop.
1639153129
External Uid
external_uid
text
TBD
An external unique ID for an event
540
Events ID
id
serial
TBD
The primary identifier for this record.
5
Events Instance
instance
int
TBD
The instance this item relates to.
2
Location
location
text
TBD
The location of the event.
Edinburgh
Organiser
organiser
text
TBD
The event organiser.
Art Museum
Reminder Description
reminder_description
text
TBD
Description of the reminder event
In nulla urna, ullamcorper et ipsum id, bibendum iaculis nisi.
Events Source
source
varchar
30
TBD
The source of the data - user or connection.
Start Timestamp
start_timestamp
int
TBD
Unix Timestamp of when the event will start
1638375529
Status
status
varchar
TBD
The status of the event attendee. Either TENTATIVE, CONFIRMED or CANCELLED.
TENTATIVE
Tags
tags
text
TBD
The tags associated with the event (comma separated list).
The first day that we attended is the first day that we have started to introduce ourselves to friends and families. We wanted those who already know me
Referree Requirements
referree_requirements
text
TBD
The referree requirements.
Fruit, vegetables, legumes (e.g. lentils and beans), nuts and whole grains (e.g. unprocessed maize, millet, oats, wheat and brown rice).
Referrer Name
referrer_name
text
TBD
Romeo Santos
Service Description
service_description
text
TBD
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Service Email
service_email
text
TBD
service@email.com
Service ID
service_id
int
TBD
Service ID
56
Service Name
service_name
text
TBD
Service
Service Url
service_url
text
TBD
www.service.com
Referrals Source
source
varchar
30
TBD
The source of the data - user or connection.
Start Time
start_time
int
TBD
Start Time
1642137111
Status
status
text
TBD
The status of the referral.
waiting
Type
type
text
TBD
The type of the referral.
self referral
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1639153129
Referrals Log
10
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Action
action
varchar
20
TBD
Referring
End Time
end_time
int
TBD
1639153129
Referrals Log ID
id
serial
TBD
The primary identifier for this record.
2
Referrals Log Instance
instance
int
TBD
The instance this item relates to.
1
Responsible User ID
responsible_user_id
int
TBD
321
Service Order ID
service_order_id
int
TBD
Link to the service order.
5046
Referrals Log Source
source
varchar
30
TBD
The source of the data - user or connection.
Start Time
start_time
int
TBD
1638375529
Referral Status
status
int
TBD
The status of the service order.
Status
User ID
user_id
int
TBD
Link to the user who changed the order status.
87
Health Collection
4
67
Expand
Dataset Name
Fields Count
Health
14
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Member's CHI number
field_health_chi_number
varchar
2000
TBD
The members CHI number
www.terrace-medical-practice.com
GP Details Country
field_health_gp_country
varchar
2000
TBD
The country of the members GP
GP Details County
field_health_gp_county
varchar
2000
TBD
The county of the members GP
GP Details Email
field_health_gp_email
varchar
2000
TBD
The email address of the members GP
GP Details Fax
field_health_gp_fax
varchar
2000
TBD
The fax address of the members GP
GP Details GP Name
field_health_gp_name
varchar
2000
TBD
The name of the members GP
GP Details Postcode
field_health_gp_postcode
varchar
2000
TBD
The postcode of the members GP
GP Practice Name
field_health_gp_practice_name
varchar
2000
TBD
The name of the members GP practice
Terrace Medical Practice
GP Practice Website
field_health_gp_practice_website
varchar
2000
TBD
Website url of the members GP
www.terrace-medical-practice.com
GP Details Street
field_health_gp_street
varchar
2000
TBD
The street address of the members GP
GP Details Telephone
field_health_gp_telephone
varchar
2000
TBD
The telephone number of the members GP
GP Details Town
field_health_gp_town
varchar
2000
TBD
The town of the members GP
NHS Number
field_health_nhs_number
varchar
2000
TBD
The members NHS number
Social Care ID
field_health_social_care_id
text
60
TBD
The member's social care ID
Health and Social Care Records
14
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1638375529
Delivery Timestamp
delivery_timestamp
int
TBD
Timestamp of when the data payload was delivered to the PDS
1639153129
HSCR Data
hscr_data
blob
TBD
The full data from the originating source in whatever format it was delivered.
HSCR Data Format
hscr_data_format
varchar
50
TBD
This tells us what data structure standard we are receiving e.g OpenEHR, HL7,FHIR.
FHIR
HSCR Data Source
hscr_data_source
varchar
50
TBD
The data source that this HSCR originated from.
Social Care Professional
HSCR Delivery route
hscr_delivery_route
varchar
50
TBD
The name of the delivery route e.g. Health Data Exchange, Lenus Platform.
Lenus Platform
HSCR Title
hscr_title
varchar
50
TBD
Extracted from the payload a human readable name for the data payload
HSCR ID
id
serial
TBD
The primary identifier for this record.
1
HSCR Instance
instance
int
TBD
The instance this item relates to.
1
HSCR Source
source
varchar
30
TBD
The source of the data - user or connection.
HSCR Source ID
source_id
varchar
50
TBD
This will be meta data about the record from the source.
HSCR Source Version
source_version
varchar
50
TBD
If we can extract from the meta data about the payload a version number we should do so.
123456789
Updated By
updated_by
varchar
50
TBD
The human readable name of the connection who updated an existing record provided by either themselves
Juliet Alexander
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1639153129
Health Conditions
18
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Background Information
background_information
varchar
2000
TBD
Free text relating to the health condition
Clinical Record
clinical_record
blob
TBD
The clinical record provided by healthcare organisation delivered in a machine readable format using a
Clinical Record Date
clinical_record_date
int
TBD
The date of the clinical record
Clinical Record Format
clinical_record_format
varchar
2000
TBD
The format the clinical record payload is stored in such as OpenEHR Problem / Diagnosis or HL7/FHIR Co
Clinical Record Version
clinical_record_version
varchar
2000
TBD
The version number of a clinical record should the recorded be changed by the clinical record provider
Condition End Date
condition_end_date
int
TBD
Date Health Condition was confirmed as ended
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
Diagnosis Date
diagnosis_date
int
TBD
Date of diagnosis, unix timestamp
Diagnosis Provider
diagnosis_provider
varchar
2000
TBD
The GP or individual / healthcare provider who diagnosed the health condition.
Disability Classification
disability_classification
blob
TBD
Flags which disability classifications apply using the different classification systems available
Health Condition
health_condition
varchar
2000
TBD
The “name” field from MRD NHS Health Conditions Dataset as a result of searching and selecting a recor
Health Condition URL
health_condition_url
text
TBD
This is automatically populated once the health condition is selected. Formatted as a clickable link i
ICD 10 Code
icd10_code
varchar
2000
TBD
The corresponding ICD10 code linked to the specific Health Condition, may be determined by PDX API usi
id
id
serial
TBD
The primary identifier for this record.
instance
instance
int
TBD
The instance this record relates to.
SNOMED CT Code
snomedct_code
varchar
2000
TBD
The corresponding SNOMED-CT code linked to the specific Health Condition, may be determined by PDX API
source
source
varchar
30
TBD
The source of the data - user or connection.
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
Medications
21
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
ATC Code
atc_code
varchar
2000
TBD
Anatomical Therapeutic Chemical Classification System code
J05AE30
BNF Code
bnf_code
varchar
2000
TBD
The British National Formulary Code for the drug
0503060B0
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1648633780
Dispensing Pharmacy
dispensing_pharmacy
varchar
2000
TBD
Name of dispencing pharmacy
Parade Pharmacy
Medications ID
id
serial
TBD
The primary identifier for this record.
1
Instance
instance
int
TBD
The instance this record relates to.
1
Last Issued Date
last_issued_date
int
TBD
Unix timestamp date of last time prescription was issued
1648633780
Medication Dosage
medication_dosage
blob
TBD
JSON object of the dosage data
3 x a day / Breakfast, Lunch and Dinner or every eight hours take with food, avoid alcohol Dosage is per time it is taken 5mg 3 x a day
Medication Name
medication_name
varchar
2000
TBD
Medication name
Paxlovid
Medication Notes
medication_notes
varchar
2000
TBD
Notes: Any additional notes or comments related to the medication or prescription
Controlled drug
Medication Status
medication_status
varchar
2000
TBD
Medication status e.g. "Active"
Active
Medication URL
medication_url
text
TBD
Link to medication description (NHS)
https://api-mrd.mydex.org/medicines/baclofen
Prescriber Name
prescriber_name
varchar
2000
TBD
Name of prescriber
Dr. Godley
Prescription End Date
prescription_end_date
int
TBD
Unix timestamp end date of prescription
1648633780
Prescription Start Date
prescription_start_date
int
TBD
Unix timestamp start date of prescription
1648633780
Repeat prescription
repeat_prescription
varchar
2000
TBD
Is this a repeat prescription
Repeat prescription days
repeat_prescription_days
varchar
2000
TBD
Number of days supply of medication
Repeat prescription quantity
repeat_prescription_quantity
varchar
2000
TBD
Total amount of medication per repeat prescription
SNOMED CT Code
snomedct_code
varchar
2000
TBD
The SNOMED CT Code for the medication
1240581000000104
Source
source
varchar
30
TBD
The source of the data - user or connection.
con_id e.g. 40213 or mydexid
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1648633780
Property Collection
1
24
Expand
Dataset Name
Fields Count
Home
24
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Bedrooms
field_home_bedrooms
int
TBD
The number of bedrooms in the members home.
3
Country
field_home_country
varchar
2000
TBD
The members home country
England
County
field_home_county
varchar
2000
TBD
The members home county
Essex
Date From
field_home_date_from
int
TBD
The date the member moved in
29222
Date To
field_home_date_to
int
TBD
The date the member moved out
29222
Floor number
field_home_floor
int
TBD
The floor number of the home
1
Habitable Rooms
field_home_habitable_rooms
int
TBD
The number of habitable rooms in the members home
5
National Property Gazetteer Reference
field_home_nlpg
varchar
2000
TBD
The National Property Gazetteer reference number
Number of Residents
field_home_num_residents
int
TBD
The number of residents in the members home
4
Landlord Address Country
field_home_owner_country
varchar
2000
TBD
The owner or landlords country
United Kingdom
Landlord Address County
field_home_owner_county
varchar
2000
TBD
The owner or landlords county
Anycounty
Email Address
field_home_owner_email_address
varchar
2000
TBD
email address for the owner or landlord
landlord@ .....
Name
field_home_owner_name
varchar
2000
TBD
Name of the property owner or landlord
I. M. Landlord
Landlord Address Post Code
field_home_owner_postcode
varchar
2000
TBD
The owner or landlords post code
AB12 3CD
Landlord Address Street
field_home_owner_street
varchar
2000
TBD
The owner or landlords house number and street name
100 High Street
Telephone Number
field_home_owner_telephone_no
varchar
2000
TBD
Contact telephone number for the owner or landlord
07890 123456
Landlord Address Town
field_home_owner_town
varchar
2000
TBD
The owner or landlords town
Anytown
Post Code
field_home_postcode
varchar
2000
TBD
The members home postcode
NB1 1AZ
Property Type
field_home_property_type
varchar
2000
TBD
Flat
Room number
field_home_room
varchar
50
TBD
The room name or number of the home
1
Street
field_home_street
varchar
2000
TBD
The member home house number and street name
1 High Street
Field home street line 2
field_home_street_line_2
varchar
2000
TBD
Optional second line of street address
Tenancy
field_home_tenancy
varchar
2000
TBD
The type of tenancy
Lodger
Town
field_home_town
varchar
2000
TBD
The members home town
Watford
Journal Collection
1
23
Expand
Dataset Name
Fields Count
Journal
23
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Conversation ID
conversation_id
string
TBD
Conversation ID.
12348
Created Timestamp
created_timestamp
int
TBD
Created Timestamp
1638375529
Device Id
device_id
varchar
TBD
The device did the message originate from.
543
External ID
external_id
int
TBD
External ID.
1
Journal ID
id
serial
TBD
The machine name for a record.
10
Journal Instance
instance
int
TBD
The instance this item relates to.
2
Journal By
journal_by
text
TBD
The individual member or organisation member that created the journal.
Clive Lewis
Journal Content
journal_content
blob
TBD
The content of the journal entry.
"New Entry"
Journal Time Received
journal_time_received
int
TBD
The Unix timestamp that the journal was received.
1639153129
Journal Time Sent
journal_time_sent
int
TBD
The Unix timestamp that the journal was sent.
1638375529
Journal To
journal_to
text
TBD
The person/organisation they are replying to if this is a reply.
Glasgow Council
Service Id
service_id
text
TBD
Which account or service did the message come from.
Volunteer Service
Service Name
service_name
text
TBD
The unique name of the member on the service e.g Twitter handle.
Antonio Morales
Service Order ID
service_order_id
int
TBD
Service Order ID.
1
Journal Source
source
varchar
30
TBD
The source of the data - user or connection.
Tags
tags
text
TBD
The tags associated with the journal (comma separated list).
volunteer, community
Title
title
varchar
TBD
The title of the journal.
Volunteering
Type
type
varchar
TBD
The type of journal.
Volunteer record
Updated Timestamp
updated_timestamp
int
TBD
Updated Timestamp
1861227082
User ID
user_id
int
TBD
User ID.
1
Version Content
version_content
blob
TBD
The content of previous versions.
Version Id
version_id
int
TBD
The id of the journal.
5
Version Information
version_information
text
TBD
Meta data about the Revision, Version Number, Version Content, Version Change Description
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In nulla urna, ullamcorper et ipsum id, bibendum iaculis nisi.
Travel Collection
3
27
Expand
Dataset Name
Fields Count
Journeys
9
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Journey ID
id
serial
TBD
The primary identifier for a journey transaction.
5
Journey Instance
instance
int
TBD
The instance this transaction relates to.
8
Transactions Date
journey_date
int
TBD
Journy date - unix timestamp.
1638375529
Transactions Destination
journey_destination
varchar
255
TBD
The destination of the journey.
Belfast
Transactions End Time
journey_end_time
int
TBD
Journy end time - unix timestamp.
1638375529
Transactions Origin
journey_origin
varchar
255
TBD
The origin of the journey.
Edinburgh
Transactions Start Time
journey_start_time
int
TBD
Journy start time - unix timestamp.
1641989731
Transactions Transaction Value
journey_transaction_value
numeric
TBD
The transaction value of the journey.
145.0
Journey Source
source
varchar
30
TBD
The source of the data - user or connection.
Location Data
15
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Location Data ID
id
serial
TBD
The primary identifier for a location data record.
1
Location Data Instance
instance
int
TBD
The instance this location data record relates to.
3
Address Line 1
location_data_address1
varchar
128
TBD
The address line 1.
1 Example st
Address Line 2
location_data_address2
varchar
128
TBD
The address line 2.
18
App Name
location_data_app_name
varchar
50
TBD
The app name creating the location data record.
Google Maps
Country
location_data_country
varchar
128
TBD
The address country.
United Kingdom
County
location_data_county
varchar
128
TBD
The address county.
Lanarkshire
Device Name
location_data_device_name
varchar
50
TBD
The device name creating the location data record.
Tablet
Latitude
location_data_latitude
numeric
20
TBD
The latitude of the location.
55.8642
Longitude
location_data_longitude
numeric
20
TBD
The longitude of the location.
4.2518
Postcode
location_data_postcode
varchar
128
TBD
The address postcode.
AB1 2CD
Timestamp
location_data_timestamp
int
TBD
The timestamp the location data was created.
1638375529
Timezone
location_data_timezone
varchar
5
TBD
The timezone the location data was created.
Greenwich Mean Time
Town/City
location_data_towncity
varchar
128
TBD
The address town/city.
Glasgow
Location Data Source
source
varchar
30
TBD
The source of the data - user or connection (uid or con_id).
Travel Card
3
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Card Number
field_tr_card_number
varchar
255
TBD
The member's travel card number.
12345678
Card Type
field_tr_card_type
varchar
255
TBD
The member's travel card type.
Savings
Current Balance
field_tr_current_balance
int
TBD
Current balance of the member's travel card.
23.45
Loyalty Scheme Collection
1
8
Expand
Dataset Name
Fields Count
Loyalty Scheme
8
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Loyalty Scheme ID
id
serial
TBD
The primary identifier for a loyalty scheme transaction.
5
Loyalty Scheme Instance
instance
int
TBD
The instance this transaction relates to.
8
Transactions Date
ls_date
int
TBD
transaction date - unix timestamp.
Transactions Description
ls_description
varchar
255
TBD
The description of the record.
Sainsbury's - Horsham
Transactions Monetary Value
ls_monetary_value
numeric
TBD
The transaction value of the record.
Transactions Currency Code
ls_monetary_value_currency_code
varchar
10
TBD
The monetary currency code.
GBP
Transactions Points Value
ls_points_value
numeric
TBD
The points value of the record.
Loyalty Scheme Source
source
varchar
30
TBD
The source of the data - user or connection.
Public Services Collection
1
15
Expand
Dataset Name
Fields Count
My Council
15
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
Authority Name
field_la_authority_name
varchar
2000
TBD
The name of the members local authority
East Herts Council
Council Tax Band
field_la_council_tax_band
varchar
2000
TBD
The Council Tax band
D
Council Address Country
field_la_country
varchar
2000
TBD
The council country
England
Council Address County
field_la_county
varchar
2000
TBD
TThe council county
Essex
Date From
field_la_date_from
int
TBD
The date the member moved into the area
29222
Date To
field_la_date_to
int
TBD
The date the member left the area
29222
Council Address eMail
field_la_email
varchar
2000
TBD
The council email address
name@council.gov
Council Address Fax
field_la_fax
varchar
2000
TBD
The council fax number
(44) 01234 123456
Council Address PostCode
field_la_postcode
varchar
2000
TBD
The council postcode
NB1 1AZ
Council Address Street
field_la_street
varchar
2000
TBD
The council street name and building name or number
1 High Street
Council Address Telephone
field_la_telephone
varchar
2000
TBD
The council telephone number
(44) 01234 123456
Council Address Town
field_la_town
varchar
2000
TBD
The council town
Watford
My Contact Details eMail
field_la_user_email
varchar
2000
TBD
The members email address registered with the council
name@emailprovider.com
My Contact Details Mobile
field_la_user_mobile
varchar
2000
TBD
The members telephone number
(44) 01234 123456
My Contact Details Telephone
field_la_user_telephone
varchar
2000
TBD
The members telephone number
(44) 01234 123456
Volunteering Collection
1
16
Expand
Dataset Name
Fields Count
Voluntary
16
Field Name
Machine Name
Type
Max Size
Validation
Description
Example
CRB CRB Number
field_vol_crb_number
varchar
255
TBD
The member's CRB number.
123456789
CRB Date of Expiry
field_vol_date_of_expiry
int
TBD
The expiration date of the CRB.
1638375529
CRB Expiry Alert
field_vol_expiry_alert
int
TBD
The expiration alert date of the CRB.
Host Organisation
field_vol_host_organisation
varchar
255
TBD
The host organisation name.
Organisation
ID Number
field_vol_id_number
varchar
255
TBD
The member's ID number.
23
Notes
field_vol_notes
varchar
255
TBD
Additional notes.
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
New datasets to cover new use-cases are constantly being added to the platform. These start out on the Sandbox environment at https://sbx-api.mydex.org before graduating to the live platform at https://api.mydex.org.
If there's a dataset you want to see added, please make a PDS Data Set Request using the email address on our support page.