Welcome to the Clarity Human Services Data Schema Information Page.
The Customer SQL Data Model provides restricted access to the MariaDB Database to customers who have licensed access to the Model. Fields in the CSDM are restricted via Views, as to not explore the full proprietary database.
In addition to the full list of views below, you can also view the HMIS Basic ERD. This is an entity relationship diagram of the core HMIS tables available through the customer SQL model and not the entire database.
For more information on how to query the database, visit our gitlab repository.
View Names
Functions (Click Here)
Table Details
Table: clarity_access_roles
| Clarity Field | Description |
| id | Primary Key |
| ref_category | FK - access_role_categories.id |
| name | Access Role Name |
| ref_resource | FK - resources.id |
| ref_privilege | FK - privileges.id |
| position | Position |
Table: clarity_access_role_categories
| Clarity Field | Description |
| id | Primary Key |
| name | Access Role Category Name |
Table: clarity_access_role_children
| Clarity Field | Description |
| ref_parent_access_role | FK - clarity_access_roles.id |
| ref_child_access_role | FK - clarity_access_roles.id |
Table: clarity_agencies
| Clarity Field | Description |
| id | Primary Key |
| name | Agency Name |
| coc | Continuum of Care |
| clients | Client Sharing Setting |
| status | Active or Inactive |
| ref_county | FK - counties.id |
| added_date | Added Date |
| last_updated | Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
| ref_geolocation | FK - clarity_geolocation.id |
Table: clarity_agency_assessments
| Clarity Field | Description |
| id | Primary Key |
| ref_agency | FK - clarity_agencies.id |
| ref_assessment | FK - clarity_assessments.id |
| enabled | Enabled |
Table: clarity_assessments
| Clarity Field | Description |
| id | Primary Key |
| name | Assessment Name |
Table: clarity_clients
| Clarity Field | Description |
| id | Primary Key |
| unique_identifier | Unique Identifier |
| first_name | First Name |
| last_name | Last Name |
| name_quality | Quality of Name |
| ssn | Social Security Number |
| ssn_quality | Quality of Social Security Number |
| birth_date | Date of Birth |
| dob_quality | Quality of Date of Birth |
| alias | Alias |
| private | Private |
| added_date | Added Date |
| last_updated | Updated Date |
| ref_agency | FK - clarity_agencies.id |
| ref_user_updated | FK - clarity_users.id - User Updating |
| deleted | Deleted |
| general_id | ID used for identifying duplicate clients |
Table: clarity_client_addresses
| Clarity Field | Description |
| id | Primary Key |
| ref_client | FK - clarity_clients.id |
| ref_agency | FK - clarity_agencies.id |
| ref_type | References Address Types picklist |
| name | Address Name |
| Email Address | |
| phone1 | Phone Number 1 |
| phone2 | Phone Number 2 |
| status | Active Address Record |
| added_date | Added Date |
| name | Address Name |
| last_updated | Updated Date |
| ref_user | FK - clarity_users.id |
| ref_user_updated | FK - clarity_users.id |
| private | Private |
| deleted | Deleted Data |
| ref_agency_deleted | FK - clarity_agencies.id - Agency deleting the record |
| note | Note |
| Date | Date of information |
| ref_geolocation | FK - clarity_geolocation.id |
Table: clarity_client_assessment_data
| Clarity Field | Description |
| id | Primary Key |
| ref_client_assessment_demographics | FK - clarity_client_assessment_demographics |
| custom_data | Custom Data |
| ref_user | FK - clarity_users.id |
| ref_user_updated | FK - clarity_users.id |
Table: clarity_client_assessment_demographics
| Clarity Field | Description |
| id | Primary Key |
| ref_client | FK - clarity_clients.id |
| ref_agency | FK - clarity_agencies.id |
| ref_assessment | FK - clarity_assessments.id |
| assessment_date | Date of Assessment |
| assessment_location | Assessment Location |
| assessment_type | Assessment Type |
| assessment_level | Assessment Level |
| prior_residence | Prior Residence |
| gross_ann_hsld_income | Gross Annual Household Income |
| health_phys_disability | Physical Disability Type |
| health_dev_disability | Developmental Disability Type |
| health_chronic | Chronic Disability Type |
| health_hiv | HIV Disability Type |
| health_pregnancy | Pregnancy |
| housing_status | Housing Status |
| vi_spdat_q1 | What is the total length of time you have lived on the streets or in shelters? |
| vi_spdat_q1_v2 | Where do you sleep most frequently? |
| vi_spdat_q1a_v2 | If Other, Specify |
| vi_spdat_q2 | In the past three years, how many times have you been housed and then homeless again? |
| vi_spdat_q3 | In the past six months, how many times have you been to the emergency department/room? |
| vi_spdat_q4 | In the past six months, how many times have you had an interaction with the police? |
| vi_spdat_q4f_v2 | Stayed one or more nights in a holding cell, jail or prison, whether that was a short-term stay like the drunk tank, a longer stay for a more serious offense, or anything in between? |
| vi_spdat_q5 | In the past six months, how many times have you been taken to the hospital in an ambulance? |
| vi_spdat_q7 | In the past six months, how many times have you used a crisis service, including distress centers or suicide prevention hotlines? |
| vi_spdat_q6 | In the past six months, how many times have you been hospitalized as an in-patient, including hospitalizations in a mental health hospital? |
| vi_spdat_q8 | Have you been attacked or beaten up since becoming homeless? |
| vi_spdat_q9 | Threatened to or tried to harm yourself or anyone else in the last year? |
| vi_spdat_q10 | Do you have any legal stuff going on right now that may result in you being locked up or having to pay fines? |
| vi_spdat_q11 | Does anybody force or trick you to do things that you do not want to do? |
| vi_spdat_q12 | Ever do things that may be considered to be risky like exchange sex for money, run drugs for someone, have unprotected sex with someone you don't really know, share a needle, or anything like that? |
| vi_spdat_q13 | I am going to read types of places people sleep. Please tell me which one that you sleep at most often. |
| vi_spdat_q13_v2 | Are you currently able to take care of basic needs like bathing, changing clothes, using a restroom, getting food and clean water and other things like that? |
| vi_spdat_q14 | Is there anybody that thinks you owe them money? |
| vi_spdat_q14_v2 | Is your current homelessness in any way caused by a relationship that broke down, an unhealthy or abusive relationship, or because family or friends caused you to become evicted? |
| vi_spdat_q15 | Do you have any money coming in on a regular basis, like a job or government benefit or even working under the table, binning or bottle collecting, sex work, odd jobs, day labor, or anything like that? |
| vi_spdat_q15_v2 | Have you ever had to leave an apartment, shelter program, or other place you were staying because of your physical health? |
| vi_spdat_q16 | Do you have enough money to meet all of your expenses on a monthly basis? |
| vi_spdat_q16_v2 | Do you have any chronic health issues with your liver, kidneys, stomach lungs or heart? |
| vi_spdat_q17 | Do you have planned activities each day other than just surviving that bring you happiness and fulfillment? |
| vi_spdat_q17_v2 | If there was space available in a program that specifically assists people that live with HIV or AIDS, would that be of interest to you? |
| vi_spdat_q18 | Do you have any friends, family or other people in your life out of convenience or necessity, but you do not like their company? |
| vi_spdat_q18_v2 | Do you have any physical disabilities that would limit the type of housing you could access, or would make it hard to live independently because you'd need help? |
| vi_spdat_q19 | Do any friends, family or other people in your life ever take your money, borrow cigarettes, use your drugs, drink your alcohol, or get you to do things you really don't want to do? |
| vi_spdat_q19_v2 | When you are sick or not feeling well, do you avoid getting help? |
| vi_spdat_q20 | OBSERVATION ONLY: Surveyor, do you detect signs of poor hygiene or daily living skills? |
| vi_spdat_q20_v2 | FOR FEMALE RESPONDENTS ONLY: Are you currently pregnant? |
| vi_spdat_q21 | Where do you usually go for healthcare or when you're not feeling well? |
| vi_spdat_q21_v2 | Has your drinking or drug use led you to being kicked out of an apartment or program where you were staying in the past? |
| vi_spdat_q22_v2 | Kidney disease/End Stage Renal Disease or Dialysis |
| vi_spdat_q23 | Will drinking or drug use make it difficult for you to stay housed or afford your housing? |
| vi_spdat_q23a_v2 | History of frostbite, Hypothermia, or Immersion Foot |
| vi_spdat_q23c_v2 | A mental health issue or concern? |
| vi_spdat_q24 | A past head injury? |
| vi_spdat_q24_v2 | A learning disability, developmental disability, or other impairment? |
| vi_spdat_q25 | Liver disease, Cirrhosis, or End-Stage Liver Disease |
| vi_spdat_q26 | Do you have any mental health or brain issues that would make it hard for you to live independently because you'd need help? |
| vi_spdat_q26_v2 | HIV+/AIDS |
| vi_spdat_q27 | Heart disease, Arrhythmia, or Irregular Heartbeat |
| vi_spdat_q28 | Emphysema |
| vi_spdat_q29 | Diabetes |
| vi_spdat_q30 | Asthma |
| vi_spdat_q31 | Cancer |
| vi_spdat_q32 | Hepatitis C |
| vi_spdat_q33 | Tuberculosis |
| vi_spdat_q34 | OBSERVATION ONLY: Surveyor, do you observe signs or symptoms of a serious health condition? |
| vi_spdat_q35 | Have you ever had a problematic drug or alcohol use, abused drugs or alcohol, or told you do? |
| vi_spdat_q36 | Have you consumed alcohol and/or drugs almost every day or every day for the past month? |
| >vi_spdat_q37 | Have you ever used injection drugs or shots in the last six months? |
| vi_spdat_q38 | Have you ever been treated for drug or alcohol problems and returned to drinking or using drugs? |
| vi_spdat_q39 | Have you used non-beverage alcohol like cough syrup, mouthwash, rubbing alcohol, cooking wine, or anything like that in the past six months? |
| vi_spdat_q40 | Have you blacked out because of your alcohol or drug use in the past month? |
| vi_spdat_q41 | OBSERVATION ONLY: Surveyor, do you observe signs or symptoms of problematic alcohol or drug abuse? |
| vi_spdat_q42 | Ever been taken to a hospital against your will for a mental health reason? |
| vi_spdat_q43 | Gone to the emergency room because you weren't feeling 100% well emotionally or because of your nerves? |
| vi_spdat_q44 | Spoken with a psychiatrist, psychologist or other mental health professional in the last six months because of your mental health - whether that was voluntary or because someone insisted that you do so? |
| vi_spdat_q45 | Has a serious brain injury or head trauma? |
| vi_spdat_q46 | Ever been told you have a learning disability or developmental disability? |
|
vi_spdat_q47 |
Do you have any problems concentrating and/or remembering things? |
|
vi_spdat_q48 |
OBSERVATION ONLY: Surveyor, do you detect signs or symptoms of severe, persistent mental illness or severely compromised cognitive functioning? |
|
vi_spdat_q49 |
Have you had any medicines prescribed to you by a doctor that you do not take, sell, had stolen, misplaced, or where the prescriptions were never filled? |
|
vi_spdat_q50 |
Yes or No - Have you experienced any emotional, physical, psychological, sexual or other type of abuse or trauma in your life which you have not sought help for, and/or which has caused your homelessness? |
|
vi_spdat_flwup_1 |
Where did you live prior to becoming homeless? |
| previous_foster_care | Previous foster care |
| previous_jail | Previous jail |
| previous_prison | Previous prison |
| chronic_1 | Continually Homeless for at least One Year |
| chronic_2 | Times Homeless in the Past Three Years |
| chronic_3 | Total Months Homeless in the Past Three Years |
| ami_percent | AMI Percent |
|
vi_f_spdat_children_num |
Number of Children |
|
vi_f_spdat_child1_fullname |
Child 1 Full Name |
|
vi_f_spdat_child1_dob |
Child 1 DoB |
|
vi_f_spdat_child2_fullname |
Child 2 Full Name |
|
vi_f_spdat_child2_dob |
Child 2 DoB |
|
vi_f_spdat_child3_fullname |
Child 3 Full Name |
|
vi_f_spdat_child3_dob |
Child 3 DoB |
|
vi_f_spdat_child4_fullname |
Child 4 Full Name |
|
vi_f_spdat_child4_dob |
Child 4 DoB |
|
vi_f_spdat_child5_fullname |
Child 5 Full Name |
|
vi_f_spdat_child5_dob |
Child 5 DoB |
|
vi_f_spdat_child6_fullname |
Child 6 Full Name |
|
vi_f_spdat_child6_dob |
Child 6 DoB |
|
vi_f_spdat_child7_fullname |
Child 7 Full Name |
|
vi_f_spdat_child7_dob |
Child 7 DoB |
|
vi_f_spdat_child8_fullname |
Child 8 Full Name |
|
vi_f_spdat_child8_dob |
Child 8 DoB |
|
vi_f_spdat_child9_fullname |
Child 9 Full Name |
|
vi_f_spdat_child9_dob |
Child 9 DoB |
|
vi_f_spdat_child10_fullname |
Child 10 Full Name |
|
vi_f_spdat_child10_dob |
Child 10 DoB |
|
vi_f_spdat_pregnancy |
Pregnancy |
|
vi_f_spdat_second_hoh |
Second HoH |
|
vi_f_spdat_hh2_fullname |
2nd HoH Full Name |
|
vi_f_spdat_hh2_dob |
2nd HoH DoB |
|
vi_f_spdat_hh2_gender |
2nd HoH Gender |
|
vi_f_spdat_q28_v2 |
Does any single member of your household have a medical condition, mental health concerns, and experience with problematic substance use? |
|
vi_f_spdat_q32_v2 |
Are there any children that have been removed from the family by a child protection service within the last 180 days? |
|
vi_f_spdat_q33_v2 |
Do you have any family legal issues that are being resolved in court or need to be resolved in court that would impact your housing or who may live within your housing? |
|
vi_f_spdat_q34_v2 |
In the last 180 days have any children lived with family or friends because of your homelessness or housing situation? |
|
vi_f_spdat_q35_v2 |
Has any child in the family experienced abuse or trauma in the last 180 days? |
|
vi_f_spdat_q36_v2 |
Do your children attend school more often than not each week? |
|
vi_f_spdat_q37_v2 |
Have the members of your family changed in the last 180 days, due to things like divorce, your kids coming back to live with you, someone leaving for military service or incarceration, a relative moving in, or anything like that? |
|
vi_f_spdat_q38_v2 |
Do you anticipate any other adults or children coming to live with you within the first 180 days of being housed? |
|
vi_f_spdat_q39_v2 |
Do you have two or more planned activities each week as a family such as outings to the park, going to the library, visiting other family, watching a family movie, or anything like that? |
|
vi_f_spdat_q40a_v2 |
3 or more hours per day for children aged 13 or older? |
|
vi_f_spdat_q40b_v2 |
2 or more hours per day for children aged 12 or younger? |
|
vi_f_spdat_q41 |
Has any family member under the legal drinking age consumed alcohol four or more times in the last month or used drugs at any point in time during the last month - including marijuana or prescription pills to get high? |
|
vi_f_spdat_q41_v2 |
Do your older kids spend 2 or more hours on a typical day helping their younger sibling(s) with things like getting ready for school, helping with homework, making them dinner, bathing them, or anything like that? |
|
vi_f_spdat_q50 |
You indicated in your responses that there is a medical condition, experience with mental health services and experience with substance use. Is that the same member of the family in all of those instances? |
|
vi_f_spdat_q53 |
Do any of your children spend two or more hours per day when you don't know where they are? |
|
vi_f_spdat_q54 |
On most days, do any children do tasks that adults would normally do like preparing meals, getting other children ready for bedtime, shopping, cleaning the apartment, or anything like that? |
|
vi_f_spdat_q55 |
What is the total number of times adults in the family have changed in the family over the past year because of things like new relationships or a breakdown in the relationship, prison, military deployment, or anything like that? |
|
vi_f_spdat_q56 |
What is the total number of times that children have been separated from the family or returned to the family over the past year? |
|
vi_f_spdat_q57 |
Are there any school-aged children that are not enrolled in school or missing more days of school than they are attending? |
|
vi_f_spdat_q58 |
Right now or at any point in the last six months have any of your children been separated from you to live with a family member or friend? |
|
vi_f_spdat_q59 |
Has there been any involvement with any member of your family and child protective services in the last six months - even if it was resolved? |
|
vi_f_spdat_q60 |
Have you had anything in family court over the past six months or anything currently being considered in family court? |
| vi_y_spdat_q8 | Were you ever incarcerated when younger than age 18? |
| vi_y_spdat_q15a | Because you ran away from your family home, a group home or a foster home? |
| vi_y_spdat_q15b | Because of a difference in religious or cultural beliefs from your parents, guardians or caregivers? |
| vi_y_spdat_q15c | Because your family or friends caused you to become homeless? |
| vi_y_spdat_q15d | Because of conflicts around gender identity or sexual orientation? |
| vi_y_spdat_q15e | Because of violence at home between family members? |
| vi_y_spdat_q24 | If you've ever used marijuana, did you ever try it at age 12 or younger? |
| vi_y_spdat_q1 | VI-Y-SPDAT History Q1 |
| vi_spdat_q1a_v2 | If Other, Specify |
| vi_y_spdat_q1a | If Other, Specify |
| ssvf_targeting_field_3 | Current Household Income is $0 |
| ssvf_targeting_field_7 |
Rental Evictions Within the Past 7 Years
|
| ssvf_targeting_field_9 | History of Literal Homelessness (Street/Shelter/Transitional Housing) |
| ssvf_targeting_field_12 | Registered Sex Offender |
| ssvf_targeting_field_13 | At Least One Dependent Child Under Age 6 |
| ssvf_targeting_field_14 | Single Parent With Minor Child(ren) |
|
private |
Private |
|
added_date |
Date Added |
|
last_updated |
Date Last Updated |
|
ref_user |
FK - clarity_users.id |
|
ref_user_updated |
FK - clarity_users.id |
| ref_user_home_agency |
FK - clarity_agencies.id - users home agency |
|
deleted |
Deleted |
|
private |
Private |
|
income_earned |
Earned Income Amount |
|
income_earned_is |
Earned Income Source |
|
exit_destination |
Exit Destination |
|
exit_destination_other |
Exit Destination Other |
|
current_temperature |
Current Temperature |
|
feverish_is |
Is Feverish |
|
difficulty_breathing_is |
Is having difficulty breathing |
|
covid_exposed |
COVID Exposed |
|
covid_exposed_documentation |
COVID Exposed Documentation |
|
lung_disease_is |
Has Lung Disease |
|
immunocompromised_is |
Is Immunocompromised |
|
obesity_is |
Is Obsese |
|
diabetes_is |
Has Diabetes |
|
kidney_disease_is |
Has Kidney Disease |
|
liver_disease_is |
Has Liver Disease |
|
blood_pressure_is |
Has Blood Pressure Problems |
|
cough_is |
Has Serious Cough |
|
covid_test_positive |
Has Tested Positive for COVID |
|
social_distancing |
Social Distancing |
Table: clarity_client_assessment_scores
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_assessment |
FK - clarity_client_assessment_demographics.id |
|
score_type |
Assessment Score Type |
|
score |
Assessment Score |
|
detail |
Assessment Detail |
Table: clarity_common_logs
| Clarity Field | Description |
| id | Primary Key |
| source_table | Table the action took place on |
| ref_source | FK - log_source_tables |
| prev_record | Previous Record |
| curr_record | New Record |
| date | Date of Action |
| ref_user | FK - users |
| log_source | |
| ref_agency | FK - agencies |
| ref_client | FK - clients |
| ref_setting | |
| ref_queue | |
| is_autoexited | |
| is_reopened | |
| is_restored | |
| is_autoexpired | |
| screen_type | |
| status_screen_type | |
| version | |
| template | |
| replicated | |
| deleted | |
| auto_published | |
| ref_module | |
| ref_enabled | |
| benchmark_autoexit | |
| imported_id |
Table: clarity_client_contacts
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_agency |
FK - clarity_agencies.id |
|
ref_type |
Contact Types |
|
name |
Contact Name |
|
|
Email Address |
|
phone1 |
Phone contact #1 |
|
phone2 |
Phone contact #2 |
|
Status |
Active or inactive |
|
private |
Private |
|
date |
Date of information |
|
note |
Note |
|
ref_user |
FK - clarity_users.id |
|
added_date |
Date Added |
|
last_updated |
Date Updated |
|
ref_user_updated |
FK - clarity_users.id |
|
deleted |
Deleted |
|
ref_agency_deleted |
FK - clarity_agencies.id |
Table: clarity_client_data
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_demographics |
FK - clarity_client_demographics |
|
custom_data |
Custom Data |
|
ref_user |
FK - clarity_users.id |
|
ref_user_updated |
FK - clarity_users.id |
Table: clarity_client_demographics
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
gender |
Gender |
|
ethnicity |
Ethnicity |
|
race |
Race |
|
name_middle |
Middle Name |
|
name_suffix |
Suffix |
| zipcode | Zip Code |
| primary_language | Primary Language |
|
veteran |
Veteran Status |
|
veteran_entered |
Year Entered Military Service |
|
veteran_separated |
Year Separated Military Service |
|
veteran_theater_ww2 |
Theater of Operations: World War II |
|
veteran_theater_kw |
Theater of Operations: Korean War |
|
veteran_theater_vw |
Theater of Operations: Vietnam War |
|
veteran_theater_pg |
Theater of Operations: Persian Gulf War |
|
veteran_theater_afg |
Theater of Operations: Afghanistan |
|
veteran_theater_iraq1 |
Theater of Operations: Iraq (Iraqi Freedom) |
|
veteran_theater_iraq2 |
Theater of Operations: Iraq (New Dawn) |
|
veteran_theater_other |
Theater of Operations: Other Operations |
|
veteran_branch |
Branch of Military |
|
veteran_discharge |
Discharge Status |
Table: clarity_client_events
| Clarity Field | Description |
| id | Primary Key |
| ref_client | FK - clients |
| ref_client_program | FK - client_programs |
| ref_event | FK - events |
| ref_referral | FK - referrals |
| type | 1: inferred, 2: manual |
| date | date |
| safe_alternative_housing | Data Element 4.20 sub element |
| aftercafe_project | Data Element 4.20 sub element |
| location_ph_housing | Data Element 4.20 sub element |
| referral_result | Data Element 4.20 sub element |
| result_date | Data Element 4.20 sub element |
| note | Data Element 4.20 sub element |
| ref_user | FK - users |
| ref_user_updated | FK - users |
| added_date | Date record added |
| last_updated | Date record last updated |
| deleted | record has been deleted |
| ref_agency_deleted | FK - agencies |
| ref_user_home_agency | FK - agencies |
| ref_geolocation | FK - geolocations |
| hidden_on_customer_portal | Record deleted |
| ref_agency | FK - agencies |
| private | Record is private |
| manually_changed | Record manually updated |
Table: clarity_client_field_interactions
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_user |
FK - clarity_users.id - User Creating |
|
date |
Date of Interaction |
|
added_date |
Date Added |
|
last_updated |
Date Updated |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
|
ref_agency |
FK - clarity_agencies.id |
|
ref_geolocation |
FK - clarity_geolocation.id |
Table: clarity_client_files
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_creator |
FK - users.id |
|
ref_file |
FK - files.id |
|
ref_file_name |
FK - client_file_names.id |
|
ref_category |
FK - client_file_categories.id |
|
name |
Name of the file |
|
private |
Private |
|
added_date |
Date Added |
|
last_updated |
Date Updated |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
|
ref_agency |
FK - clarity_agencies.id |
|
deleted |
Deleted |
Table: clarity_client_file_categories
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
name |
File Name |
Table: clarity_client_file_names
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
name |
File Name |
|
ref_category |
FK - client_file_categories.id |
Table: clarity_client_groups
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
date_created |
Date the group was created |
Table: clarity_client_group_members
| Clarity Field | Description |
| id | Primary Key |
| ref_group | FK - client_groups.id |
| ref_client | FK - clarity_clients.id |
| ref_type | FK - client_group_types.id |
| start_date | Start Date |
| end_date | End Date |
Table: clarity_client_notes
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_agency |
FK - clarity_agencies.id |
|
title |
Note title |
|
note |
Note Content |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_users.id - User creating |
|
ref_user_updated |
FK - clarity_users.id - User updating |
|
private |
Private |
|
ref_client_program |
FK - clarity_client_programs.id |
|
date |
Date |
|
tracking_hour |
Hours Time Tracked |
|
tracking_minute |
Minutes Time Tracked |
|
deleted |
Deleted |
|
ref_agency_deleted |
FK - clarity_agencies.id - Agency which deleted the record |
Table: clarity_client_programs
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_program |
FK - clarity_programs.id |
|
ref_agency |
FK - clarity_agencies.id |
|
ref_head |
FK - clarity_clients.id (Head of Household) |
|
ref_household |
FK clarity_households |
|
start_date |
Start Date |
|
end_date |
End Date |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_users.id - User Creating |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
|
deleted |
Deleted Data |
|
private |
Private |
Table: clarity_client_program_assessments
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_program |
FK - clarity_client_programs.id |
|
ref_client_assessment |
FK - clarity_client_assessments.id |
Table: clarity_client_program_data
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_program_demographics |
FK - clarity_client_program_demographics |
|
custom_data |
Custom Data |
|
ref_user |
FK - clarity_users.id - User Creating |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
Table: clarity_client_program_demographics
|
Clarity Field |
Description |
|---|---|
| id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_program |
FK - clarity_client_programs.id |
|
ref_agency |
FK - clarity_agencies.id |
|
screen_type |
Data Collection Stage |
|
status_screen_type |
Status Screen Type |
|
program_date |
Information Date for Programs where Data Collection Stage is Status Assessment or Annual Update |
|
relationship_to_hoh |
Relationship to Head of Household |
|
housing_status |
Housing Status (Collected on Enrollment and Exit Only) |
|
prior_residence |
Residence Prior to Program Entry (Enrollment Only) |
|
prior_duration |
Length of Stay in Prior Residence |
|
permanent_housing_is |
In Permanent Housing |
|
move_in_date |
Date of Move-In (If Yes to In Permanent Housing) |
|
chronic_6 |
Client Entering From the Streets, ES, or Safe Haven |
|
chronic_7 |
Approximate Date Started (if chronic_6 = Yes) |
|
chronic_2 |
Number of times on the streets, in ES, or Safe Haven in the past three years (if chronic_6 = Yes) |
|
chronic_3 |
Total Months Homeless in the Past Three years (if chronic_6 = Yes, chronic_2 = 1,2,3,4 or more) |
|
disabled |
Disabling Condition |
|
health_phys_disability |
Physical Disability |
|
health_phys_disability_services |
Receiving Services for Physical Disability |
|
health_phys_disability_longterm |
Long Term Physical Disability |
|
health_phys_disability_documented |
Physical Disability Documented |
|
health_dev_disability |
Developmental Disability |
|
health_dev_disability_services |
Receiving Services for Developmental Disability |
|
health_dev_disability_independence |
Developmental Disability Substantially Impairs Independence |
|
health_dev_disability_documented |
Developmental Disability Documented |
|
health_chronic |
Chronic Health Condition |
|
health_chronic_services |
Receiving Services for Chronic Health Condition |
|
health_chronic_longterm |
Long Term Chronic Health Condition |
|
health_chronic_documented |
Chronic Health Condition Documented |
|
health_hiv |
HIV/AIDS |
|
health_hiv_services |
Receiving Services for HIV/AIDS |
|
health_hiv_independence |
HIV/AIDS Substantially Impairs Independence |
|
health_hiv_documented |
HIV/AIDS Documented |
|
health_mental |
Mental Health Problem |
|
health_mental_services |
Receiving Services for Mental Health Problem |
|
health_mental_longterm |
Long Term Mental Health Problem |
|
health_mental_documented |
Mental Health Problem Documented |
|
health_substance_abuse |
Substance Abuse |
|
health_substance_abuse_services |
Substance Abuse - Receiving Treatment |
|
health_substance_abuse_longterm |
Long Term Substance Abuse Problem |
|
health_substance_abuse_documented |
Substance Abuse - Documented |
|
health_dv |
Victim of Domestic Violence |
|
health_dv_occurred |
Last Occurrence of Domestic Violence |
|
income_cash_is |
Client has Cash Income |
|
income_earned_is |
Earned Income |
|
income_earned |
Earned Income Amount |
|
income_unemployment_is |
Unemployment Income |
|
income_unemployment |
Unemployment Income Amount |
|
income_ssi_is |
Supplemental Security Income (SSI) |
|
income_ssi |
Supplemental Security Income (SSI) Amount |
|
income_ssdi_is |
Social Security Disability Income (SSDI) |
|
income_ssdi |
Social Security Disability Income (SSDI) Amount |
|
income_vet_disability_is |
VA Service-Connected Disability Compensation |
|
income_vet_disability |
VA Service-Connected Disability Compensation Amount |
|
income_private_disability_is |
Private Disability Insurance |
|
income_private_disability |
Private Disability Insurance Amount |
|
income_workers_comp_is |
Worker's Compensation |
|
income_workers_comp |
Worker's Compensation Amount |
|
income_tanf_is |
TANF (Temp Asst for Needy Fam) |
|
income_tanf |
TANF (Temp Asst for Needy Fam) Amount |
|
income_ga_is |
General Assistance (GA) |
|
income_ga |
General Assistance (GA) Amount |
|
income_spousal_support_is |
Spousal Support |
|
income_spousal_support |
Spousal Support Amount |
|
income_childsupport_is |
Child Support |
|
income_childsupport |
Child Support Amount |
|
income_ss_retirement_is |
Social Security Retirement |
|
income_ss_retirement |
Social Security Retirement Amount |
|
income_vet_pension_is |
VA Non-Service Connected Disability Pension |
|
income_vet_pension |
VA Non-Service Connected Disability Pension Amount |
|
income_private_pension_is |
Employment Pension |
|
income_private_pension |
Employment Pension Amount |
|
income_other_is |
Other Cash Income |
|
income_other |
Other Cash Income Amount |
|
income_other_source |
Other Cash Income Source |
|
income_individual |
Total Cash Income for Individual |
|
benefits_noncash |
Receiving Non-Cash Benefits |
|
benefit_snap |
SNAP |
|
benefits_wic |
WIC |
|
benefits_tanf_childcare |
TANF Childcare |
|
benefits_tanf_transportation |
TANF Transportation |
|
benefits_tanf_other |
Other TANF Benefit |
|
benefits_section8 |
Section 8 |
|
benefits_temp_rent |
Temporary Rental Assistance |
|
benefits_other |
Other Non-Cash Benefit |
|
benefits_other_source |
Other Non-Cash Benefit Source |
|
health_insurance |
Covered by Health Insurance |
|
benefits_medicaid |
MEDICAID |
|
benefits_medicare |
MEDICARE |
|
benefits_schip |
SCHIP |
|
benefits_va_medical |
VA Medical |
|
health_ins_emp |
Employer Provided Health Insurance |
|
health_ins_cobra |
Health Insurance obtained through COBRA |
|
health_ins_ppay |
Private Pay Health Insurance |
|
health_ins_state |
State Health Insurance for Adults |
|
exit_destination |
Destination (Exit) |
|
exit_destination_other |
Other Exit Destination (Exit) |
|
housing_ass_exit |
Housing Assessment at Exit |
|
housing_ass_exit_1 |
Housing Assessment at Exit - Subsidy A (Exit) |
|
housing_ass_exit_2 |
Housing Assessment at Exit - Subsidy B (Exit) |
|
rhy_bcp_is |
BCP Status Determined |
|
rhy_completion_involuntary_reason |
Project Completion - Major Reason (Involuntary) |
|
rhy_completion_status |
Project Completion Status |
|
rhy_completion_voluntary_reason |
Project Completion - Major Reason (Voluntary) |
|
rhy_crit_abuse_family |
Young Person's Critical Issues - Abuse and Neglect - Family Member |
|
rhy_crit_abuse_youth |
Young Person's Critical Issues - Abuse and Neglect - Youth |
|
rhy_crit_disability_mental_family |
Young Person's Critical Issues - Mental Disability - Family Member |
|
rhy_crit_disability_mental_youth |
Young Person's Critical Issues - Mental Disability - Youth |
|
rhy_crit_disability_physical_family |
Young Person's Critical Issues - Physical Disability - Family Member |
|
rhy_crit_disability_physical_youth |
Young Person's Critical Issues - Physical Disability - Youth |
|
rhy_crit_health_family |
Young Person's Critical Issues - Health Issues - Family Member |
|
rhy_crit_health_youth |
Young Person's Critical Issues - Health Issues - Youth |
|
rhy_crit_household |
Young Person's Critical Issues - Household Dynamics |
|
rhy_crit_housing_family |
Young Person's Critical Issues - Housing Issues - Family Member |
|
rhy_crit_housing_youth |
Young Person's Critical Issues - Housing Issues - Youth |
|
rhy_crit_identity_family |
Young Person's Critical Issues - Sexual Orientation/Gender Identity - Family Member |
|
rhy_crit_identity_youth |
Young Person's Critical Issues - Sexual Orientation/Gender Identity - Youth |
|
rhy_crit_incarcerated_parent |
Young Person's Critical Issues - Incarcerated Parent of Youth |
|
rhy_crit_incarcerated_specify |
Young Person's Critical Issues - Parent Incarcerated - Specification |
|
rhy_crit_income_family |
Young Person's Critical Issues - Insufficient Income to Support Youth - Family Member |
|
rhy_crit_mental_family |
Young Person's Critical Issues - Mental Health Issues - Family Member |
|
rhy_crit_mental_youth |
Young Person's Critical Issues - Mental Health Issues - Youth |
|
rhy_crit_military_family |
Young Person's Critical Issues - Active Military Parent - Family Member |
|
rhy_crit_school_family |
Young Person's Critical Issues - School or Educational Issues - Family Member |
|
rhy_crit_school_youth |
Young Person's Critical Issues - School or Educational Issues - Youth |
|
rhy_crit_substance_family |
Young Person's Critical Issues - Alcohol or Other Drug Abuse - Family Member |
|
rhy_crit_substance_youth |
Young Person's Critical Issues - Alcohol or Other Drug Abuse - Youth |
|
rhy_crit_unemployment_family |
Young Person's Critical Issues - Unemployment - Family Member |
|
rhy_crit_unemployment_youth |
Young Person's Critical Issues - Unemployment - Youth |
|
rhy_dental_health |
Dental Health Status |
|
rhy_education_level |
Last Grade Completed |
|
rhy_employment_type |
Employment Status - Type of Employment |
|
rhy_exploitation |
Commercial Sexual Exploitation - Received Something in Exchange for Sex in the Past 3 Months |
|
rhy_exploitation_ask |
Commercial Sexual Exploitation - Did Someone Ask/Make You Have Sex? |
|
rhy_exploitation_ask_times |
Commercial Sexual Exploitation - If persuaded sex - In the last 3 months? |
|
rhy_exploitation_frequency |
Commercial Sexual Exploitation - If exchanged for sex - How many times |
|
rhy_exploitation_times |
Commercial Sexual Exploitation - If exchange for sex - In the last three months |
| rhy_family_reunification |
Family Reunification Achieved |
|
rhy_former_justice |
Formerly a Ward of the Juvenile Justice System |
|
rhy_foster_length_months |
Formerly a Ward of Child Welfare or Foster Care Agency - Number of Months |
|
rhy_foster_length_years |
Formerly a Ward of Child Welfare or Foster Care Agency - Number of Years |
|
rhy_fysb_youth |
RHY BCP Status - FYSB Youth |
|
rhy_justice_length_months |
Formerly a Ward of the Juvenile Justice System - Number of Months |
|
rhy_justice_length_years |
Formerly a Ward of the Juvenile Justice System - Number of Years |
|
rhy_labor_exploitation_forced_tricked |
Commercial Labor Exploitation - Forced or Tricked into Continuing Job |
|
rhy_labor_exploitation_payment |
Commercial Labor Exploitation - Work or Payment Different |
|
rhy_labor_exploitation_threats |
Commercial Labor Exploitation - Afraid to Leave Due to Threats of Violence |
|
rhy_labor_exploitation_times |
Commercial Labor Exploitation - In the Last 3 Months |
|
rhy_mental_health |
Mental Health Status |
|
rhy_no_svc_reason |
RHY BCP Status - Reason for Not Providing Services |
|
rhy_reason_not_employed |
Employment Status - Why Not Employed |
|
rhy_referral_freq_approached |
Referral Source - Number of Times Approached by Outreach Prior to Entering Project |
|
rhy_referral_src |
RHY Referral Source |
|
rhy_school_status |
School Status |
|
rhy_sexual_orientation |
Sexual Orientation |
|
rhy_sexual_orientation_other |
Sexual Orientation, Other |
|
rhy_status_determination |
RHY BCP Status - Date of Status Determination |
|
rhy_transition_advice |
Advice About and/or Referral to Appropriate Mainstream Assistance Programs |
|
rhy_transition_counseling |
Exit Counseling |
|
rhy_transition_meeting |
Follow-Up Meeting or Contacts Has Been Scheduled |
|
rhy_transition_other |
Transitional, Exit-Care, or Aftercare Plans and Actions - Other |
|
rhy_transition_package |
Package of Maps, Information About Local Shelters and Resources |
|
rhy_transition_permanent |
Placement in Appropriate, Permanent, Stable Housing (Not a Shelter) |
|
rhy_transition_plan |
Written Transitional, Aftercare or Follow-Up Plan or Agreement |
|
rhy_transition_shelter |
Youth Must Be Transported or Accompanied to a Temporary Shelter |
|
rhy_transition_treatment |
A Course of Further Follow-Up Treatment or Services |
|
rhy_dest_safe_client |
Exit destination safe – as determined by the client |
|
rhy_dest_safe_caseworker |
Exit destination safe – as determined by the project/caseworker |
| rhy_adult_connect | Client has permanent positive adult connections outside of project |
| rhy_peer_connect | Client has permanent positive peer connections outside of project |
|
rhy_community_connect |
Client has permanent positive community connections outside of project |
|
runaway_youth |
Runaway Youth |
|
employment_is |
Employed |
| employment_hours | Employment Hours |
| employment_seeking | Employment Seeking |
| employment_tenure | Employment Tenure |
|
hopwa_cobra_reason |
No Health Insurance obtained through COBRA - Reason |
|
hopwa_emp_reason |
No Employer Provided Health Insurance - Reason |
|
hopwa_hiv_adap |
HOPWA - Receiving AIDS Drug Assistance Program (ADAP) |
|
hopwa_hiv_adap_reason |
Reason |
|
hopwa_hiv_services |
Receiving Services for HIV - AIDS |
|
hopwa_hiv_services_reason |
Reason |
|
hopwa_medicaid_reason |
No Medicaid - Reason |
|
hopwa_medicare_reason |
No Medicare - Reason |
|
hopwa_ppay_reason |
No Private Pay Health Insurance - Reason |
|
hopwa_schip_reason |
No SCHIP - Reason |
|
hopwa_state_reason |
No State Health Insurance for Adults - Reason |
|
hopwa_va_medical_reason |
No VA Medical - Reason |
|
soar_connected |
Connection with SOAR |
|
ssvf_targeting_field_1 |
Referred by Coordinated Entry or a Homeless Assistance Provider to Prevent the Household From Entering an Emergency Shelter or Transitional Housing or From Staying in a Place Not Meant for Human Habitation. |
|
ssvf_targeting_field_10 |
Head of Household with Disabling Condition (Physical Health, Mental Health, Substance Use) That Directly Affects Ability to Secure/Maintain Housing |
|
ssvf_targeting_field_11 |
Criminal Record for Arson, Drug Dealing or Manufacture, or Felony Offense Against Persons or Property |
|
ssvf_targeting_field_12 |
Registered Sex Offender |
|
ssvf_targeting_field_13 |
At Least One Dependent Child Under Age 6 |
|
ssvf_targeting_field_14 |
Single Parent With Minor Child(ren) |
|
ssvf_targeting_field_15 |
Household Size of 5 or More Requiring At Least 3 Bedrooms (Due to Age/Gender Mix) |
|
ssvf_targeting_field_16 |
Any Veteran in Household Served in Iraq or Afghanistan |
|
ssvf_targeting_field_17 |
Female Veteran |
|
ssvf_targeting_field_2 |
Current Housing Loss Expected Within: |
|
ssvf_targeting_field_20 |
HP Applicant Total Points (integer) |
|
ssvf_targeting_field_21 |
Grantee Targeting Threshold Score (integer) |
|
ssvf_targeting_field_3 |
Current Household Income is $0 |
|
ssvf_targeting_field_4 |
Annual Household Gross Income Amount |
|
ssvf_targeting_field_5 |
Sudden and Significant Decrease in Cash Income (Employment and/or Cash Benefits) AND/OR Unavoidable Increase in Non-Discretionary Expenses (e.g., Rent or Medical Expenses) in the Past 6 Months |
|
ssvf_targeting_field_6 |
Major Change in Household Composition (e.g., Death of Family Member, Separation/Divorce from Adult Partner, Birth of New Child) in the Past 12 Months |
|
ssvf_targeting_field_7 |
Rental Evictions Within the Past 7 Years |
|
ssvf_targeting_field_8 |
Currently at Risk of Losing a Tenant-Based Housing Subsidy or Housing in a Subsidized Building or Unit |
|
ssvf_targeting_field_9 |
History of Literal Homelessness (Street/Shelter/Transitional Housing) |
|
tcell_count_available |
T-cell (CD4) Count Available |
|
tcell_count_number |
If yes: T-cell Count |
|
tcell_data_obtained |
How was the data obtained |
|
vamc_station_number |
VAMC Station Number |
|
viral_load_available |
Viral Load Available |
|
viral_load_number |
If yes: Viral Load |
|
viral_load_obtained |
How was the data obtained |
|
path_engagement |
Client Engagement |
|
path_engagement_date |
Date of Engagement |
|
path_not_enrolled_reason |
Reason Not Enrolled |
|
path_status |
PATH Enrollment Status |
|
path_status_determination |
PATH Status - Date of Determination |
|
path_status_is |
PATH Status Determination Completed |
|
th_ph_less_than_7_nights |
Length of Stay Less Than 7 Nights |
|
institutional_90_days |
Length of Stay Less Than 90 Days |
|
client_location |
Client Location |
|
other_health_insurance |
Other Health Insurance |
|
other_health_insurance_specify |
Other Health Insurance Source |
|
health_general |
General Health |
| education_degree | Education Degree |
| education_enrolled | Education Enrolled |
| education_level | Education Level |
|
health_dv_fleeing |
Are you currently fleeing? |
|
health_pregnancy |
Pregnancy Status |
|
health_pregnancy_date |
Pregnancy Due Date |
|
previous_foster_care |
Formerly a Ward of Child Welfare or Foster Care Agency |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user_updated |
FK - clarity_users.id - User updating |
|
deleted |
Deleted Data |
|
zipcode |
Zip Code |
|
ref_user |
FK - clarity_users.id - User Creating |
|
exit_reason |
Exit Reason |
|
drivers_license |
Drivers License |
|
chronic_1 |
Continually Homeless for at Least One Year |
|
client_hoh_or_adult |
Is the Client and Adult of Head of Household |
|
program_type_es_sh_or_so |
Is the Program Type Either ES, SH or Street Outreach |
|
program_type_es_nbn_so |
Is the Program Type Either Street Outreach or Night-by-night Emergency Shelter |
|
housing_assessment_disposition |
Housing assessment disposition |
|
assessment_disposition_other |
Housing assessment disposition other text field |
|
current_living_situation |
Current Living Situation |
|
continuum_project_list |
Continuum Project List |
|
living_situation_14_days |
Living Situation 14 Days |
|
subsequent_residence |
Subsequent Residence |
|
resource_networks_ph |
Resource Networks - Permanent Housing |
|
ph_60_days |
Permanent Housing - 60 days |
|
moved_60_days |
Moved 60 days |
|
location_details |
Location Details |
|
ami_percent |
AMI Percent |
|
is_autoexited |
Is Autoexited |
Table: clarity_client_program_staff
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_program |
FK - clarity_client_programs.id |
|
ref_user |
FK - clarity_users.id |
|
private |
Private |
Table: clarity_client_programs_files
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_program |
FK - clarity_client_programs.id |
|
ref_client_file |
FK - clarity_client_files.id |
Table: clarity_client_services
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_agency |
FK - clarity_agencies.id |
|
ref_service_item |
FK - clarity_service_items.id |
|
safe_alternative_housing |
Safe Alternative Housing |
|
aftercare_project |
Aftercare project |
|
result_date |
Result Date |
|
start_date |
Start Date |
|
end_date |
End Date |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_users.id - User Creating |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
|
deleted |
Deleted |
|
ref_geolocation |
FK - clarity_geolocation.id |
Table: clarity_client_service_accounts
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_service |
FK clarity_client_service.id |
|
ref_account |
FK - clarity_vendors.id |
Table: clarity_client_service_dates
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_service |
FK - clarity_client_services.id |
|
date |
Date |
|
time |
Time (if applicable) |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_users.id - User Creating |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
Table: clarity_client_service_expenses
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_service |
FK - clarity_client_services.id |
|
ref_funding |
FK clarity_program_funding.id |
|
date |
Date |
|
amount |
Amount of Expense |
|
check_number |
Check Number |
|
vendor |
Vendor Name |
|
notes |
Expense Notes |
|
ref_date |
FK - Date.id |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user_updated |
FK - clarity_users.id |
Table: clarity_client_service_notes
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_service |
FK - clarity_client_services.id |
|
ref_service_item |
FK - clarity_service_items.id |
|
notes |
Notes |
Table: clarity_client_service_programs
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_service |
FK - clarity_client_services.id |
|
ref_client_program |
FK - clarity_client_programs.id |
|
ref_agency |
FK - clarity_agencies.id |
Table: clarity_client_service_time_tracking
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client_service |
FK - clarity_client_services.id |
|
tracking_minute |
Minutes Spent |
|
ref_date |
Deprecated field |
|
added_date |
Date Added |
|
last_updated |
Date Last Updated |
|
ref_user_updated |
FK - clarity_users.id |
Table: clarity_common_eligibility_requirements
| Clarity Field | Description |
| id | Primary Key |
| ref_source | FK - |
| ref_requirement | FK - eligibility_requirements.id |
| ref_field | FK - fields.id |
| value | Value |
| condition | Condition |
| operation | Operation |
| source | Source |
| sort | Sort |
| ref_income_type | FK - income_types.id |
| pre_bracket | Pre-bracket |
| post_bracket | Post-Bracket |
| ref_assessment_processor | FK - assessment_processors.id |
Table: clarity_delivery_types
| Clarity Field | Description |
| id | Primary Key |
| name | Name of the delivery type |
| is_attendance | Is it an attendance delivery type |
Table: clarity_eligibility_requirements
| Clarity Field | Description |
| id | Primary Key |
| ref_client_service | FK - clarity_client_services.id |
| name | Name of the eligibility requirement |
Table: clarity_encampments
| Clarity Field | Description |
| id | Primary Key |
| ref_agency | FK - agencies.id |
| ref_user | FK - users.id |
| ref_user_updated | FK - users.id |
| name | Name Notes |
| notes | |
| active | Active |
| added_date | Date Added |
| last_updated | Date Last Updated |
| deleted | Deleted |
| ref_agency_deleted | FK - agencies.id |
| custom_data | Custom Data |
| polygon | Polygon |
| polygon_center | Polygon Center |
Table: clarity_encampments_history
| Clarity Field | Description |
| id | Primary Key |
| ref_encampment | FK - encampments.id |
| ref_agency | FK - agencies.id |
| ref_user | FK - users.id |
| ref_user_updated | FK - users.id |
| name | Name |
| notes | Notes |
| active | Active |
| custom_data | Custom Data |
| polygon | Polygon |
| polygon_center | Polygon Center |
| added_date | Date Added |
Table: clarity_fields
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
table_type |
Table Type for the field: System, Core, Custom, Live Markers |
|
name |
Field Name |
|
display_name |
Display Name: Default screen display |
|
ref_field_type |
FK - field_types.id - Picklist, number, text, etc. |
|
comments |
Comments |
|
ref_user |
FK - clarity_users.id - User Creating |
|
last_update |
Last Update |
|
tooltip |
Tooltip text |
|
is_locked |
Locked: can the field be edited |
|
type |
Type of field |
|
core_type |
Core Type - is this a core, system or custom field |
|
ref_picklist_type |
FK - picklist.id |
|
publish_to_looker |
Publish to Data Analysis |
Table: clarity_field_types
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
name |
Name |
|
type |
Type |
|
f_type |
F Type |
|
maxlength |
Maximum length |
Table: clarity_files
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| filename | Name of the file |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
| ref_user | FK - clarity_users.id - User creating |
|
ref_user_updated |
FK - clarity_users.id - User updating |
Table: clarity_funding
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_funding |
FK clarity_program_funding.id |
|
ref_agency |
FK - clarity_agencies.id |
|
name |
Fund Name |
|
amount |
Fund Amount |
|
status |
Fund Status |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user_updated |
FK - clarity_users.id - User updating |
Table: clarity_funding_source
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_funding_source |
|
|
ref_agency |
FK - clarity_agencies.id |
|
name |
Name |
|
amount |
Fund Amount |
|
status |
Fund Status |
|
funding_source |
Federal Partner Fund Source |
|
funding_source_non-federal |
Non-Federal Funding Source |
|
ref_agency_assigned |
FK - clarity_agencies.id |
|
grant_identifier |
Grant Identifier |
|
start_date |
Start Date of Grant |
|
end_date |
End Date of Grant |
|
direct |
Direct |
|
eligibility |
Eligibility |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_user.id - User adding |
|
ref_user_updated |
FK - clarity_users.id - User updating |
Table: clarity_funding_source_data
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_funding_source |
|
|
custom_data |
Custom Data |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_user.id - User adding |
|
ref_user_updated |
FK - clarity_users.id - User updating |
Table: clarity_geolocations
| Clarity Field | Description |
| id | Primary Key |
| gis_point | GIS Point |
| type | Type |
| source_table_name | Source Table Name |
| source_table_id | Source Table ID |
| address | Address |
| address2 | Address 2 |
| city | City |
| state | State |
| zipcode | Zipcode |
| zipcode2 | Zipcode 2 |
| geocode | Geocode |
| added_date | Date Added |
| last_updated | Date Last Updated |
| deleted | Deleted |
| custom_data | Custom Data |
| ref_agency_deleted | FK - agencies.id |
Table: clarity_geolocation_actuality_dates
| Clarity Field | Description |
| id | Primary Key |
| ref_geolocation | FK - geolocations.id |
| actual_on_date | Actual on date |
Table: clarity_geolocation_mapping
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| type | Type |
| address_type | Address Type |
| field_id | Field ID |
| client_id | Client ID |
| client_data_id | Client Data ID |
| field_interaction_id | Field Interaction ID |
| client_service_id | Client Service ID |
| client_program_demographic_id | Client Program Demographic ID |
| service_item_id | Service Item ID |
| site_id | Site ID |
| agency_id | Agency ID |
| taxonomy_id | Taxonomy ID |
| is_profile_location | Is Profile Location |
| date | Date |
| ref_geolocation | FK - clarity_geolocation.id |
| client_assessment_id | Client Assessment ID |
Table: clarity_household
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
added_date |
Date Added |
|
last_updated |
Date last updated |
|
ref_user_updated |
FK - clarity_users.id - User updating |
Table: clarity_import_client_groups
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_enrollment |
FK - clarity_client_program_demographics.id |
|
external_enrollment_id |
External Enrollment ID |
|
external_client_group_id |
External Group ID |
|
external_relationship_to_hoh |
External Relationship to HoH |
|
ref_client |
FK - clarity_clients.id |
|
ref_source |
FK - |
|
ref_file |
FK - files.id |
|
import_id |
Import ID |
|
enrollment_start_date |
Enrollment Start Date |
Table: clarity_import_client_group_map
|
Clarity Field |
Description |
|---|---|
| id | Primary Key |
|
ref_file |
FK - files.id |
Table: clarity_import_client_map
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
external_id |
External ID |
|
ref_source |
FK - |
|
import_id |
Import ID |
|
ref_file |
FK - files.id |
Table: clarity_import_enrollment_map
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_source |
FK - |
|
external_id |
External ID |
|
import_id |
Import ID |
|
ref_file |
FK - files.id |
|
ref_enrollment |
FK - clarity_client_programs.id |
Table: clarity_import_files
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_user |
FK - clarity_user.id - User adding |
|
ref_user_updated |
FK - clarity_user.id - User adding |
|
added_date |
Date Added |
|
last_updated |
Date Last Updated |
|
is_imported |
Is Imported |
|
import_date |
Date Imported |
|
valid |
Valid |
|
validation_date |
Date Validated |
|
errors_count |
Errors Count |
|
ref_source |
FK - |
|
ref_type |
FK - picklist - Import Files |
|
ref_standard |
FK - |
|
ref_agency |
FK - clarity_agencies.id |
|
ref_state |
FK - |
Table: clarity_import_household_map
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_household | FK clarity_households |
|
ref_source |
FK - |
|
external_id |
External ID |
|
import_id |
Import ID |
|
ref_file |
FK - files.id |
Table: clarity_import_program_map
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_program | FK - programs.id |
|
ref_source |
FK - |
|
external_id |
External ID |
|
import_id |
Import ID |
|
ref_file |
FK - files.id |
Table: clarity_members
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_user |
FK - clarity_users.id - User creating |
|
ref_agency |
FK - clarity_agencies.id |
|
first_name |
First Name |
|
last_name |
Last Name |
Table: clarity_messages
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| parent_id | Parent ID |
| sender_id | Sender ID |
| receiver_id | Receiver ID |
| body | Body message |
| is_read | Was message read |
| deleted_by | User deleting the message |
| created_at | Created At |
Table: clarity_outreach_encampment_geolocations_history
| Clarity Field | Description |
| id | Primary Key |
| ref_encampment_history | FK - encampment_history.id |
| ref_geolocation | FK - geolocations.id |
Table: clarity_outreach_encampment_geolocations_map
| Clarity Field | Description |
| id | Primary Key |
| ref_encampment | FK - encampments.id |
| ref_geolocation | FK - geolocations.id |
Table: clarity_outreach_location_filter_criteria
| Clarity Field | Description |
| id | Primary Key |
| ref_location_filter | FK - location_filters.id |
| type | Type |
| ref_field | FK - fields.id |
| ref_address_type | FK - address_types.id |
| ref_taxonomy | FK - taxonomies.id |
| field_interaction | Field Interaction |
| filtration_by_date_is_enabled | Filtration by date is enabled |
| ref_outreach_location_filter_dates | FK - outreach_location_filter_dates.id |
| ref_user | FK - users.id |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user_updated | FK - users.id |
Table: clarity_outreach_location_filter_dates
| Clarity Field | Description |
| id | Primary Key |
| items_counter | Items counter |
| type | Date type |
| added_date | Date added |
| last_updated | Date last updated |
| ref_user | FK: users.id |
| ref_user_updated | FK: users.id |
Table: clarity_outreach_location_filters
| Clarity Field | Description |
| id | Primary Key |
| ref_outreach_setting | FK - outreach_settings.id |
| type | Type |
| ref_user | FK - users.id |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user_updated | FK - users.id |
Table: clarity_outreach_locations_metadata
| Clarity Field | Description |
| id | Primary Key |
| ref_geolocation | FK - geolocation.id |
| ref_setting | FK - setting.id |
| ref_outreach_location_filter | FK - outreach_location_filters.id |
| setting_type | Setting type |
| interval | Interval |
| interval_type | Interval type |
Table: clarity_outreach_settings
| Clarity Field | Description |
| id | Primary Key |
| coc | CoC |
| ref_user | FK - users.id |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user_updated | FK - users.id |
| ref_screen | FK - screens.id |
| must_be_published | Must be published |
| limit_suggestions | Limit suggestions |
Table: clarity_picklist
| Clarity Field | Description |
| id | Primary Key |
| ref_field | FK clarity_fields.id |
| field_name | Field Name |
| value_name | Value Name |
| code | Code |
| sort | Sort |
| readonly | Read Only |
| hidden | Hidden |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user_updated | FK - users.id |
Table: clarity_programs
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_agency |
FK - clarity_agencies.id |
|
name |
Program Name |
|
status |
Active |
| ref_template | FK - program_templates.id |
|
availability_start |
Availability Start Date |
|
availability_end |
Availability End Date |
| cross_agency | Cross Agency Services |
|
ref_category |
FK - picklist project type code |
|
program_applicability |
Program Applicability, legacy field |
|
description |
Description |
| ref_housing_type | FK - picklist housing_type |
|
ref_site_type |
Site Type, retired HUD field |
|
ref_target_b |
Target Population |
| victim_service_provider | Victim Service Provider |
| geocode | Geocode |
|
tracking_method |
Method of Tracking |
| hmis_participating _project | HMIS Participating Project |
| allow_goals | Allow Goals |
| allow_autoservice_placement | Allow Auto-service Placement |
| all_client_forms_enabled | All Client Forms Enabled |
| eligibility_enabled |
Eligibility Enabled |
| public_listing | Public Listing |
| allow_history_link | Allow History Link |
| enable_assessments | Enable Assessments |
| enable_notes | Enable Notes |
| enable_files | Enable Files |
| enable_charts | Enable Charts |
| enable_autoexit | Enable Autoexit |
| autoexit_duration | Autoexit Duration |
| funding_source | Funding Source |
| aff_res_proj | Affiliated Residential Project |
| aff_res_proj_ids | Affiliated Residential Project ID |
| enable_cascade | Enable Cascade |
| cascade_threshold | Cascade Threshold |
| close_services | Close Services at Exit |
| continuum_project | Continuum Project |
| availability | Type of availability, legacy field |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
| deleted | Deleted Data |
|
ref_agency_deleted |
FK - clarity_agencies.id - Agency deleting record |
Table: clarity_program_coc
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_program |
FK - clarity_programs.id |
| coc | Continuum of Care |
| deleted | Deleted |
|
added_date |
Added Date |
| last_updated | Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
|
ref_agency_deleted |
FK - clarity_agencies.id - Agency deleting record |
Table: clarity_program_data
| Clarity Field | Description |
| id | Primary Key |
| ref_program | FK - programs.id |
| custom_data | Custom Data Fields |
| added_date | Date Added |
| ref_user | FK - clarity_users.id - User Creating |
| last_updated | Date last updated |
| ref_user_updated | FK - clarity_users.id - User Updating |
Table: clarity_program_eligibility_requirements
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_program |
FK - programs.id |
|
ref_requirement |
FK - eligibility_requirements.id |
|
ref_field |
FK clarity_fields.id |
|
value |
Value |
|
condition |
Condition |
|
operation |
Operation |
|
sort |
Sort |
|
ref_income_type |
FK - income_types.id |
|
pre_bracket |
Pre Bracket |
|
post_bracket |
Post Bracket |
|
ref_assessment_processor |
FK - assessment_processors.id |
Table: clarity_program_funding_sources
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_program |
FK - clarity_programs.id |
|
identifier |
Grant Identifier |
|
start_date |
Start Date |
|
end_date |
End Date |
|
funding_source |
Funding Source |
| funding_source_non_federal | Non Federal Funding Source |
| amount | Amount |
| added_date | Added Date |
| last_updated | Updated Date |
|
ref_user |
FK - clarity_users.id - User Creating |
|
ref_user_updated |
FK - clarity_users.id - User Updating |
Table: clarity_program_inventory
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_program | FK - clarity_programs.id |
| information_date | Information Date |
| coc | Continuum of Care |
| ref_household_type | FK - picklist Household Type |
| availability | Availability |
| ref_bed_type | FK - picklist Bed Type |
| bed_inventory | Bed Inventory |
| is_veteran | Is Veteran? |
| veteran_inventory | Veteran Bed Inventory |
| is_bed_ch_veteran | Is bed Chronic Homeless Veteran |
| bed_ch_veteran | Chronic Homeless Veteran Beds |
| is_bed_ch_youth | Is bed Chronic Homeless Youth |
| bed_ch_youth | Chronic Homeless Youth Beds |
| is_bed_ch_other | Is bed Chronic Homeless Other |
| bed_ch_other | Chronic Homeless Other Beds |
| is_bed_youth_veteran | Is bed Youth Veteran |
| bed_youth_veteran | Youth Veteran Beds |
| is_bed_other_veteran | Is bed Veteran Other |
| bed_other_veteran | Veteran Other Beds |
| is_bed_other_youth | Is bed Youth Other |
| bed_other_youth | Youth Other Beds |
| is_bed_non_dedicated | Is bed Non Dedicated |
| bed_non_dedicated | Non Dedicated Beds |
| unit_inventory | Unit Inventory |
| start_date | Inventory Start Date |
| end_date | Inventory End Date |
| added_date | Date Added |
| last_updated | Date Updated |
|
ref_user_updated
|
FK - clarity_users.id |
| deleted | Deleted? |
|
ref_agency_deleted
|
FK - clarity_agencies.id - Agency deleting record |
Table: clarity_program_inventory_history
| Clarity Field |
Description |
|---|---|
| id | Primary Key |
|
ref_program_inventory |
FK - clarity_program_inventory.id |
|
information_date |
Information Date |
| coc | Continuum of Care |
| ref_household_type | FK - picklist Household Type |
| availability | Availability |
| ref_bed_type | FK - picklist Bed Type |
| bed_inventory | Bed Inventory |
| is_chronic | Is Chronically Homeless? |
| chronic_inventory | Chronically Homeless Bed Inventory |
| is_veteran | Is Veteran? |
| veteran_inventory | Veteran Bed Inventory |
| is_youth | Is Youth? |
| youth_inventory | Youth Bed Inventory |
| is_bed_ch_veteran | Is bed Chronic Homeless Veteran |
| bed_ch_veteran | Chronic Homeless Veteran Beds |
| is_bed_ch_youth | Is bed Chronic Homeless Youth |
| bed_ch_youth | Chronic Homeless Youth Beds |
| is_bed_ch_other | Is bed Chronic Homeless Other |
| bed_ch_other | Chronic Homeless Other Beds |
| is_bed_youth_veteran | Is bed Youth Veteran |
| bed_youth_veteran | Youth Veteran Beds |
| is_bed_other_veteran | Is bed Veteran Other |
| bed_other_veteran | Veteran Other Beds |
| is_bed_other_youth | Is bed Youth Other |
| bed_other_youth | Youth Other Beds |
| is_bed_non_dedicated | Is bed Non Dedicated |
| bed_non_dedicated | Non Dedicated Beds |
| unit_inventory | Unit Inventory |
| start_date | Inventory Start Date |
| end_date | Inventory End Date |
| is_hmis_participating | HMIS Participating |
| participating_beds | HMIS Participating Beds |
| added_date | Date Added |
| last_updated | Date Updated |
|
ref_user_updated
|
FK - clarity_users.id |
| deleted | Deleted? |
|
ref_agency_deleted
|
FK - clarity_agencies.id - Agency deleting record |
Table: clarity_program_openings
| Clarity Field | Description |
| id | Primary Key |
| ref_program | FK - clarity_programs.id |
| date | date |
| note | Note |
| status | Status |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user_updated | FK - clarity_users.id |
| deleted | Deleted? |
| ref_agency_deleted | FK - clarity_agencies.id - Agency deleting record |
| custom_data | Custom Data |
Table: clarity_program_services
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
| ref_program | FK - clarity_programs.id |
| ref_service | FK - clarity_services.id |
Table: clarity_program_sites
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_program |
FK - clarity_programs.id |
|
ref_site |
FK - sites.id |
|
is_primary |
Primary Site |
Table: clarity_program_templates
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
| name | Name |
| status | Status |
| enroll_screen | Enrollment Screen |
| case_screen | Status Update/Annual Assessment Screen |
| exit_screen | Exit Screen |
| followup_screen |
Follow-up Screen |
| auto_provision | Auto Provision |
| ref_case_status | FK |
Table: clarity_program_template_status_screens
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
| ref_program_template | FK - program_templates.id |
| ref_status_screen | FK |
Table: clarity_referrals
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_client |
FK - clarity_clients.id |
|
ref_program |
FK - clarity_programs.id |
| ref_agency | FK - clarity_agencies.id |
|
date |
Date of Referral |
| status | Status of Referral |
| denied_reason | Denied Reason |
| denied_message | Denied Custom Message |
| denied_by_type | Denied by Type |
| type | Referral Type |
| ref_assessment | FK - clarity_client_assessment_demographics.id |
| queue | Community Queue (Value of 1) |
| replaced_with | Referred to another Referral |
| added_date | Added Date |
| last_updated | Updated Date |
| ref_queue_removed_reason | picklist.field_value WHERE picklist.field_name = "queue_removed_reason" AND ref_queue_removed_reason = picklist.code |
| ref_user | FK - clarity_users.id - User Created |
| ref_queue_removed_subreason | picklist.field_value WHERE picklist.field_name = "queue_removed_subreason" AND ref_queue_removed_subreason = picklist.code |
| ref_user_updated | FK - clarity_users.id - User Updated |
| deleted | Deleted Data |
| private | Private |
| reassigned | Reassigned |
| ref_queue | FK - referral_community_queues.id |
| ref_agency | FK - agencies.id |
| ref_navigator | FK - navigators.id |
| ref_case_manager | FK - members.id |
| ref_opening | FK - program_openings.id |
| queue_removed_date | Queue Removed Date |
| snoozed | Snoozed |
| end_date | End Date |
| reassigned_date | Reassigned Date |
| in_process_date | In Process Date |
| expired_by_cron | Expired by Cron |
Table: clarity_referral_availability_fields
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_referral_setting | FK - referral_settings.id |
| name | Name |
| title | Title |
| ref_field_type | FK - field_types.id |
| publish_to_looker | Publish to Looker |
| ref_queue | FK - referral_community_queues.id |
| display_name | Display Name |
Table: clarity_referral_characteristics
| Clarity Field | Description |
|---|---|
| id | ID |
| ref_referral_setting | FK - referral_settings.id |
| name | Name |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user | FK - users.id |
| ref_user_updated | FK - users.id |
| ref_queue | FK - referral_community_queues.id |
Table: clarity_referral_characteristic_conditions
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_characteristic | FK - referral_characteristics.id |
| type | Type |
| ref_field | FK - fields.id |
| value | Value |
| condition | Condition |
| operation | Operation |
| pre_bracket | Pre-bracket |
| post_bracket | Post-bracket |
| sort | Sort |
Table: clarity_referral_characteristic_results
| Clarity Field | Description |
|---|---|
| id | ID |
| ref_referral | FK - referrals.id |
| ref_characteristic | FK - referral.characteristics.id |
| result | Result |
| calculated_at | Calculated At |
| to_research | To Research |
Table: clarity_referral_community_queues
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_referral_setting | FK - referral_settings.id |
| name | Name |
| default | Default |
| automated_removal | Automated Removal |
| allow_refer | Allow Refer |
| last_updated | Date Last Updated |
| ref_user_updated | FK - users.id |
| deleted | Deleted |
| ref_agency_deleted | FK - agencies.id |
Table: clarity_referral_community_queue_assessments
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_queue | FK - community_queues.id |
| ref_assessment | FK - assessments.id |
Table: clarity_referral_connections
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_referral | FK - clarity_referrals.id |
|
ref_client_program |
FK - clarity_client_programs.id |
Table: clarity_referral_dashboards
| Clarity Field | Description |
| id | Primary Key |
| ref_referral_setting | FK -referral_settings.id |
| ref_looker_report | FK - looker_report.id |
| is_primary | Is Primary |
Table: clarity_referral_denial_extension
| Clarity Field | Description |
| id | Primary Key |
| denial_reason | Denial Reason |
| extension | Extension |
| ref_referral_setting | FK - referral_settings.id |
| ref_queue | FK - referral_community_queues.id |
Table: clarity_referral_history
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_referral | FK - clarity_referrals.id |
| ref_program | FK - clarity_programs.id |
| date | Date |
| ref_user | FK - clarity_users.id |
| ref_original | FK - clarity_referrals.id |
| activity_type | Activity Type |
| details | Details |
| ref_user_agency | FK - agencies.id |
| added_date | Date Added |
| ref_navigator | FK - navigator.id |
Table: clarity_referral_notes
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_referral | FK - clarity_referrals.id |
| added_date | Date Added |
| last_updated | Date Last Updated |
| ref_user | FK - clarity_users.id |
| ref_user_updated | FK - clarity_users.id |
| ref_message | FK - clarity_messages.id |
| deleted | Deleted |
| ref_agency_deleted | FK - clarity_agencies.id - Agency deleting record |
| ref_agency | FK - clarity_agencies.id - Agency creating record |
| ref_user_home_agency | FK - clarity_agencies.id - Home agency of the user creating the record |
Table: clarity_referral_notifications
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_referral | FK - referrals.id |
| ref_user | FK - users.id |
| date | Date |
Table: clarity_referral_opening_history
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_referral | referrals.id |
| note | Note |
| date | Date |
Table: clarity_referral_settings
| Clarity Field | Description |
|---|---|
| id | Primary Key |
| ref_coc | FK - cocs.id |
| ref_sharing_group | FK - sharing_groups.id |
| community_queue | Community Queue |
| multi_community_queue | Multi-Community Queue |
| community_threshold | Community Threshold |
| community_type | Community Type |
| community_inactive | Community Inactive |
| matching_process | Matching Process |
| agency_limit | Agency Limit |
| program_availability_management | Program Availability Management |
| enable_notification | Enable Notification |
| notification_frequency | Notification Frequency |
| notify_days_pending | Notify Days Pending |
| notify_days_process | Notify Days Process |
| availabiltity_fields_enabled | Availability Fields Enabled |
| contact_information_warning | Contact Information Warning |
| most_recent_assessment | Most Recent Assessment |
| community_queue_snooze | Community Queue Snooze |
| dashboards_enabled | Dashboards Enabled |
| ineligible_program | Ineligible Program |
| assessment_updated | Assessment Updated |
| display_send_community_queue | Display Send Community Queue |
Table: clarity_release_of_information
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
| ref_client |
FK - clarity_clients.id |
| ref_agency |
FK - clarity_agencies.id |
| start_date | Start Date of ROI |
| end_date | End Date of ROI |
| permission | Permission to Share |
| documentation | ROI Collection Method |
| location | Location ROI Signed |
| ref_file | FK - files.id |
| ref_user | FK - clarity_users.id - User Created |
| added_date | Date ROI Added |
| ref_user_updated | FK - clarity_users.id - User Updated |
| last_updated | Date of ROI Update |
| deleted | ROI Delete Status |
| ref_agency_deleted | FK - clarity_agencies.id - Agency deleting record |
Table: clarity_reservation
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_service_item |
FK - clarity_service_items.id |
|
ref_client |
FK - clarity_clients.id |
| slot_id | ID for specific slot |
| slot_num | User Assigned slot/bed number |
| date | Information Date |
|
status |
Status |
|
ref_user |
FK - clarity_users.id - User Creating |
|
last_updated |
Last Update |
|
ref_client_service_date |
FK - clarity_client_service_dates.id |
|
ref_user_check |
FK - clarity_users.id |
|
ref_client_program |
FK - clarity_client_programs.id |
|
added_date |
Date Added |
|
ref_user_updated |
FK - clarity_users.id - User Updated |
|
deleted |
Deleted |
| ref_agency_deleted | FK - clarity_agencies.id - Agency deleting record |
| ref_geolocation | FK - geolocations.id |
Table: clarity_reservation_slots
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_service_item |
FK - clarity_service_items.id |
| Number | User Assigned slot/bed number |
| Name | Name for the Slot/bed |
| ref_section | FK - clarity_reservation_slot_sections.id |
Table: clarity_reservation_slot_sections
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_service_item |
FK - clarity_service_items.id |
| Name | Name for the Section |
Table: clarity_screens
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
type |
Type |
|
name |
Name |
|
status |
Status |
|
status_screen_type |
Status Screen Type |
|
coordinated_entry |
Coordinated Entry |
|
ref_user |
FK - clarity_users.id - User Creating |
|
last_update |
Last Update |
|
ref_agency |
FK - clarity_agencies.id |
|
published |
Published |
|
publish_date |
Publish Date |
|
ref_processor |
FK - screen_assessment_processors.id |
|
external_id |
External ID |
|
eligibility_engine |
Eligibility Engine |
|
score_displayed |
Score Displayed |
|
alternate_text |
Alternate Text |
Table: clarity_screen_fields
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_screen |
FK - screens.id |
|
ref_field |
FK - fields.id |
|
display_name |
Display Name |
|
check |
Check |
|
type |
Type |
|
default_value |
Default Value |
|
sort |
Sort |
|
inline_with |
In Line With |
|
readonly |
Read Only |
|
size |
Size |
|
rows |
Rows |
|
width |
Width |
|
maxlength |
Maximum Length |
|
mandatory |
Mandatory |
|
edit_date |
Edit Date |
|
protected |
Protected |
|
external_id |
External ID |
|
hidden |
Hidden |
Table: clarity_screen_field_calculations
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_field |
FK - fields.id |
| ref_field_condition |
FK -clarity_screen_field_calculations.id |
| operation | Operation |
| constants | Constants |
|
external_id |
External ID |
Table: clarity_screen_field_constraints
|
Clarity Field
|
Description
|
|---|---|
| id | Primary Key |
|
ref_field |
FK clarity_fields.id |
| ref_field_condition | FK -clarity_screen_field_calculations.id |
| condition | Condition |
| value | Value |
| operation | Operation |
| ref_prev_field | FK - clarity_fields.id |
|
external_id |
External ID |
Table: clarity_services
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_agency |
FK - clarity_agencies.id |
|
name |
Service Name |
|
status |
Active |
|
ref_category |
picklist.field_value |
| ref_program_usage |
Lookup: 1 - Services Only |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
|
deleted |
Deleted Data |
Table: clarity_service_items
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_service |
FK - clarity_services.id |
|
name |
Service Item Name |
|
ref_delivery_type |
FK - delivery_types.id |
|
si_cat1 |
Service Item Category 1 |
| si_cat2 | Service Item Category 2 |
| si_cat3 | Service Item Category 3 |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
|
deleted |
Deleted Data |
|
geolocation_is_enabled |
Geolocation Is Enabled |
|
ref_geolocation |
FK - geolocations.id |
|
ref_funding |
FK - clarity_program_funding.id |
Table: clarity_service_item_account_configuration
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_service_item |
FK - clarity_service_items.id |
|
account_type |
Account Type |
|
required |
Required |
Table: clarity_service_items_housing
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_service_item |
FK - clarity_service_items.id |
|
ref_service_type |
Housing Service Type |
|
ref_household_type |
Household Type |
|
ref_bed_type |
Bed Type |
|
availability |
Availability |
|
inventory_type |
Inventory Type |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
|
deleted |
Deleted Data |
Table: clarity_service_item_taxonomy
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_service_item | FK - clarity_service_items.id |
|
ref_taxonomy |
FK - clarity_taxonomy.id |
Table: clarity_sharing_exceptions
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_sharing |
FK - clarity_sharing_group |
|
ref_agency |
FK - clarity_agencies.id |
|
clients |
Client Sharing Exception Setting |
|
services |
Services Sharing Exception Setting |
| messages | Messages Sharing Exception Setting |
| files | Files Sharing Exception Setting |
|
location |
Location Sharing Exception Setting |
|
ref_department |
FK - department.id |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
| ref_user_updated | FK - clarity_users.id - User Updating |
Table: clarity_sharing_group
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
name |
Name of the Sharing Group |
|
services |
Services Sharing Setting |
|
messages |
Messages Sharing Setting |
|
location |
Location Sharing Setting |
| files | Files Sharing Setting |
| clients | Clients Sharing Setting |
Table: clarity_sharing_group_agency
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_agency |
FK - clarity_agencies.id |
|
services |
Agency Services Sharing Setting |
|
messages |
Agency Messages Sharing Setting |
|
location |
Agency Location Sharing Setting |
| files | Agency Files Sharing Setting |
| clients | Agency Clients Sharing Setting |
| ref_sharing_group | FK - sharing_group.id |
| added_date | Date Added |
| last_updated | Date Updated |
| ref_user_updated | FK - clarity_users.id |
Table: clarity_sharing_group_options
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
Name |
Name |
Table: clarity_sites
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_agency | FK - clarity_agencies.id |
| name | Name |
| coc | Continuum of Care Code |
| status | Active |
| property_manager | Name of the property manager |
| phone | Phone |
| ref_geography_type | FK - geography_types.id |
| information_date | Information Date |
| added_date | Date Added |
| last_updated | Date Updated |
| ref_user_updated | FK - clarity_users.id |
| deleted | Deleted Data |
| ref_agency_deleted | FK - clarity_agencies.id - Agency deleting record |
| ref_geolocation | FK - geolocations.id |
Table: clarity_taxonomy
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_category |
FK - clarity_taxonomy_categories.id |
|
code |
Taxonomy Code |
| name | Taxonomy Name |
|
last_updated |
Date Updated |
|
ref_user |
FK - clarity_users.id |
Table: clarity_taxonomy_categories
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| name | Taxonomy Category Name |
| added_date | Date Added |
|
last_updated |
Date Updated |
|
ref_user |
FK - clarity_users.id - User creating |
| ref_user_updated | FK - clarity_users.id - User updating |
Table: clarity_users
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
| ref_user_group | FK - clarity_user_groups.id |
|
ref_user_status |
FK - user_statuses.id |
|
|
|
|
deleted |
Deleted Data |
|
ref_user_updated |
FK - clarity_users.id |
|
name |
Name |
Table: clarity_user_agencies
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_user |
FK - users.id |
|
ref_agency |
FK - agencies.id |
Table: clarity_user_groups
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
Name |
Name |
Table: clarity_user_statuses
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
name |
Name |
|
description |
Description |
Table: clarity_vendors
|
Clarity Field |
Description |
|---|---|
|
id |
Primary Key |
|
ref_agency |
FK - clarity_agencies.id |
|
ref_type |
FK - picklist vendor account |
|
status |
Vendor Status |
|
vendor_name |
Vendor Name |
|
contact_name |
Vendor Contact Name |
|
phone |
Vendor Phone Number |
|
|
Vendor Email Address |
|
taxpayer_id |
Taxpayer ID |
|
i9_verification_date |
I-9 Verification |
|
address1 |
Vendor Address Line 1 |
|
address2 |
Vendor Address Line 2 |
|
city |
City |
|
state |
State |
|
zip |
ZIP Code |
|
note |
Note |
|
added_date |
Added Date |
|
last_updated |
Updated Date |
|
ref_user |
FK - clarity_users.id |
|
ref_user_updated |
FK - clarity_users.id |
Functions
| Function Name | Example Use |
| fn_c_getPicklistValueName | SELECT fn_c_getPicklistValueName( 'program_categories', 13 ) |
| fn_c_getPicklistAllCodes | SELECT fn_c_getPicklistAllCodes('program_categories') |
| fn_c_getJsonValueName | select fn_c_getJsonValueName("race", race) |