PDS Master Data Schema

Introduction 🔗︎ click to copy

Welcome to the Personal Data Store Master Data Schema. It is designed to allow our Members to store a lifetime of personal data across their whole life. You can read more about the Personal Data Store in our overview here, how it works and how subscribers can connect to a Members PDS via the Personal Data eXchange for two way data exchange under GDPR Compliant Data Sharing and Services Agreements.

As a subscriber you may never need to directly access the PDS Datasets, as we provide dedicated Feature Blocks and Templates configured via the Personal Data eXchange Template System. These are designed to ease integration and interoperability between your application and the Members Personal Data Store.

Both Feature Blocks and Templates allow you to use dedicated routes to perform seamless updates across the PDS Master Data Schema automatically, with the Personal Data eXchange managing data integrity and validation for you.

Where you are seeking to deliver high volume transaction data, you may use our direct PDS Dataset access routes and batch delivery services for optimal performance. If you are seeking high volume transactional data records e.g. for research and analysis, you can also use our direct PDS Dataset access.

The PDS Master Data Schema is continually being extended based on our Members' needs and our Subscribers' requests to be able to store more data in the PDS. Mydex has its own strategic roadmap of PDS Master Data Schema extensions, coupled with our Safe Secure Cloud Roadmap of Feature Blocks and Templates, to ensure interoperability with as many different ecosystems and interoperability standards across the different aspects of our Members lives, e.g. Health and Social Care, Digital Identity, Energy, Financial Services.

We have presented the Personal Data Store Master Data Schema in what we call collections of datasets that cover different aspects of a Members life and interests of our Subscribers. You may find, as you drill down into a collection, that you may see the same Dataset appear in one or more collections. Each Dataset has a clearly defined set of fields, relevant validations and constraints, as well as a description of the field's intent and purpose and a basic example.

If you have any questions, please contact support [@] mydex.org. If you want to request a new dataset or changes to an existing dataset please contact us via schema [@] mydex.org .

Explore the PDS Master Data Schema 🔗︎ click to copy

Why not simply start with a search using the tool below. You can choose to search for a Collection, a Dataset or a specific Field term and the table will filter the results.

Alternatively, click into each collection and drill down into the datasets within the collection. When you find the one you want, click on it to expand it and see the dataset fields, labels, field type, field length (where there is a limit) and validations available. You can collapse any Collection or Dataset at any time.

🔗︎ If you want to copy a link to a specific collection or dataset, hover over the collection or dataset name and you can click the paperclip to copy the direct link. This link will take you right back there or anyone else you share the link with.

At the dataset field level we have also provided a short description and example of the data we will return in any request you make.

Please note: Some fields are automatically maintained by the Personal Data eXchange for you which means we only offer GET requests or PUT requests for updating a specific record. We automatically populate these fields when you make a POST request to add records to the dataset either directly or via one of our Templates or Feature Blocks. We do the filing and integrity work for you.

Search 🔗︎ click to copy

Search for:

Containing this term:

Collection Datasets Data Fields

Personal Records 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Personal 🔗︎ click to copy

ds_personal_details

Data relating to a members personal details

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Title	`field_personal_title`	The members surname	varchar	2000	TBA	Mr
First Name	`field_personal_fname`	The members first name	varchar	2000	TBA	Catherine
Middle Name	`field_personal_mname`	The members middle name	varchar	2000	TBA	Anne
Family Name	`field_personal_faname`	The members surname	varchar	2000	TBA	Jones
Suffix	`field_personal_suffix`	The members surname	varchar	2000	TBA	Jones
Nickname	`field_personal_nickname`	The members nickname	varchar	2000	TBA	Catherine
Email Address	`field_personal_email_address`	The members primary email address	varchar	2000	TBA	katherinetsmithy@gmail.com
Mobile Phone	`field_personal_mobile_phone`	The members mobile number	varchar	2000	TBA	07654 321098
Home Phone	`field_personal_home_phone`	The members home phone	varchar	2000	TBA	01234 123456
Work Phone	`field_personal_work_phone`	The work telephone number	varchar	2000	TBA	(44) 1357 246802
Gender at Birth	`field_gender_birth`	The members gender at birth	varchar	2000	TBA	Female
Gender	`field_personal_gender`	The members gender	varchar	2000	TBA	Female
Pronouns	`field_personal_pronouns`	The members pronouns	varchar	2000	TBA	She/Her
Race Ethnicity	`field_personal_ethnicity`	The members ethnicity	varchar	2000	TBA	White-Scottish
Marital Status	`field_personal_marital_status`	The members marital status	varchar	2000	TBA	Married
Maiden Name	`field_personal_maname`	The members surname	varchar	2000	TBA	Jones
No of Children	`field_personal_number_children`	The number of children the member has	int		TBA	2

Birth Details 🔗︎ click to copy

ds_birth

Data relating to a members date & place of birth

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Date Of Birth	`field_birth_dob`	The members date of birth	int		TBA	29222
Country	`field_birth_country`	The Country in which the member was born	varchar	2000	TBA	England
Town	`field_birth_town`	The town in which the member was born	varchar	2000	TBA	Manchester
Nationality	`field_birth_nationality`	The nationality of the member	varchar	2000	TBA	British

National Insurance 🔗︎ click to copy

ds_ni

Data relating to a members National Insurance details

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Number	`field_ni_number`	A members NI Number	varchar	2000	TBA	XX XXXXX X
Name	`field_ni_name`	The members surname	varchar	2000	TBA	Jones

Driving Licence 🔗︎ click to copy

ds_driving_licence

Data relating to a members driving licence

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Surname	`field_dl_surname`	The members surname	text	60	TBA	Jones
Other Names	`field_dl_other_names`	The member's surname	text	60	TBA	Jones
Date Of Birth	`field_dl_dob`	The members date of birth	date		TBA	29222
Place Of Birth	`field_dl_pob`	The Country in which the member was born	text		TBA	England
Valid From	`field_dl_valid_from`	The date from which the members driving dicence is Valid	date		TBA	29222
Issuing Authority	`field_dl_issuing_authority`	The authority that issued the members driving licence	text		TBA	DVLA
Valid To	`field_dl_valid_to`	The expiry date of the members driving licence	date		TBA	29222
Licence Number	`field_dl_licence_number`	The members driving licence number	text	60	TBA	888 8888 888
Issue Country	`field_dl_issue_country`		text		TBA	United Kingdom
Expiry Alert	`field_dl_expiry_alert`		date	60	TBA
Date From	`field_dl_group_date_from`		date		TBA
Date To	`field_dl_group_date_to`		date		TBA
Groups	`field_dl_groups`		field_collection_table	60	TBA
Category	`field_dl_groups_category`		text	60	TBA

Passport 🔗︎ click to copy

ds_passport

Data relating to a members passport details

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Type	`field_pp_type`		varchar	2000	TBA
Code	`field_pp_code`		varchar	2000	TBA
Number	`field_pp_number`	The members passport number	varchar	2000	TBA	123456789
Surname	`field_pp_surname`	The members surname	varchar	2000	TBA	Jones
Given Names	`field_pp_given_names`	The members first name	varchar	2000	TBA	Catherine
Nationality	`field_pp_nationality`	The members nationality	varchar	2000	TBA	British
Date Of Birth	`field_pp_dob`	The members date of birth	int		TBA	29222
Sex	`field_pp_sex`	The gender of the member	varchar	2000	TBA	Female
Place Of Birth	`field_pp_place_of_birth`	The city in which the member was born	varchar	2000	TBA	Manchester
Date Of Issue	`field_pp_date_issue`	The date from which the members passport is Valid	int		TBA	29222
Issuing Authority	`field_pp_issuing_authority`	The authority that issued the members passport	varchar	2000	TBA	UKBA
Date Of Expiry	`field_pp_date_expiry`	The expiry date of the members passport	int		TBA	29222
Expiry Alert	`field_pp_expiry_alert`		int		TBA

TV Licence 🔗︎ click to copy

ds_tv_licence

Television licence details.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
TV Licence Number	`field_tv_licence_number`	The TV licence number.	varchar	255	TBA
Licence Holder's Name	`field_tv_licence_holders_name`	The name of licence holder.	varchar	255	TBA	Catherine Jones
TV Licence Type	`field_tv_licence_type`	The TV licence type.	varchar	255	TBA
Valid Until	`field_tv_licence_valid_until`	The expiration date of the TV licence.	int		TBA
Street	`field_tv_licence_street`	The member home house number and street name.	varchar	255	TBA	1 High Street
Town	`field_tv_licence_town`	The member's home town.	varchar	255	TBA	Watford
County	`field_tv_licence_county`	The member's home county.	varchar	255	TBA	Essex
TV Licence Fee	`field_tv_licence_fee`	The TV licence fee.	int		TBA
Post Code	`field_tv_licence_post_code`	The member's home postcode.	varchar	255	TBA	NB1 1AZ
Payment Frequency	`field_tv_licence_payment_freq`	The TV licence payment frequency.	varchar	255	TBA
Payment Method	`field_tv_licence_payment_method`	The TV licence payment method.	varchar	255	TBA

Establishment 🔗︎ click to copy

ds_education

Data relating to a members education history

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Establishment Name	`field_edu_establishment_name`	The name of the establishment	text	60	TBA	Kings School
Address Street	`field_edu_street`	The establishment street name and building name/ number	text		TBA	1 High Street
Address Town	`field_edu_town`	The establishment town	text	60	TBA	Watford
Address County	`field_edu_county`	The establishment county	text	60	TBA	Essex
Date	`field_edu_course_date`	The date the member was awarded the qualification	date		TBA	29222
Address PostCode	`field_edu_postcode`	The establishment postcode	text	60	TBA	NB1 1AZ
Address Country	`field_edu_country`	The establishment country	text		TBA	England
Level	`field_edu_course_level`	The level of the course	text	60	TBA	A Level
Mode Of Study	`field_edu_course_mode_of_study`	The mode of study for the course	text		TBA	Full Time
Name	`field_edu_course_name`	The name of the course the member undertook	text	60	TBA	Computer Science
Results Attained	`field_edu_course_results`	The grades awarded	text	60	TBA	Pass
Courses	`field_edu_courses`		field_collection_embed		TBA
Address DateFrom	`field_edu_date_from`	The date the member started at the establishment	date		TBA	29222
Address DateTo	`field_edu_date_to`	The date the member left the establishment	date		TBA	29222
Type	`field_edu_type`	The type of establishment	text		TBA	School
Address Telephone	`field_edu_telephone`	The establishment telephone number	text	60	TBA	(44) 01234 123456
Address URL	`field_edu_url`	The establishment URL	text	60	TBA	www.name.com

Employer 🔗︎ click to copy

ds_employment

Details of each employer.

Field Name	Machine Name	Description	Type	Max Size	Validation
Employer Name	`field_emp_employer_name`	The name of the member's employer.	varchar	255	TBA
Employee ID	`field_emp_employee_id`	The member's employee ID.	varchar	255	TBA
Job Title	`field_emp_job_title`	The member's job title.	varchar	255	TBA
Start Date	`field_emp_start_date`	The member's start date of employment.	int		TBA
End Date	`field_emp_end_date`	The member's end date of employment.	int		TBA
Salary	`field_emp_salary`	The member's salary.	int		TBA

Address Book Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Contacts 🔗︎ click to copy

ds_contacts

Contacts across address book of organisations and people

Field Name	Machine Name	Description	Type	Max Size	Validation
Contact ID	`contact_id`	Foreign key to id of contact in either ds_person or ds_organisation	int		TBA
Contact Type	`contact_type`	The type of contact i.e. "person" or "organisation	varchar	2000	TBA
Created Time Stamp	`created_timestamp`	Created Timestamp	int		TBA
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA

Person 🔗︎ click to copy

ds_person

Details of an individual

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1648633780
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1648633780
Title	`title`	Title	varchar	2000	TBA	Ms, Mrs, Mr, Dr, Prof etc
First name	`first_name`	First name	varchar	2000	TBA	Joe, Jane, Ann, Michael etc
Middle name(s)	`middle_names`	Middle name(s)	varchar	2000	TBA	Joe, Jane, Ann, Michael etc
Surname	`surname`	Surname	varchar	2000	TBA	Fitzpatrick, Khan, Simmons, Smith etc
Suffix	`suffix`	Suffix	varchar	2000	TBA	PhD, CCNA, OBE etc
Nickname	`nickname`	Nickname	varchar	2000	TBA	Freddy, Pete, Soph, Mandy, Terry etc
Date of birth	`d_o_b`	The person's date of birth	int		TBA	1648633780
Gender	`gender`	Gender	varchar	2000	TBA	Female, male, non-binary etc
Language	`language`	Language	varchar	2000	TBA	English, French, Urdu etc
Anniversary	`anniversary`	Anniversary	int		TBA	1648633780
Notes	`notes`	Notes about this person	varchar	2000	TBA	Lives with me

Organisation 🔗︎ click to copy

ds_organisation

Details of an organisation

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1648633780
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1648633780
Organisation name	`organisation_name`	Organisation full name	varchar	2000	TBA	British Broadcasting Company
Short name	`short_name`	Short name	varchar	2000	TBA	BBC

Communications 🔗︎ click to copy

ds_communications

The details of the methods of communications with a person or organisation.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1648633780
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1648633780
Organisation ID	`org_id`	Foreign key to id of the organisation in ds_organisation	int		TBA	2
Person ID	`person_id`	Foreign key to id of the person in ds_person	int		TBA	1
Value	`value`	Specific value for this communication	varchar	2000	TBA	my_name@email.com, @my_social_media_handle
Description	`description`	Description	varchar	2000	TBA	For friends only
Communication Type	`comm_type`	Type of communication e.g. email, social media etc	varchar	2000	TBA	Email, social media etc

Address 🔗︎ click to copy

ds_address

Address of a person or organisation

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Street line 2	`street_line_2`	Second line of street	varchar	2000	TBA
Name	`name`	Name	varchar	2000	TBA	The Oaks
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1648633780
Street	`street`	Street	varchar	2000	TBA	123 Sycamore Lane
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1648633780
Town	`town`	Town	varchar	2000	TBA	Lanark
Postcode	`postcode`	Postcode	varchar	2000	TBA	AB1 2CD
County	`county`	County	varchar	2000	TBA	Hampshire
Country	`country`	Country	varchar	2000	TBA	Spain

Health Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Health 🔗︎ click to copy

ds_health

High-level health and GP details.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
GP Details GP Name	`field_health_gp_name`	The name of the members GP	varchar	2000	TBA
GP Practice Name	`field_health_gp_practice_name`	The name of the members GP practice	varchar	2000	TBA	Terrace Medical Practice
GP Details Street	`field_health_gp_street`	The street address of the members GP	varchar	2000	TBA
GP Details Town	`field_health_gp_town`	The town of the members GP	varchar	2000	TBA
GP Details County	`field_health_gp_county`	The county of the members GP	varchar	2000	TBA
GP Details Postcode	`field_health_gp_postcode`	The postcode of the members GP	varchar	2000	TBA
GP Details Country	`field_health_gp_country`	The country of the members GP	varchar	2000	TBA
Member's CHI number	`field_health_chi_number`	The members CHI number	varchar	2000	TBA	www.terrace-medical-practice.com
NHS Number	`field_health_nhs_number`	The members NHS number	varchar	2000	TBA
Social Care ID	`field_health_social_care_id`	The member's social care ID	text	60	TBA
GP Practice Website	`field_health_gp_practice_website`	Website url of the members GP	varchar	2000	TBA	www.terrace-medical-practice.com
GP Details Fax	`field_health_gp_fax`	The fax address of the members GP	varchar	2000	TBA
GP Details Email	`field_health_gp_email`	The email address of the members GP	varchar	2000	TBA
GP Details Telephone	`field_health_gp_telephone`	The telephone number of the members GP	varchar	2000	TBA

Health Conditions 🔗︎ click to copy

ds_health_conditions

A list of Health Conditions of a Member

Field Name	Machine Name	Description	Type	Max Size	Validation
Background Information	`background_information`	Free text relating to the health condition	varchar	2000	TBA
Clinical Record	`clinical_record`	The clinical record provided by healthcare organisation delivered in a machine readable format using a	blob		TBA
Clinical Record Date	`clinical_record_date`	The date of the clinical record	int		TBA
Clinical Record Format	`clinical_record_format`	The format the clinical record payload is stored in such as OpenEHR Problem / Diagnosis or HL7/FHIR Co	varchar	2000	TBA
Clinical Record Version	`clinical_record_version`	The version number of a clinical record should the recorded be changed by the clinical record provider	varchar	2000	TBA
Condition End Date	`condition_end_date`	Date Health Condition was confirmed as ended	int		TBA
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA
Diagnosis Date	`diagnosis_date`	Date of diagnosis, unix timestamp	int		TBA
Diagnosis Provider	`diagnosis_provider`	The GP or individual / healthcare provider who diagnosed the health condition.	varchar	2000	TBA
Disability Classification	`disability_classification`	Flags which disability classifications apply using the different classification systems available	blob		TBA
Health Condition	`health_condition`	The “name” field from MRD NHS Health Conditions Dataset as a result of searching and selecting a recor	varchar	2000	TBA
Health Condition URL	`health_condition_url`	This is automatically populated once the health condition is selected. Formatted as a clickable link i	text		TBA
ICD 10 Code	`icd10_code`	The corresponding ICD10 code linked to the specific Health Condition, may be determined by PDX API usi	varchar	2000	TBA
SNOMED CT Code	`snomedct_code`	The corresponding SNOMED-CT code linked to the specific Health Condition, may be determined by PDX API	varchar	2000	TBA
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA

Health and Social Care Records 🔗︎ click to copy

ds_hscr

Health and Social Care Records

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1638375529
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1639153129
HSCR Source ID	`source_id`	This will be meta data about the record from the source.	varchar	50	TBA
HSCR Source Version	`source_version`	If we can extract from the meta data about the payload a version number we should do so.	varchar	50	TBA	123456789
Updated By	`updated_by`	The human readable name of the connection who updated an existing record provided by either themselves	varchar	50	TBA	Juliet Alexander
Delivery Timestamp	`delivery_timestamp`	Timestamp of when the data payload was delivered to the PDS	int		TBA	1639153129
HSCR Data Format	`hscr_data_format`	This tells us what data structure standard we are receiving e.g OpenEHR, HL7,FHIR.	varchar	50	TBA	FHIR
HSCR Data Source	`hscr_data_source`	The data source that this HSCR originated from.	varchar	50	TBA	Social Care Professional
HSCR Delivery route	`hscr_delivery_route`	The name of the delivery route e.g. Health Data Exchange, Lenus Platform.	varchar	50	TBA	Lenus Platform
HSCR Title	`hscr_title`	Extracted from the payload a human readable name for the data payload	varchar	50	TBA
HSCR Data	`hscr_data`	The full data from the originating source in whatever format it was delivered.	blob		TBA

Medications 🔗︎ click to copy

ds_medications

Medications / Prescriptions

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Repeat prescription	`repeat_prescription`	Is this a repeat prescription	varchar	2000	TBA
Repeat prescription days	`repeat_prescription_days`	Number of days supply of medication	varchar	2000	TBA
Repeat prescription quantity	`repeat_prescription_quantity`	Total amount of medication per repeat prescription	varchar	2000	TBA
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1648633780
Medication Name	`medication_name`	Medication name	varchar	2000	TBA	Paxlovid
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1648633780
Medication Dosage	`medication_dosage`	JSON object of the dosage data	blob		TBA	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
Prescriber Name	`prescriber_name`	Name of prescriber	varchar	2000	TBA	Dr. Godley
Medication Status	`medication_status`	Medication status e.g. "Active"	varchar	2000	TBA	Active
Medication Notes	`medication_notes`	Notes: Any additional notes or comments related to the medication or prescription	varchar	2000	TBA	Controlled drug
Medication URL	`medication_url`	Link to medication description (NHS)	text		TBA	https://api-mrd.mydex.org/medicines/baclofen
Prescription Start Date	`prescription_start_date`	Unix timestamp start date of prescription	int		TBA	1648633780
Prescription End Date	`prescription_end_date`	Unix timestamp end date of prescription	int		TBA	1648633780
Last Issued Date	`last_issued_date`	Unix timestamp date of last time prescription was issued	int		TBA	1648633780
Dispensing Pharmacy	`dispensing_pharmacy`	Name of dispencing pharmacy	varchar	2000	TBA	Parade Pharmacy
SNOMED CT Code	`snomedct_code`	The SNOMED CT Code for the medication	varchar	2000	TBA	1240581000000104
BNF Code	`bnf_code`	The British National Formulary Code for the drug	varchar	2000	TBA	0503060B0
ATC Code	`atc_code`	Anatomical Therapeutic Chemical Classification System code	varchar	2000	TBA	J05AE30

Measurements Collection 🔗︎ click to copy

154

Dataset Name Machine Name Description Data Fields

Measurements Log 🔗︎ click to copy

ds_measurements_log

Measurement Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Source Instance	`source_instance`	The instance of the source type	int		TBA
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Name	`source_name`	The Name given to source	varchar	30	TBA	Google Fit
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Measurement field type	`measurement_field_type`	How to treat the value stored in measurement value	varchar	30	TBA	Integer
Measurement Type	`measurement_type`	Specific name given to the measurement being recorded	varchar	30	TBA	Calories Burned
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity
Measurement timestamp Start	`measurement_timestamp_start`	The start time of the measurement	int		TBA	1648633780
Measurement timestamp Stop	`measurement_timestamp_end`	The end time of the measurement	int		TBA	1648633780
Unit Measure	`measurement_unit`	The unit of value that the measure is made in	varchar	30	TBA	kcal
Measure Value	`measurement_value`	The measurement itself	float		TBA	1648633780

Blood Pressure Log 🔗︎ click to copy

ds_blood_pressure_log

Blood Pressure Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Systolic	`systolic`	The systolic measurement in mmHg	float		TBA	120.7
Diastolic	`diastolic`	The diastolic measurement in mmHg	float		TBA	75.7
Measurement Timestamp Start	`blood_pressure_timestamp_start`	Start time and date of blood pressure measurement	int		TBA	1648633780
Measurement Timestamp End	`blood_pressure_timestamp_end`	End time and date of blood pressure measurement	int		TBA	1648633780
Body Position	`body_position`	Code defining the body position	int		TBA	1
Body Position Description	`body_position_description`	Position of body during measurement	varchar	30	TBA	Standing
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Measurement Location	`measurement_location`	code defing the location on the body where pressure reading taken	int		TBA	1
Measurement Location Description	`measurement_location_description`	Description of the location on the body where pressure reading taken	varchar	30	TBA	Left Wrist
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity

Blood Glucose Log 🔗︎ click to copy

ds_blood_glucose_log

Blood Glucose Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Measurement id	`measurement_id`	The key that links to Measurement Log	int		TBA
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Measurement Start Timestamp	`blood_glucose_timestamp_start`	Start time and date of blood glucose measurement	int		TBA	1648633780
Measurement End Timestamp	`blood_glucose_timestamp_end`	End time and date of blood glucose measurement	int		TBA	1648633780
Blood Glucose Level	`blood_glucose_level`	The blood glucose level or concentration	float		TBA	4.3
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Specimen Source	`specimen_source`	Type of body fluid used to measure blood glucose	int		TBA	4
Meal Type	`meal_type`	What type of meal the user ate around when the reading was taken.	int		TBA	3
Specimen Source Description	`specimen_source_description`	Type of body fluid used to measure blood glucose	varchar	30	TBA	Serum
Meal Type Description	`meal_type_description`	Description of Meal type	varchar	30	TBA	Lunch
Nutrition Log ID	`nutrition_log_id`	The link to the nutrition log record	int		TBA	1
Temporal relation to meal	`temporal_relation_to_meal`	When reading taken compared to when person ate	int		TBA	4
Temporal relation to meal description	`temporal_relation_to_meal_description`	When reading taken compared to when person ate description	varchar	30	TBA	Reading was taken after a meal
Temporal relation to sleep	`temporal_relation_to_sleep`	When the reading was taken compared to when the user slept.	int		TBA	1
Temporal relation to sleep	`temporal_relation_to_sleep_description`	Description of when the reading was taken compared to when the user slept	varchar	30	TBA	User was fully awake
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity

Body Temperature Log 🔗︎ click to copy

ds_body_temperature_log

Body Temperature Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Body Temperature	`body_temperature`	Body Temperature	float		TBA	36.7
Body Temperature Measurement Location	`body_temperature_measurement_location`	Where temperature was taken on body	int		TBA	3
Body Temperature Measurement Location Description	`body_temperature_measurement_location_description`	Description of where temperature was taken on body	varchar	30	TBA	Forehead
End Measurement Timestamp	`body_temperature_timestamp_end`	End time and date of body temperature measurement	int		TBA	1648633780
Start Measurement Timestamp	`body_temperature_timestamp_start`	Start time and date of body temperature measurement	int		TBA	1648633780
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity

Oxygen Saturation Log 🔗︎ click to copy

ds_oxygen_saturation_log

Oxygen Saturation Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity
Oxygen saturation	`oxygen_saturation`	The blood oxygen saturation reading as a percentage	float		TBA	95%
Oxygen saturation measurement method	`oxygen_saturation_measurement_method`	How oxygen saturation is measured.	int		TBA	1
Oxygen saturation measurement method Description	`oxygen_saturation_measurement_method_description`	Description of how oxygen saturation is measured.	varchar	30	TBA	Pulse oximetry
Measurement Start timestamp	`oxygen_saturation_measurement_timestamp_start`	Start time and date of oxygen saturation measurement	int		TBA	1648633780
Measurement End timestamp	`oxygen_saturation_measurement_timestamp_end`	End time and date of oxygen saturation measurement	int		TBA	1648633780
Oxygen saturation system	`oxygen_saturation_system`	Where oxygen saturation is measured	int		TBA	1
Oxygen saturation system description	`oxygen_saturation_system_description`	Description of where oxygen saturation is measured	varchar	30	TBA	Peripheral capillaries
Oxygen therapy administration mode	`oxygen_therapy_administration_mode`	How oxygen therapy is administered	int		TBA	1
Oxygen therapy administration mode description	`oxygen_therapy_administration_mode_description`	Description of How oxygen therapy is administered	varchar	30	TBA	Nasal Canula
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Supplemental oxygen flow rate	`supplemental_oxygen_flow_rate`	The rate additional oxygen is supplied to a user in liters per minute. Set to zero if no supplemental	int		TBA	0

Nutrition Consumption Log 🔗︎ click to copy

ds_nutrition_consumption_log

Nutrition Consumption Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Meal type description	`meal_type_description`	Description of Meal type	varchar	30	TBA
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Nutrition Log ID	`nutrition_log_id`	The link to the nutrition log record	int		TBA	1
Food Item	`food_item`	Food item	varchar	30	TBA	Banana
Meal End timestamp	`meal_timestamp_end`	End date and time of meal	int		TBA	1648633780
Meal Start Timestamp	`meal_timestamp_start`	Start date and time of meal	int		TBA	1648633780
Meal Type	`meal_type`	The type of meal	int		TBA	2
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity
Monounsaturated fat	`monounsaturated_fat`	Monounsaturated fat	float		TBA	2
Polyunsaturated fat	`polyunsaturated_fat`	Polyunsaturated fat	float		TBA	1.5
Saturated Fat	`fat_saturated`	Saturated Fat	float		TBA	9.8
Unsaturated Fat	`fat_unsaturated`	Unsaturated Fat	float		TBA	11.1
Total Fat	`fat_total`	Total Fat	float		TBA	33.1
Sugar	`sugar`	Sugar	float		TBA	5
Sodium	`sodium`	Sodium	float		TBA	1.1
Trans fat	`trans_fat`	Trans fat	float		TBA	8.7
Protein	`protein`	Protein	float		TBA	10
Potassium	`potassium`	Potassium	float		TBA	1.8
Total carbohydrates	`total_carbohydrates`	Total carbohydrates	float		TBA	34.7
Calories	`calories`	Calories	float		TBA	400
Cholesterol	`cholesterol`	Cholesterol	float		TBA	2
Dietary Fibre	`dietary_fibre`	Dietary Fibre	float		TBA	1.5

Nutrition Log 🔗︎ click to copy

ds_nutrition_log

Nutrition Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity
Meal End timestamp	`meal_timestamp_end`	End date and time of meal	int		TBA	1648633780
Meal Start Timestamp	`meal_timestamp_start`	Start date and time of meal	int		TBA	1648633780
Meal Type	`meal_type`	The type of meal	int		TBA	2
Meal Type Description	`meal_type_description`	Description of Meal type	varchar	30	TBA	Breakfast

Workout Log 🔗︎ click to copy

ds_workout_log

Workout Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Instance	`source_instance`	the instance of the source type	int		TBA
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity
Exercise Type	`exercise_type`	Values representing different exercises	varchar	30	TBA	back_extension
Exercise Description	`exercise_description`	The description of the exercise type	varchar	30	TBA	Back Extension
Repetitions	`exercise_repetitions`	Number of repetitions of an exercise.	int		TBA	10
Resistance Type	`resistance_type`	The type of resistance used during the exercise.	int		TBA
Resistance	`resistance_level`	The resistance of the exercise (or weight), in kilograms.	float		TBA	20kg
Exercise start timestamp	`exercise_timestamp_start`	Start time and date Exercise recorded	int		TBA	1648633780
Exercise end timestamp	`exercise_timestamp_end`	End time and date Exercise recorded	int		TBA	1648633780
Duration	`exercise_duration`	The amount of time exercise performed	int		TBA	60

Cervical Mucus Log 🔗︎ click to copy

ds_cervical_mucus_log

Cervical Mucus Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Measurement Timestamp	`cervical_mucus_timestamp`	Time and Date of cervical mucus measurement	int		TBA	1648633780
Cervical mucus amount	`cervical_mucus_amount`	Amount of cervical mucus	int		TBA	1
Cervical mucus amount description	`cervical_mucus_amount_description`	Description of amount of cervical mucus	varchar	30	TBA	Light
Cervical mucus texture	`cervical_mucus_texture`	Classification of mucus texture	int		TBA	1
Cervical mucus texture description	`cervical_mucus_texture_description`	Description of classification of mucus texture	varchar	30	TBA	Dry, little or no mucus
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity

Cervical Position Log 🔗︎ click to copy

ds_cervical_position_log

Cervical Mucus Log Data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`record_created_timestamp`	Date record added to PDS	int		TBA	1648633780
Updated Timestamp	`record_updated_timestamp`	Date record updated in the PDS	int		TBA	1648633780
Source Instance	`source_instance`	the instance of the source type	int		TBA	Google Account 1
Source Name	`source_name`	The name given to source	varchar	30	TBA	Google Fit
Source Device Type	`source_device_type`	States the type of source device	varchar	30	TBA	PDA
Measurement Log ID	`measurement_id`	The key that links to Measurement Log	int		TBA	1
Cervical Dilation	`cervical_dilation`	How open or dilated is cervix	int		TBA	2
Cervical Dilation Description	`cervical_dilation_description`	Description of how open or dilated is cervix	varchar	30	TBA	Partially open cervix
Cervical Firmness	`cervical_firmness`	How firm the cervix is	int		TBA	3
Cervical Firmness Description	`cervical_firmness_description`	Description of how firm the cervix is	varchar	30	TBA	Cervix is firm
Cervical Position	`cervical_position`	Position of Cervix	int		TBA	1
Cervical Position description	`cervical_position_description`	Description of the Position of Cervix	varchar	30	TBA	Cervix is Low
Measurement End Timestamp	`cervical_position_measurement_timestamp_end`	Cervical Mucus measurement end date and time	int		TBA	1648633780
Measurement Start Timestamp	`cervical_position_measurement_timestamp_start`	Cervical Mucus measurement start date and time	int		TBA	1648633780
Measurement Group	`measurement_group`	The top level group activity belongs to	varchar	30	TBA	Activity

Device Records 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Device Record 🔗︎ click to copy

ds_device_record

Records of devices.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
IMEI	`device_imei`	The IMEI of the device.	varchar	20	TBA	186122708298561
Name	`device_name`	Device Name.	varchar	50	TBA	Tablet-John
Type	`device_type`	Device Type.	varchar	20	TBA	Tablet
MAC Address	`device_mac_address`	The MAC Address of the device.	varchar	80	TBA	01-23-45-67-89-AB
Model Number	`device_model_number`	The model number of the device.	varchar	100	TBA	123AM45678
Serial Number	`device_serial_number`	The serial number of the device.	varchar	50	TBA	AB123456BC7
Software Version Number	`device_software_version_number`	The software version number the device is running.	varchar	50	TBA	10.1
Status	`status`	Status.	int		TBA	1
User ID	`user_id`	User ID.	int		TBA	1
Phone Number	`device_phone_number`	The phone number of the device.	varchar	15	TBA	07123456789
External ID	`external_id`	External ID.	int		TBA	1
Building ID	`building_id`	Building ID.	int		TBA	1
Memo	`memo`	Memo	varchar	1000	TBA	Description of the device

Device App Settings 🔗︎ click to copy

ds_device_app_settings

Table for storing device app setting variables.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
App Name	`app_setting_app_name`	The name of the app.	varchar	50	TBA	Messaging app
Device Name	`app_setting_device_name`	The name of the Device.	varchar	50	TBA	Tablet
Setting Name	`app_setting_name`	The name of the variable.	varchar	100	TBA	Switched on
Setting Type	`app_setting_type`	The type of setting. Value, Boolean (yes/no, on/off), Range (0 100 45).	varchar	50	TBA	yes/no
Setting Value	`app_setting_value`	The value/status of the variable.	varchar	1000	TBA	yes

Device Log 🔗︎ click to copy

ds_device_log

Device Log data.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1642137111
Start Timestamp	`start_time`	Start Timestamp	int		TBA	123
End Timestamp	`end_time`	End Timestamp	int		TBA	1642137111
Event ID	`event_id`	Event ID.	int		TBA	45
External ID	`external_id`	External ID.	text		TBA	1
Log Time	`log_time`	When the sensor value was detected.	int		TBA	1642137111
Sensor Type ID	`sensor_type_id`	The type of the sensor (for devices with multiple sensors).	int		TBA	123
Sensor Value	`sensor_value`	The value of the sensor.	float		TBA	123
Action	`action`	Action.	varchar	20	TBA	45

Events Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Events 🔗︎ click to copy

ds_events

Events

Field Name	Machine Name	Description	Type	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int	TBA	1638375529
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int	TBA	1861227082
Description	`description`	The description of the event.	text	TBA	Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Type	`type`	The type of the event (comma separated list).	text	TBA	community, art, environmental
Title	`title`	The title of the event.	text	TBA	Lorem Ipsum Event
Location	`location`	The location of the event.	text	TBA	Edinburgh
Organiser	`organiser`	The event organiser.	text	TBA	Art Museum
Start Timestamp	`start_timestamp`	Unix Timestamp of when the event will start	int	TBA	1638375529
End Timestamp	`end_timestamp`	Unix Timestamp of when the event will stop.	int	TBA	1639153129
Attendee	`attendee`	The event attendee.	text	TBA	Mary
Status	`status`	The status of the event attendee. Either TENTATIVE, CONFIRMED or CANCELLED.	varchar	TBA	TENTATIVE
Trigger	`trigger`	This property defines when an alarm will trigger.	text	TBA	2 weeks
Tags	`tags`	The tags associated with the event (comma separated list).	text	TBA	creative, culture, art, music, design
Reminder Description	`reminder_description`	Description of the reminder event	text	TBA	In nulla urna, ullamcorper et ipsum id, bibendum iaculis nisi.
External Uid	`external_uid`	An external unique ID for an event	text	TBA	540
Action	`action`	The action to be invoked when an alarm is triggered.	text	TBA	Reminder

Referrals 🔗︎ click to copy

ds_referrals

Referrals

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Created Timestamp	`created_timestamp`	Created Timestamp	int		TBA	1638375529
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int		TBA	1639153129
Service ID	`service_id`	Service ID	int		TBA	56
Service Name	`service_name`		text		TBA	Service
Service Description	`service_description`		text		TBA	Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Service Url	`service_url`		text		TBA	www.service.com
Service Email	`service_email`		text		TBA	service@email.com
Type	`type`	The type of the referral.	text		TBA	self referral
Contact Name	`contact_name`		text		TBA	Juliet Alexander
Contact Title	`contact_title`		text		TBA	Mrs
Contact Number	`contact_number`		text		TBA	07123456789
Start Time	`start_time`	Start Time	int		TBA	1642137111
End Time	`end_time`	End Time	int		TBA	1642137822
Complete Time	`complete_time`	Complete Time	int		TBA	1642137822
Duration	`duration`	Duration	int		TBA	1642137822
Status	`status`	The status of the referral.	text		TBA	waiting
Is processed	`is_processed`	Is processed	int		TBA	1
Memo	`memo`	Memo	varchar	1000	TBA	Text note here
Referree Background	`referree_background`	The referree background.	text		TBA	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`	The referree requirements.	text		TBA	Fruit, vegetables, legumes (e.g. lentils and beans), nuts and whole grains (e.g. unprocessed maize, millet, oats, wheat and brown rice).
External ID	`external_id`	External ID	int		TBA	1
Referrer Name	`referrer_name`		text		TBA	Romeo Santos
Referree Availability	`referree_availability`	The referree availability.	blob		TBA	"{ "AM": [ "Monday", "Tuesday", "Friday" ], "PM": [ "Monday", "Tuesday", "Wednesday", "Thursday" ] }"

Referrals Log 🔗︎ click to copy

ds_referrals_log

A record of all referrals made on behalf of the member (citizen) to service providers by other servi

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
User ID	`user_id`	Link to the user who changed the order status.	int		TBA	87
Responsible User ID	`responsible_user_id`		int		TBA	321
Service Order ID	`service_order_id`	Link to the service order.	int		TBA	5046
Action	`action`		varchar	20	TBA	Referring
Start Time	`start_time`		int		TBA	1638375529
End Time	`end_time`		int		TBA	1639153129
Referral Status	`status`	The status of the service order.	int		TBA	Status

Online Activity 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Bookmarks 🔗︎ click to copy

ds_bookmarks

User bookmarks

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Bookmark Created	`bookmark_created`	The created timestamp.	int		TBA	1343844034
Bookmark Title	`bookmark_title`	The bookmark title.	varchar	512	TBA	The Space
Bookmark Modified	`bookmark_modified`	The modified timestamp.	int		TBA	1343844034
Bookmark Description	`bookmark_description`	The bookmark description.	text		TBA	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.
Bookmark URL	`bookmark_url`	The bookmark url.	varchar	2000	TBA	http://thespace.org/
Browser	`bookmark_browser`	The browser this bookmark was captured on.	varchar	100	TBA
Device Name	`bookmark_device_name`	The name of the device this bookmark was captured on.	varchar	100	TBA
Bookmark Media Duration	`bookmark_duration`	The media duration.	int		TBA	0.458321759259259
Bookmark Media Height	`bookmark_height`	The media height.	int		TBA	400px
Bookmark Media Width	`bookmark_width`	The media width.	int		TBA	800px
Bookmark Annotation	`bookmark_annotation`	The bookmark annotation by the user.	text		TBA	Great stuff.
Bookmark Media Type	`bookmark_media_type`	The bookmark media type.	varchar	100	TBA	page
Tab	`bookmark_tab`	The tab this bookmark was captured on.	varchar	100	TBA
Bookmark Tags	`bookmark_tags`	The tags comma separated.	varchar	1000	TBA	arts, media

Browsing History 🔗︎ click to copy

ds_browsing_history

User browsing history

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Browsing History Visit Date	`browsing_history_visit_date`	The visit date timestamp.	int		TBA	1343844034
Browsing History Title	`browsing_history_title`	The history title.	varchar	512	TBA	The Space
Browser	`browsing_history_browser`	The browser this history was captured on.	varchar	100	TBA
Browsing History URL	`browsing_history_url`	The history url.	varchar	2000	TBA	http://thespace.org/
Tab	`browsing_history_tab`	The tab this history was captured on.	varchar	100	TBA
Device Name	`browsing_history_device_name`	The name of the device this history was captured on.	varchar	100	TBA

Profiles Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Profiles 🔗︎ click to copy

ds_profiles

Stores profiles that a member has created

Field Name	Machine Name	Description	Type	Validation	Example
Profile description	`profile_description`	The description of the profile	varchar	TBA
Profile ID	`profile_id`	The unique id for this profile	varchar	TBA	34
Created Timestamp	`created_timestamp`	Created Timestamp	int	TBA	1641909333
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int	TBA	1641909333
Profile Name	`profile_name`	The name of the profile	varchar	TBA	Community Services
Profile Source	`profile_source`	From which app the profile was created/updated from	varchar	TBA	inclued-citizen
Profile Content	`profile_content`	The actual profile data mapping data from the citizens PDS and tags added and any calculated values	blob	TBA	{"description":"This profile is for showing interest in Community Services and engagement","tags":["G41","Museums","Theatre","Music","Pop Culture"]}
Profile Shared With	`profile_shared_with`	States which app this profile has been shared to	blob	TBA	Inclued Citizen

Profiles Preferences 🔗︎ click to copy

ds_profiles_preferences

Preferences

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Preference Created Timestamp	`preference_created_timestamp`	Preference Created Timestamp	int		TBA	1638375529
Preference Updated Timestamp	`preference_updated_timestamp`	Preference Updated Timestamp	int		TBA	1639153129
Persona Name	`persona_name`	Name of Persona this preference is associated with	varchar	2000	TBA	Mary Led
Preference Name	`preference_name`	Name for this preference	varchar	2000	TBA	Interests
Preference Content	`preference_content`	Preference Content	blob		TBA	culture, sports, art

Intentions 🔗︎ click to copy

ds_intentions

Intentions

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
When is my travel insurance due?	`field_int_travel_insurance_due`	Date when the user's travel insurance is due	date		TBA

Community Profile 🔗︎ click to copy

ds_community_profile

Details of a member's community profile.

Field Name	Machine Name	Validation
Display Name	`field_cp_display_name`	TBA
About Me	`field_cp_about_me`	TBA
Community Membership Preferences	`field_cp_com_membership_prefs`	TBA
Community Roles	`field_cp_community_roles`	TBA
Website	`field_cp_website`	TBA

Property Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Home 🔗︎ click to copy

ds_home

Data relating to a members home

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Field home street line 2	`field_home_street_line_2`	Optional second line of street address	varchar	2000	TBA
Street	`field_home_street`	The member home house number and street name	varchar	2000	TBA	1 High Street
Town	`field_home_town`	The members home town	varchar	2000	TBA	Watford
County	`field_home_county`	The members home county	varchar	2000	TBA	Essex
Post Code	`field_home_postcode`	The members home postcode	varchar	2000	TBA	NB1 1AZ
Country	`field_home_country`	The members home country	varchar	2000	TBA	England
Date From	`field_home_date_from`	The date the member moved in	int		TBA	29222
Date To	`field_home_date_to`	The date the member moved out	int		TBA	29222
Bedrooms	`field_home_bedrooms`	The number of bedrooms in the members home.	int		TBA	3
Floor number	`field_home_floor`	The floor number of the home	int		TBA	1
Habitable Rooms	`field_home_habitable_rooms`	The number of habitable rooms in the members home	int		TBA	5
National Property Gazetteer Reference	`field_home_nlpg`	The National Property Gazetteer reference number	varchar	2000	TBA
Number of Residents	`field_home_num_residents`	The number of residents in the members home	int		TBA	4
Property Type	`field_home_property_type`		varchar	2000	TBA	Flat
Room number	`field_home_room`	The room name or number of the home	varchar	50	TBA	1
Tenancy	`field_home_tenancy`	The type of tenancy	varchar	2000	TBA	Lodger
Name	`field_home_owner_name`	Name of the property owner or landlord	varchar	2000	TBA	I. M. Landlord
Landlord Address Street	`field_home_owner_street`	The owner or landlords house number and street name	varchar	2000	TBA	100 High Street
Landlord Address Town	`field_home_owner_town`	The owner or landlords town	varchar	2000	TBA	Anytown
Landlord Address County	`field_home_owner_county`	The owner or landlords county	varchar	2000	TBA	Anycounty
Landlord Address Post Code	`field_home_owner_postcode`	The owner or landlords post code	varchar	2000	TBA	AB12 3CD
Landlord Address Country	`field_home_owner_country`	The owner or landlords country	varchar	2000	TBA	United Kingdom
Telephone Number	`field_home_owner_telephone_no`	Contact telephone number for the owner or landlord	varchar	2000	TBA	07890 123456
Email Address	`field_home_owner_email_address`	email address for the owner or landlord	varchar	2000	TBA	landlord@ .....

Public Services Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

My Council 🔗︎ click to copy

ds_local_authority

Data relating to a members Local Authority

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Authority Name	`field_la_authority_name`	The name of the members local authority	varchar	2000	TBA	East Herts Council
Council Tax Band	`field_la_council_tax_band`	The Council Tax band	varchar	2000	TBA	D
Council Address Street	`field_la_street`	The council street name and building name or number	varchar	2000	TBA	1 High Street
Council Address Town	`field_la_town`	The council town	varchar	2000	TBA	Watford
Council Address County	`field_la_county`	TThe council county	varchar	2000	TBA	Essex
Council Address PostCode	`field_la_postcode`	The council postcode	varchar	2000	TBA	NB1 1AZ
Council Address Country	`field_la_country`	The council country	varchar	2000	TBA	England
Date From	`field_la_date_from`	The date the member moved into the area	int		TBA	29222
Date To	`field_la_date_to`	The date the member left the area	int		TBA	29222
Council Address eMail	`field_la_email`	The council email address	varchar	2000	TBA	name@council.gov
Council Address Telephone	`field_la_telephone`	The council telephone number	varchar	2000	TBA	(44) 01234 123456
Council Address Fax	`field_la_fax`	The council fax number	varchar	2000	TBA	(44) 01234 123456
My Contact Details eMail	`field_la_user_email`	The members email address registered with the council	varchar	2000	TBA	name@emailprovider.com
My Contact Details Mobile	`field_la_user_mobile`	The members telephone number	varchar	2000	TBA	(44) 01234 123456
My Contact Details Telephone	`field_la_user_telephone`	The members telephone number	varchar	2000	TBA	(44) 01234 123456

Financial Services 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Bank Account 🔗︎ click to copy

ds_bank_account

Details of a member's bank account

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Field ba current balance code	`field_ba_current_balance_code`	The currency code from bank account balance	varchar	2000	TBA
Field ba overdraft limit code	`field_ba_overdraft_limit_code`	The currency code from bank account overdraft	varchar	2000	TBA
Account Name	`field_ba_account_name`	The members account name	varchar	2000	TBA	Mr Joe Bloggs
Account Number	`field_ba_account_number`	The members account number	varchar	2000	TBA	12345678
Sort Code	`field_ba_sort_code`	The sort code on the members account	varchar	2000	TBA	xx-xx-xx
Type	`field_ba_type`	The type of bank account held by the member	varchar	2000	TBA	Savings
Bank Name	`field_ba_bank_name`	The name of the members bank	varchar	2000	TBA	HSBC
Branch	`field_ba_branch`	The members branch name	varchar	2000	TBA	Watford
Branch Address Street	`field_ba_branch_street`	The bank street name and building name/ number	varchar	2000	TBA	1 High Street
Branch Address Town	`field_ba_branch_town`	The bank town	varchar	2000	TBA	Watford
Branch Address County	`field_ba_branch_county`	The bank county	varchar	2000	TBA	Essex
Branch Address PostCode	`field_ba_branch_postcode`	The bank postcode	varchar	2000	TBA	NB1 1AZ
Branch Address Country	`field_ba_branch_country`	The bank country	varchar	2000	TBA	England
Branch Address Telephone	`field_ba_branch_telephone`	The bank telephone number	varchar	2000	TBA	(44) 01234 123456
Date From	`field_ba_date_from`	The date the member opened the account	int		TBA	29222
Date To	`field_ba_date_to`	The date the member closed the account	int		TBA	29222
Current Balance	`field_ba_current_balance`	The current balance on the account	int		TBA	23.45
Overdraft Limit	`field_ba_overdraft_limit`	The overdraft limit on the account	int		TBA	200

Bank Account Transactions 🔗︎ click to copy

ds_bank_account_transactions

Bank account transactions

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Transactions Date	`ba_transaction_date`	Transaction date - unix timestamp	int		TBA	29222
Transactions Description	`ba_transaction_description`	The transaction description.	varchar	255	TBA	Salary
Transactions Transaction Type	`ba_transaction_type`	The transaction type provided by organisation.	varchar	255	TBA	Direct Debit
Transactions Value	`ba_transaction_value`	The transaction value.	numeric		TBA	111.11
Currency Code	`ba_transaction_value_currency_code`	The transaction value currency code.	varchar	10	TBA	GBP

Credit Card Transactions 🔗︎ click to copy

ds_cc_transactions

Credit card transactions

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Transactions Date	`cc_transaction_date`	Transaction date - unix timestamp	int		TBA	29222
Transactions Description	`cc_transaction_description`	The transaction description.	varchar	255	TBA	Cash
Transactions Transaction Type	`cc_transaction_type`	The transaction type provided by organisation.	varchar	255	TBA
Transactions Value	`cc_transaction_value`	The transaction value.	numeric		TBA	111.11
Currency Code	`cc_transaction_value_currency_code`	The transaction value currency code.	varchar	10	TBA	GBP

Credit Card 🔗︎ click to copy

ds_credit_card

Details of the member's credit cards.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Account Name	`field_cc_account_name`	The member's surname on the card.	varchar	255	TBA	Jones
Account Number	`field_cc_account_number`	The account number.	varchar	255	TBA	12345678
Card Type	`field_cc_card_type`	The type of credit card.	varchar	255	TBA	VISA
Supplier	`field_cc_supplier`	The credit card supplier.	varchar	255	TBA	HSBC
Date From	`field_cc_date_from`	The date the member opened the account.	int		TBA	29222
Date To	`field_cc_date_to`	The date the member closed the account.	int		TBA	29222
Credit Limit	`field_cc_credit_limit`	The credit limit.	int		TBA	2000
Balance	`field_cc_current_balance`	The current balance of the credit card.	float		TBA	245.67
Contact Address Street	`field_cc_contact_street`	The member contact house number and street name.	varchar	255	TBA	1 High Street
Contact Address Town	`field_cc_contact_town`	The member's contact town.	varchar	255	TBA	Watford
Contact Address County	`field_cc_contact_county`	The member's contact county.	varchar	255	TBA	Essex
Contact Address PostCode	`field_cc_contact_postcode`	The member's contact postcode.	varchar	255	TBA	NB1 1AZ
Contact Address Country	`field_cc_contact_country`	The member's contact country.	varchar	255	TBA	England
Contact Address Telephone	`field_cc_contact_telephone`	The member's contact telephone number.	varchar	255	TBA	(44) 01234 123456

Utility Services Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Utility Account Details 🔗︎ click to copy

ds_utility

Data relating to a members utilities accounts

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Account Name	`field_utility_account_name`	The member's surname.	varchar	255	TBA	Jones
Account Type	`field_utility_account_type`	The type of utility account held by the member.	varchar	255	TBA	Pay as you go
Customer No	`field_utility_customer_num`	The member's customer account number for the utility supply.	varchar	255	TBA	12345678
Tariff	`field_utility_tariff`	Tariff or plan basis for consumption.	varchar	255	TBA
Supplier Name	`field_utility_supplier_name`	The utility service supplier.	varchar	255	TBA	British Gas
Service	`field_utility_service`	The utility service supplied to the member.	varchar	255	TBA	Gas
Contact Address Contact Name	`field_utility_contact_name`	The name of the contact at the utility company.	varchar	255	TBA	Fred Bloggs
Contact Address eMail	`field_utility_contact_email`	The utility company email address.	varchar	255	TBA	name@utilityprovider.com
Contact Address Telephone	`field_utility_contact_telephone`	The utility company telephone number.	varchar	255	TBA	(44) 01234 123456
Contact Address Street	`field_utility_contact_street`	The utility company street name and building name/number.	varchar	255	TBA	1 High Street
Contact Address Town	`field_utility_contact_town`	The utility company town.	varchar	255	TBA	Watford
Contact Address County	`field_utility_contact_county`	The utility company county.	varchar	255	TBA	Essex
Contact Address PostCode	`field_utility_contact_postcode`	The utility company postcode.	varchar	255	TBA	NB1 1AZ
Contact Address Country	`field_utility_contact_country`	The utility company country.	varchar	255	TBA	England
Contact Address Fax	`field_utility_contact_fax`	The utility company fax number.	varchar	255	TBA	(44) 01234 123456
Billing Address Street	`field_utility_billing_street`	The member home house number and street name.	varchar	255	TBA	1 High Street
Billing Address Town	`field_utility_billing_town`	The member's home town.	varchar	255	TBA	Watford
Billing Address County	`field_utility_billing_county`	The member's home county.	varchar	255	TBA	Essex
Billing Address PostCode	`field_utility_billing_postcode`	The member's home postcode.	varchar	255	TBA	NB1 1AZ
Billing Address Country	`field_utility_billing_country`	The member's home country.	varchar	255	TBA	England
Supplied Address Street	`field_utility_supplied_street`	The member supplied house number and street name.	varchar	255	TBA	1 High Street
Supplied Address Town	`field_utility_supplied_town`	The member's home town.	varchar	255	TBA	Watford
Supplied Address County	`field_utility_supplied_county`	The member's home county.	varchar	255	TBA	Essex
Supplied Address PostCode	`field_utility_supplied_postcode`	The member's home postcode.	varchar	255	TBA	NB1 1AZ
Supplied Address Country	`field_utility_supplied_country`	The member's home country.	varchar	255	TBA	England
Tel Number	`field_utility_tel_number`	The member's telephone number.	varchar	255	TBA	(44) 01234 123456
Date From	`field_utility_date_from`	The date supply commenced.	varchar	255	TBA	29222
Date To	`field_utility_date_to`	The date supply ceased.	varchar	255	TBA	29222
Payment Method	`field_utility_payment_method`	The payment method used by the member.	varchar	255	TBA	Direct Debit

Utility Meter Readings 🔗︎ click to copy

ds_utility_meter_readings

Utility meter readings

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Utility Transactions Meter Read Date	`utility_reading_date`	Meter read date - unix timestamp.	int		TBA
Utility Transactions Meter Reading	`utility_reading`	Meter reading amount.	numeric		TBA
Utility Transactions Estimated	`utility_reading_estimated`	Boolean indicating whether the meter reading is estimated.	varchar	5	TBA	Y/N
Meter Reading Type	`utility_reading_type`	The type of meter reading (helps to distinguish on mixed bills).	varchar	20	TBA
Utility Transactions Metering Unit	`utility_reading_unit`	Metering unit.	varchar	255	TBA	kWh
Utility Transactions Read By	`utility_reading_read_by`	Metering unit.	varchar	255	TBA	Auto

Utility Billing Records 🔗︎ click to copy

ds_utility_billing

Utility billing

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Utility Transactions Billing Period Start	`utility_billing_start`	Billing period start - unix timestamp	int		TBA
Utility Transactions Billing Period End	`utility_billing_end`	Billing period end - unix timestamp.	int		TBA
Utility Transactions Cost	`utility_billing_total`	Billing total.	numeric		TBA	122.22
Currency Code	`utility_billing_total_currency_code`	The billing total currency code.	varchar	10	TBA	GBP

Telephone Calls and SMS 🔗︎ click to copy

ds_utility_tel_calls

Telephone calls

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Telecoms Transactions Date	`utility_tel_call_date`	Call date - unix timestamp.	int		TBA	29222
Telecoms Transactions Duration	`utility_tel_call_duration`	The duration of the call (seconds).	int		TBA	0.050138888888889
Incoming/Outgoing	`utility_tel_call_incoming_outgoing`	Is this record an incoming or outgoing call/sms.	varchar	10	TBA
Telecoms Transactions Number Called	`utility_tel_call_number_called`	Telephone number called	varchar	255	TBA	(44) 01234 123456
Telecoms Transactions Transaction Type	`utility_tel_call_type`	The call type. Variable by operator	varchar	255	TBA	Call or SMS
Telecoms Transactions Charge Type	`utility_tel_call_charge_type`	The charge type Variable by operator.	varchar	255	TBA	Included
Telecoms Transactions Cost	`utility_tel_call_cost`	The cost of the call.	numeric		TBA	122.22
Currency Code	`utility_tel_call_currency_code`	The call cost currency code.	varchar	10	TBA	GBP

Utility Data Usage 🔗︎ click to copy

ds_utility_data_usage

Data usage

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Data Transactions Date	`utility_data_usage_date`	Usage date - unix timestamp.	int		TBA	41254
Data Transactions Data Used	`utility_data_usage_data_used`	The amount of data used.	numeric		TBA	2MB
Data Transactions Charge Type	`utility_data_usage_charge_type`	The data usage charge type. Variable by operator	varchar	255	TBA	Included
Data Transactions Cost	`utility_data_usage_cost`	The cost of the data usage.	numeric		TBA	12.45
Currency Code	`utility_data_usage_currency_code`	The call cost currency code.	varchar	10	TBA	GBP

Energy Consumption 🔗︎ click to copy

ds_energy_consumption

Stores detailed level energy consumption at watts

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Energy account instance	`energy_account_instance`	The energy account this data is linked to.	int		TBA
Created Timestamp	`created_timestamp`	Timestamp of when record was created.	int		TBA	1641909333
Source Type	`field_energy_source_type`	Identifies the type of reading device. CAD, CLIP or IAM	varchar	30	TBA	CAD
Source Name	`field_energy_source_name`	A human meaningful label for the source device. Source device from ds_device_record	varchar	30	TBA	Kettle
Source ID	`field_energy_source_index_id`	Unique identifier for the source device.	varchar	30	TBA	1
Updated Timestamp	`updated_timestamp`	Timestamp of when record was last updated.	int		TBA	1641909333
Home ID	`field_energy_homeid`	The HomeID where the device is located.	int		TBA	1
Reading timestamp	`field_energy_reading_timestamp`	The data and time for a specific reading.	int		TBA	1648633780
Reading Value	`field_energy_reading_value`	The energy reading value. Watt	int		TBA	1123.25

Energy Consumption Aggregated 🔗︎ click to copy

ds_energy_consumption_aggregated

Stores energy consumption summary data as kWh

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Energy Account	`energy_account_instance`	The energy account this data is linked to.	int		TBA	8
Created Timestamp	`created_timestamp`	Timestamp of when record was created.	int		TBA	1641909333
Home ID	`field_energy_homeid`	The HomeID where the device is located.	int		TBA	1
Source Name	`field_energy_source_name`	A human meaningful label for the source device. Source device from ds_device_record	varchar	30	TBA	Kettle
Updated Timestamp	`updated_timestamp`	Timestamp of when record was last updated.	int		TBA	1641909333
Source Type	`field_energy_source_type`	Identifies the type of reading device. CAD, CLIP or IAM	varchar	30	TBA	CAD
Source ID	`field_energy_source_index_id`	Unique identifier for the source device.	varchar	30	TBA	1
Reading timestamp	`field_energy_reading_timestamp`	The data and time for a specific reading.	int		TBA	1648633780
Reading Value	`field_energy_reading_value`	The energy reading value. kWh	int		TBA	1123.25

Volunteering Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Voluntary 🔗︎ click to copy

ds_voluntary

Details of voluntary activities.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
ID Number	`field_vol_id_number`	The member's ID number.	varchar	255	TBA	23
CRB CRB Number	`field_vol_crb_number`	The member's CRB number.	varchar	255	TBA	123456789
CRB Date of Expiry	`field_vol_date_of_expiry`	The expiration date of the CRB.	int		TBA	1638375529
CRB Expiry Alert	`field_vol_expiry_alert`	The expiration alert date of the CRB.	int		TBA
Host Organisation	`field_vol_host_organisation`	The host organisation name.	varchar	255	TBA	Organisation
Organisation Name	`field_vol_organisation_name`	The name of the organisation.	varchar	255	TBA	Council
Contact Address Street	`field_vol_organisation_street`	The contact address street.	varchar	255	TBA	Main St
Contact Address Town	`field_vol_organisation_town`	The contact address town.	varchar	255	TBA	Glasgow
Contact Address County	`field_vol_organisation_county`	The contact address county.	varchar	255	TBA	Lanarkshire
Contact Address Postcode	`field_vol_organisation_postcode`	The contact address postcode.	varchar	255	TBA	AB1 1CD
Contact Address Country	`field_vol_organisation_country`	The contact address country.	varchar	255	TBA	United Kingdom
Place of Activity	`field_vol_place_of_activity`	The volunteering place of activity.	varchar	255	TBA	Office
Volunteer Hours	`field_vol_volunteer_hours`	The member's volunteering hours.	varchar	255	TBA	12
Volunteer Role	`field_vol_volunteer_role`	The member's volunteer role.	varchar	255	TBA	Administrative Assistant
Volunteering Pathway	`field_vol_volunteering_pathway`	Volunteering pathway.	varchar	255	TBA	Beginner
Notes	`field_vol_notes`	Additional notes.	varchar	255	TBA	Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Travel Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Location Data 🔗︎ click to copy

ds_location_data

Location data from devices.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
App Name	`location_data_app_name`	The app name creating the location data record.	varchar	50	TBA	Google Maps
Device Name	`location_data_device_name`	The device name creating the location data record.	varchar	50	TBA	Tablet
Longitude	`location_data_longitude`	The longitude of the location.	numeric	20	TBA	4.2518
Latitude	`location_data_latitude`	The latitude of the location.	numeric	20	TBA	55.8642
Address Line 1	`location_data_address1`	The address line 1.	varchar	128	TBA	1 Example st
Address Line 2	`location_data_address2`	The address line 2.	varchar	128	TBA	18
Town/City	`location_data_towncity`	The address town/city.	varchar	128	TBA	Glasgow
County	`location_data_county`	The address county.	varchar	128	TBA	Lanarkshire
Postcode	`location_data_postcode`	The address postcode.	varchar	128	TBA	AB1 2CD
Country	`location_data_country`	The address country.	varchar	128	TBA	United Kingdom
Timestamp	`location_data_timestamp`	The timestamp the location data was created.	int		TBA	1638375529
Timezone	`location_data_timezone`	The timezone the location data was created.	varchar	5	TBA	Greenwich Mean Time

Travel Card 🔗︎ click to copy

ds_travel

Details of travel arrangements.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Card Number	`field_tr_card_number`	The member's travel card number.	varchar	255	TBA	12345678
Card Type	`field_tr_card_type`	The member's travel card type.	varchar	255	TBA	Savings
Current Balance	`field_tr_current_balance`	Current balance of the member's travel card.	int		TBA	23.45

Journeys 🔗︎ click to copy

ds_journeys

Journey data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Transactions Date	`journey_date`	Journy date - unix timestamp.	int		TBA	1638375529
Transactions Start Time	`journey_start_time`	Journy start time - unix timestamp.	int		TBA	1641989731
Transactions End Time	`journey_end_time`	Journy end time - unix timestamp.	int		TBA	1638375529
Transactions Origin	`journey_origin`	The origin of the journey.	varchar	255	TBA	Edinburgh
Transactions Destination	`journey_destination`	The destination of the journey.	varchar	255	TBA	Belfast
Transactions Transaction Value	`journey_transaction_value`	The transaction value of the journey.	numeric		TBA	145.0

Identity Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Identity Protocol Settings 🔗︎ click to copy

ds_identity_protocol_settings

Stores Identity protocol settings.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Name	`identity_protocol`	The name of the Identity protocol.	varchar	50	TBA	Profile
Email Setting	`identity_protocol_email_setting`	The email preference for this protocol.	int		TBA	John@email.com
Email Setting Text	`identity_protocol_email_setting_text`	This will either be an email address or message text.	varchar	50	TBA	John@email.com
ID	`identity_protocol_id`	The ID used with this protocol.	varchar	50	TBA	2
Status	`identity_protocol_status`	Whether Identity protocol is enabled.	int		TBA	1

Identity Services Log 🔗︎ click to copy

ds_identity_services_log

Identity Services Log

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Identity service annotation	`identity_service_annotation`	The service log annotation by the user.	text		TBA
Identity service created	`identity_service_created`	The timestamp of the created Identity Service.	int		TBA
Identity service tags	`identity_service_tags`	The log tags comma separated.	varchar	1000	TBA
Identity service type	`identity_service_type`	The Identity Service type.	varchar	30	TBA
Identity service url	`identity_service_url`	The Identity Service URL.	varchar	2000	TBA
Ip address	`ip_address`	The IP address of the request.	varchar	50	TBA
Title	`identity_service_title`	The Identity Service Title.	varchar	50	TBA	Project A
Status	`identity_service_status`	Boolean indicating whether the Identity was successfully used.	int		TBA	1

MFA Settings 🔗︎ click to copy

ds_identity_mfa_settings

Stores records of Members MFA settings

Field Name	Machine Name	Description	Type	Max Size	Validation
created	`created`	Created Timestamp	int		TBA
digest	`digest`	The digest used with this OTP.	varchar	10	TBA
digits	`digits`	Number of digits for the OTP code.	int		TBA
email	`email`	Email address.	varchar	50	TBA
mobile	`mobile`	Mobile number.	varchar	50	TBA
name	`name`	The name of the device	varchar	50	TBA
period	`period`	Period for the OTP to be valid.	int		TBA
preferred	`preferred`	Device is the preferred MFA device.	int		TBA
secret	`secret`	OTP device secret.	varchar	1000	TBA
status	`status`	Status	int		TBA
type	`type`	Type of OTP device.	varchar	10	TBA
updated	`updated`	Updated Timestamp	int		TBA

Assurance Log 🔗︎ click to copy

ds_assurance_log

Logs all assurance records.

Field Name	Machine Name	Description	Type	Max Size	Validation
Date Created	`assurance_created`	The timestamp of the created Assurance record.	int		TBA
IDP	`assurance_idp`	The IDP of the assurance record.	varchar	100	TBA
Assurance Level	`assurance_level`	The level of assurance.	int		TBA
Data Used	`assurance_data_used`	The actual data used to gain the assurance level.	varchar		TBA
Matching Datasets	`assurance_matching_datasets`	The matching datasets used for the assurance level.	varchar		TBA
PID	`assurance_pid`	The PID of the record (GOV.UK Assurance).	varchar	32	TBA

Journal Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Journal 🔗︎ click to copy

ds_journal

Journal

Field Name	Machine Name	Description	Type	Validation	Example
User ID	`user_id`	User ID.	int	TBA	1
Conversation ID	`conversation_id`	Conversation ID.	string	TBA	12348
Created Timestamp	`created_timestamp`	Created Timestamp	int	TBA	1638375529
Updated Timestamp	`updated_timestamp`	Updated Timestamp	int	TBA	1861227082
Journal Time Sent	`journal_time_sent`	The Unix timestamp that the journal was sent.	int	TBA	1638375529
Journal Time Received	`journal_time_received`	The Unix timestamp that the journal was received.	int	TBA	1639153129
Journal To	`journal_to`	The person/organisation they are replying to if this is a reply.	text	TBA	Glasgow Council
Service Id	`service_id`	Which account or service did the message come from.	text	TBA	Volunteer Service
Service Name	`service_name`	The unique name of the member on the service e.g Twitter handle.	text	TBA	Antonio Morales
Service Order ID	`service_order_id`	Service Order ID.	int	TBA	1
Title	`title`	The title of the journal.	varchar	TBA	Volunteering
Journal By	`journal_by`	The individual member or organisation member that created the journal.	text	TBA	Clive Lewis
Journal Content	`journal_content`	The content of the journal entry.	blob	TBA	"New Entry"
Tags	`tags`	The tags associated with the journal (comma separated list).	text	TBA	volunteer, community
Type	`type`	The type of journal.	varchar	TBA	Volunteer record
External ID	`external_id`	External ID.	int	TBA	1
Device Id	`device_id`	The device did the message originate from.	varchar	TBA	543
Version Id	`version_id`	The id of the journal.	int	TBA	5
Version Information	`version_information`	Meta data about the Revision, Version Number, Version Content, Version Change Description	text	TBA	Lorem ipsum dolor sit amet, consectetur adipiscing elit. In nulla urna, ullamcorper et ipsum id, bibendum iaculis nisi.
Version Content	`version_content`	The content of previous versions.	blob	TBA

Loyalty Scheme Collection 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Loyalty Scheme 🔗︎ click to copy

ds_loyalty_scheme

Loyalty scheme data

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Transactions Date	`ls_date`	transaction date - unix timestamp.	int		TBA
Transactions Description	`ls_description`	The description of the record.	varchar	255	TBA	Sainsbury's - Horsham
Transactions Points Value	`ls_points_value`	The points value of the record.	numeric		TBA
Transactions Monetary Value	`ls_monetary_value`	The transaction value of the record.	numeric		TBA
Transactions Currency Code	`ls_monetary_value_currency_code`	The monetary currency code.	varchar	10	TBA	GBP

Connection Specific 🔗︎ click to copy

Dataset Name Machine Name Description Data Fields

Connection Variables 🔗︎ click to copy

ds_connection_variables

Connection Variable data.

Field Name	Machine Name	Description	Type	Max Size	Validation	Example
Variable Name	`var_name`	The name of the variable.	varchar	100	TBA	Test
Variable Value	`var_value`	The value of the variable stored in a blob.	blob		TBA	{"var": "test"}

Back: Personal Data Store Overview Next: PDS Master Data Schema Extensions