ETL - Data Model

The information below breaks down the different CSV / tables that will be delivered in the extraction as well as the columns to be expected in each CSV / table. Information on the data type and information about that element are also shared in the below information.

Data Model

Export File Definitions

patient_info

Field

Type

Notes

patient_id

text

Unique identifier for the patient provided by client during enrollment.

Max length: 128

validic_id

text

Unique identifier for the patient user within Validic. Can be used to map to events in the Inform data stream.

Max length: 128

validic_uid

text

Alternate and unique identifier for the patient user registered in Inform during enrollment. Can be used to map to events in the Inform data stream.

Max length: 128

Not included by default. If needed speak to your CSE or open a ticket with Validic support to have it enabled

email

text

Max length: 320

phone_number

text

Max length: 20

latest_event_time

timestamp

The reading time of the most recent reading for this member. E.g. 2018-10-01 18:43:26.074932+00

latest_upload_time

timestamp

The last time this user uploaded any reading.

user_program_id

text

Max length: 20

 

provider_info

Field

Type

Notes

provider_id

text

Unique identifier for the provider.

Max length: 128

name

text

Max length: 256

email

text

Max length: 320

 

program_info

Field

Type

Notes

program_id

text

Max length: 20

name

text

Max length: 256

 

program_measurement_types

Field

Type

Notes

program_id

text

Max length: 20

measurement_type

text

"blood_glucose",

“systolic”

Programs that have multiple measures will have one row per measure.

Max length: 128

 

notification_configuration

Field

Type

Notes

patient_id

text

Max length: 128

program_id

text

Max length: 20

notification_type

text

(adherence, threshold, average)

Max length: 128

mode

text

(sms, alert, email, secure message)

Max length: 128

message

text

Member facing only

Max length: 4096

default_threshold

text

Max length: 128

configured_threshold

text

Max length: 128

window

number

Average and adherence only.

Values are in hours.

Integer

comparator

text

greater_than, less_than, equal_to

Max length: 64

provider_id

text

For provider facing only

Max length: 128

last_notify_time

timestamp

E.g. 2018-10-01 18:43:26.074932+00

user_program_id

text

Max length: 20

 

patient_program

Field

Type

Notes

patient_id

text

Max length: 128

program_id

text

Max length: 20

enrolling_provider_id

text

Max length: 128

reviewing_provider_id

text

Max length: 128

unenroll_reason

text

Max length: 4096

user_program_id

text

Identifier for this enrollment instance. Can be used to associate records (notification configuration, goals, patient program history, etc.) in the case of a user enrolled in multiple programs.

Max length: 20

 

patient_program_sources

Field

Type

Notes

patient_id

text

Max length: 128

program_id

text

Max length: 20

measurement_type

text

Max length: 128

source_name

text

Max length: 128

last_uploaded_at

timestamp

The last time the user uploaded a reading for this source.

user_program_id

text

Max length: 20

 

patient_program_history

Field

Type

Notes

patient_id

text

Max length: 128

program_id

text

Max length: 20

status

text

Awaiting Enrollment,

Enrolled by Clinician,

Email Sent,

Patient Consent,

Device Account Synced,

Initial Data Uploaded,

Abandoned,

Unenrolled,

Archived

Max length: 128

updated_at

timestamp

E.g. 2018-10-01 18:43:26.074932+00

updated_by

text

Max length: 128

user_program_id

text

Max length: 20

 

goals

Field

Type

Notes

patient_id

text

Max length: 128

program_id

text

Max length: 20

window

number

Value in hours

lower_bound

text

Max length: 128

upper_bound

text

Max length: 128

enabled

boolean

true/false

goal_type

text

The type of the goal. Examples:

  • metric/threshold (e.g. blood_glucose < 300)

  • metric/averaged_threshold (e.g. average blood_glucose < 250 over 2 weeks)

  • user/missing_data (adherence goal; e.g. blood_glucose measured at least 2 times per day)

Max length: 128

metric_type

text

The type of the metric that the goal is associated with. Examples:

“systolic”,”diastolic”,

“premeal_glucose”, “postmeal_glucose”,

“blood_glucose”, etc.

Max length: 128

updated_at

timestamp

 

updated_by

text

Provider id

Max length: 128

user_program_id

text

Max length: 20

 

 

notification_tracking

Field

Type

Notes

id

text

Unique identifier for a notification tracking record.

Max length: 80

provider_id

text

May be null in some cases for patient-facing notifications

Max length: 128

patient_id

text

Max length: 128

phone_number

text

Phone number used in the case of SMS messages

Max length: 20

email

text

Email used in the case of email messages

Max length: 320

message_type

text

Valid values include threshold, enrollment and unenrollment

Max length: 64

notification_type

text

Valid values include secure_message, inbasket, email and sms.

Max length: 64

recipient_type

text

Valid values include patient and provider

Max length: 64

response

text

Response received from the messaging service

Max length: 1024

status

text

Valid values include error and sent.

Max length: 32

created_at

timestamp

 

updated_at

timestamp

 

triggered_aggregation_type

text

May be null if notification is unrelated to a rule.

Count, average, discrete, etc. The aggregation type used by the rule for triggering.Max length: 128

window

number

May be null if notification is unrelated to a rule.

The aggregation window in hours.

rule_metric_type

text

May be null if notification is unrelated to a rule. 

The metric type of the rule.

Max length: 128

rule_metric_unit

text

May be null if notification is unrelated to a rule. 

The metric’s unit (pounds, ounces, etc) of the rule.

Max length: 128

rule_metric_origin

text

May be null if notification is unrelated to a rule, or not set.

The optional filter that, when set, limits the metrics that are observed to only those with the matching origin (device, manual, etc.)

Max length: 64

triggered_value

text

May be null if notification is unrelated to a rule.

The final calculated aggregation value that caused the rule to trigger.

Max length: 128

rule_comparator

text

May be null if notification is unrelated to a rule.

greater_than, less_than, etc.

Max length: 64

rule_threshold

text

May be null if notification is unrelated to a rule.

The target aggregation value that we compare against.

Max length: 128

data_points

json array

May be null if notification is unrelated to a rule.

A list of all relevant data points used in the calculation of our rule aggregation.

Max length: 128K

 

clinician_notes

Field

Type

Notes

id

text

Unique identifier for the note

Max length: 80

patient_id

text

Max length: 128

category

text

Max length: 128

note

text

Max length: 128K

time_spent_minutes

number

Integer

created_at

timestamp

 

created_by

text

ID of the creating provider

Max length: 128

updated_at

timestamp

 

updated_by

timestamp

ID of the updating provider

Max length: 128

 

device_usage

Field

Type

Notes

patient_id

text

Max length: 128

previous_month_days_with_reading

number

integer

current_month_days_with_reading

number

integer

previous_month_total_readings

number

integer

current_month_total_readings

number

integer