Skip to main content
CLIF Logo

⚠️ This version is deprecated. Please use CLIF v2.0.0 for current implementations.

CLIF Data Dictionary 1.0.0

⚠️ DEPRECATED Legacy Version

The original CLIF specification that established the foundation for standardized critical care data formats. This version has been superseded by v2.0.0.

Below is the entity-relationship diagram (ERD) that provides an overview of the relational CLIF database structure. This version of CLIF is

Relational CLIF tables are organized into clinically relevant column categories - demographics, objective measures, respiratory support, orders, and inputs-outputs. Below are sample templates for each table in R-CLIF. Here you can find detailed descriptions of each table and their fields.

You can use our custom GPT- CLIF Assistant to learn more about CLIF.

Patient_encounters

ColumnTypeDescription
patient_idVARCHARID variable for each patient. Every patient assigned a unique identifier is presumed to be a distinct individual
encounter_idVARCHARID variable for each patient encounter (a given patient can have multiple encounters). Each encounter_id represents a unique hospitalization for a patient, capturing the entire duration of the hospital stay. This is the primary key for most other tables

Example:

patient_idencounter_id
11
12
13
510
611
612

Patient_demographics

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter
raceVARCHARDescription of patient’s race. Each site could have different strings in source dataBlack , White, American Indian or Alaska Native, Asian, Native Hawaiian or Other Pacific Islander, Unknown, Other
ethnicityVARCHARDescription of patient’s ethnicityHispanic, Non-Hispanic, Unknown
sexVARCHARPatient’s biological sexMale , Female, Unknown

Example:

encounter_idraceethnicitysex
1BlackNon-hispanicFemale
5BlackNon-hispanicMale
6WhiteNon-hispanicMale
32AsianNon-hispanicMale
43WhiteHispanicFemale
62OtherNon-hispanicFemale

Limited_identifiers

ColumnTypeDescription
encounter_idVARCHARID variable for each patient encounter. Each encounter_id represents a unique hospitalization for a patient, capturing the entire duration of the hospital stay
admission_dttmDATETIMEDate and time the patient is admitted (in the format %Y-%m-%d %H:%M:%S). Use this date to determine the start date and time of the patient hospitalization
discharge_dttmDATETIMEDate and time the patient is discharged (in the format %Y-%m-%d %H:%M:%S). Use this date to determine the distacharge date of the patient hospitalization
birth_dateDATETIMEPatient date of birth. This variable is used to calculate age at admission for analysis
zipcode_9digitVARCHARPatient zipcode. This variable is used to link the database with other indices like ADI, SVI etc

Example:

encounter_idadmission_dttmdischarge_dttmbirth_datezipcode_9digit
12020-08-27 08:15:002020-08-27 18:59:002014-08-10
22021-06-28 07:00:002021-06-27 19:00:002000-02-11
32021-09-17 08:43:002021-09-17 18:59:002000-02-11
102020-08-12 00:44:002020-08-12 18:59:001990-04-21
112021-04-19 06:23:002021-04-19 18:59:002019-01-23
122022-10-06 10:43:002022-10-06 18:59:002019-01-23

Encounter_demographics_disposition

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter.
age_at_admissionINTAge of the patient at the time of admission. Calculated using the admission_dttm and birth_date from the limited identifiers table.
disposition_nameVARCHAROriginal disposition name string recorded in the raw data. This field allows for the storing of the dispostion value as it appears in the source data. This field is not used for analysis.
disposition_categoryVARCHARDescription of disposition when discharged. Map source values stored in disposition_name to the mCIDE categories.Home, Hospice, Discharged to another facility, Dead, Admitted, Other

Example:

encounter_idage_at_admissiondisposition_namedisposition_category
16Discharged to Home or Self Care (Routine Discharge)Home
222Discharged/transferred to Home Under Care of Organized Home Health Service OrgHome
354Left Against Medical Advice or Discontinued CareHome
1020Discharged/transferred to a Short-Term General Hospital for Inpatient CareDischarged to another facility
112Discharged/transferred to a Facility that Provides Custodial or Supportive CareDischarged to another facility
6266Hospice - Medical Facility (Certified) Providing Hospice Level of CareHospice
634827ExpiredDead

ADT

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter
hospital_idVARCHARAssign an ID to each hospital in the hospital system
in_dttmDATETIMEStart date and time at a particular locationDatetime format should be %Y-%m-%d %H:%M:%S
out_dttmDATETIMEEnd date and time at a particular locationDatetime format should be %Y-%m-%d %H:%M:%S
location_nameVARCHARLocation of the patient inside the hospital. This field is used to store the patient location from the source data. This field is not used for analysis.No restriction
location_categoryVARCHARMap location_name from the source data to categories identified under CLIF.ER, OR, ICU, Ward, Other

Example:

encounter_idhospital_idin_dttmout_dttmlocation_namelocation_category
1A2020-12-28 10:35:002020-12-29 03:21:00ED CCDER
1A2020-12-29 03:21:002020-12-29 07:25:00N03WWard
3A2021-03-18 05:02:002021-03-19 20:22:00N03WICU
3B2021-03-19 20:22:002021-03-22 09:30:00T5SWWard
11F2022-09-30 17:50:002022-09-30 23:30:00ER COMERER

Vitals

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter.
recorded_dttmDATETIMEDate and time when the vital is recorded.Datetime format should be %Y-%m-%d %H:%M:%S
vital_nameVARCHARThis field is used to store the description of the flowsheet measure from the source data. This field is not used for analysis.No restriction
vital_categoryVARCHARMap flowsheet measures stored in vital_name to the to categories identified under CLIF.temp_c, pulse, sbp, dbp, spo2, respiratory_rate, map, height_inches, weight_kg
vital_valueDOUBLERecorded value of the vital. Ensure that the measurement unit is aligned with the permissible units of measurements.temp_c = Celsius, height_inches = Inch, weight_kg = Kg, map = mm/Hg, spo2 = %, No unit for pulse, sbp, dbp, and respiratory_rate
meas_site_nameVARCHARSite where vital is recordedNo restrictions. Record the site name from the source data.

Example:

encounter_idrecorded_dttmvital_namevital_categoryvital_valuemeas_site_name
12022-05-05 04:18:00RESPIRATIONSrespiratory_rate18not specified
12022-05-05 04:18:00PULSE OXIMETRYspo297not specified
12022-05-05 04:18:00NUR RS CORE TEMPERATURE MEASUREMENTtemp_c98.1core
12022-05-05 04:18:00PULSEpulse73not specified
12022-05-01 11:23:00WEIGHT/SCALEweight_kg78.8not specified
12022-05-01 11:23:00HEIGHTheight_inches73not specified

Labs

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter.
lab_order_dttmDATETIMEDate and time when the lab is ordered.Datetime format should be %Y-%m-%d %H:%M:%S
lab_collect_dttmDATETIMEDate and time when the specimen is collected.Datetime format should be %Y-%m-%d %H:%M:%S
lab_result_dttmDATETIMEDate and time when the lab results are available.Datetime format should be %Y-%m-%d %H:%M:%S
lab_nameVARCHAROriginal lab name string recorded in the raw data. This field is not used for analysis.
lab_categoryVARCHAR43 labs identified by the CLIF consortium.List of lab categories in CLIF
lab_groupVARCHARLab categories roll up to form lab groups.ABG, BMP, CBC, Coags, LFT, Lactic Acid, Misc, VBG
lab_valueDOUBLERecorded value corresponding to a lab.
reference_unitVARCHARUnit of measurement for that lab .Permissible reference values for each lab_category listed here
lab_type_nameVARCHARType of lab.arterial, venous, standard, poc

Example:

encounter_idlab_order_dttmlab_collect_dttmlab_result_dttmlab_namelab_grouplab_categorylab_valuereference_unitlab_type_name
22022-09-30 17:50:002022-09-30 18:05:002022-09-30 18:53:00BASOPHILSCBCbasophil1%standard
22022-09-30 17:50:002022-09-30 18:05:002022-09-30 18:53:00MONOCYTESCBCmonocyte7%standard
22022-09-30 17:50:002022-09-30 18:05:002022-09-30 18:53:00NEUTROPHILSCBCneutrophil47%standard
22022-09-30 17:50:002022-09-30 18:05:002022-09-30 18:53:00LYMPHOCYTESCBClymphocyte44%standard
22022-09-30 17:50:002022-09-30 18:05:002022-09-30 18:53:00EOSINOPHILSCBCeosinophils1%standard
22022-09-30 17:50:002022-09-30 18:05:002022-09-30 18:53:00BILIRUBIN, UNCONJUGATEDLFTbilirubin_unconjugated0.9mg/dLstandard

Note: The lab_value field often has non-numeric entries that are useful to make project-specific decisions. A site may choose to keep the lab_value field as a character and create a new field lab_value_numeric that only parses the character field to extract the numeric part of the string.

Microbiology

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter.
test_idVARCHARAn ID for a specific component, such as a gram culture smear, taken from a fluid sample with a unique order and collection time, if two different pathogens are identified, the result will be recorded as two separate rows, each sharing the same test_id.
order_dttmDATETIMEDate and time when the test is ordered.Datetime format should be %Y-%m-%d %H:%M:%S
collect_dttmDATETIMEDate and time when the specimen is collected.Datetime format should be %Y-%m-%d %H:%M:%S
result_dttmDATETIMEDate and time when the results are available.Datetime format should be %Y-%m-%d %H:%M:%S
fluid_nameVARCHARCleaned fluid name string from the raw data. This field is not used for analysis.No restriction. Check this file for examples: clif_vocab_microbiology_fluid_ucmc.csv
fluid_categoryVARCHARFluid categories defined according to the NIH common data elements.CDE NIH Infection Site
component_nameVARCHAROriginal componenet names from the source data.No restriction
component_categoryVARCHARMap component names to the categories identified under CLIF.culture, gram stain, smear
organism_nameVARCHARCleaned oragnism name string from the raw data. This field is not used for analysis.No restriction. Check this file for examples: clif_vocab_microbiology_organism_ucmc.csv
organism_categoryVARCHAROrganism categories defined according to the NIH common data elements.CDE NIH Organism

Example:

encounter_idtest_idorder_dttmcollect_dttmresult_dttmfluid_namefluid_categorycomponent_namecomponent_categoryorganism_nameorganism_category
115/11/20 15:145/11/20 15:175/12/20 15:17culture & stain, pleural fluidpleural cavity, pleural fluidquant. gram staingram staingram negative rod (nos)
1215/11/20 15:145/11/20 15:175/14/20 15:17culture & stain, pleural fluidpleural cavity, pleural fluidcultureculturemorganella_morganii
237/20/20 19:237/20/20 19:247/22/20 16:07culture & stain, fluidgallbladder and billary tree (not hepatitis), pancreasgram staingram stainno growth
2427/20/20 19:237/20/20 19:247/23/20 17:07culture & stain, fluidgallbladder and billary tree (not hepatitis), pancreascultureculturehaemophilus_influenzae
3538/7/20 22:388/8/20 22:388/10/20 22:38culture & stain, respiratorylower respiratory tract (lung)culture, fungal and bacterialculturerhizopus_sp

Respiratory_support

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter
recorded_dttmDATETIMEDate and time when the device startedDatetime format should be %Y-%m-%d %H:%M:%S
device_nameVARCHARIncludes raw string of the devices. Not used for analysisExample mapping for device name to device category
device_categoryVARCHARIncludes a limited number of devices identified by the CLIF consortiumVent, NIPPV, CPAP, High Flow NC, Face Mask, Trach Collar, Nasal Cannula, Room Air, Other
mode_nameVARCHARIncludes raw string of the modes. Not used for analysisExample mapping for mode name to mode category
mode_categoryVARCHARLimited number of modes identified by the CLIF consortiumAssist Control-Volume Control, Pressure Support/CPAP, Pressure Control, Pressure-Regulated Volume Control, Other, SIMV, Blow by
tracheostomyBOOLEANIndicates if tracheostomy is performed0 = No, 1 = Yes
fio2_setDOUBLEFraction of inspired oxygen set
lpm_setDOUBLELiters per minute set
tidal_volume_setDOUBLETidal volume set (in mL)
resp_rate_setDOUBLERespiratory rate set (in bpm)
pressure_control_setDOUBLEPressure control set (in cmH2O)
pressure_support_setDOUBLEPressure support set (in cmH2O)
flow_rate_setDOUBLEFlow rate set
peak_inspiratory_pressure_setDOUBLEPeak inspiratory pressure set (in cmH2O)
inspiratory_time_setDOUBLEInspiratory time set (in seconds)
peep_setDOUBLEPositive-end-expiratory pressure set (in cmH2O)
tidal_volume_obsDOUBLEObserved tidal volume (in mL)
resp_rate_obsDOUBLEObserved respiratory rate (in bpm)
plateau_pressure_obsDOUBLEObserved plateau pressure (in cmH2O)
peak_inspiratory_pressure_obsDOUBLEObserved peak inspiratory pressure (in cmH2O)
peep_obsDOUBLEObserved positive-end-expiratory pressure (in cmH2O)
minute_vent_obsDOUBLEObserved minute ventilation (in liters)

Example:

encounter_idrecorded_dttmdevice_namedevice_categorymode_namemode_categorytracheostomyfio2_setlpm_settidal_volume_setresp_rate_setpressure_control_setpressure_support_setflow_rate_setpeak_inspiratory_pressure_setinspiratory_time_setpeep_settidal_volume_obsresp_rate_obsplateau_pressure_obspeak_inspiratory_pressure_obspeep_obsminute_vent_obs
52024-05-05 19:37:26Nasal Cannula06
52024-05-05 20:37:26High Flow NC01006060
52024-05-05 21:37:26High Flow NC01006060
52024-05-05 22:37:26VentAssist-Control/Volume Control01005002001.2540014303557
52024-05-05 23:37:26VentAssist-Control/Volume Control0804001401.25400147
52024-05-06 00:37:26VentAssist-Control/Volume Control0754001401.2540022
52024-05-06 03:37:26VentAssist-Control/Volume Control0504001401.25400230357
52024-05-06 04:37:26VentPressure Support05005
52024-05-06 05:37:26Nasal Cannula0420

Medication_admin_continuous

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter
med_order_idVARCHARMedication order id. Foreign key to link this table to other medication tables
admin_dttmDATETIMEDate and time when the medicine was administeredDatetime format should be %Y-%m-%d %H:%M:%S
med_nameVARCHAROriginal med name string recorded in the raw data for a limited number of labs identified by the CLIF consortiumExample mapping of med_name to med_category
med_categoryVARCHARLimited number of medication categories identified by the CLIF consortiumList of continuous medication categories in CLIF
med_routeVARCHAReod of medicine delivery
med_doseVARCHARquantity taken in dose
med_dose_unitVARCHARunit of dose

Example:

encounter_idmed_order_idadmin_dttmmed_namemed_categorymed_routemed_dosemed_dose_unit
24310/6/2022 11:10:00phenylephrinevasoactivesIntravenous0.4mcg/kg/min
27610/6/2022 11:13:00phenylephrinevasoactivesIntravenous0.75mcg/kg/min
28910/6/2022 11:32:00insulinendocrineIntravenous2Units/hr
11421/22/2022 00:00:00propofolsedationIntravenous40mcg/kg/min
118071/22/2022 02:13:00propofolsedationIntravenous30mcg/kg/min
114321/22/2022 04:00:00fentanylsedationIntravenous150mcg/hr

Note: The medication_admin_intermittent table has exactly the same schema. The consortium decided to separate the medications that are administered intermittenly from the continuously administered medications.

Dialysis

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter
start_dttmDATETIMEStart date and time of dialysis sessionDatetime format should be %Y-%m-%d %H:%M:%S
stop_dttmDATETIMEStop date and time of dialysis sessionDatetime format should be %Y-%m-%d %H:%M:%S
dialysis_typeVARCHARType of dialysis performedintermittent, peritoneal, crrt
dialysate_flow_amountDOUBLEAmount of dialysate flow
ultrafiltration_amountDOUBLEAmount of ultrafiltration

Example:

encounter_idstart_dttmstop_dttmdialysis_typedialysate_flow_amountultrafiltration_amount
182021-03-24 09:00:002021-03-24 10:00:00crrt0.860
182021-03-24 10:00:002021-03-24 11:00:00crrt3.890
182021-03-24 11:00:002021-03-24 12:00:00crrt3.820
182021-03-24 12:00:002021-03-24 13:00:00crrt3.890
182021-03-24 13:00:002021-03-24 14:00:00crrt3.890
182021-03-24 14:00:002021-03-24 15:00:00crrt3.9000

Position

ColumnTypeDescriptionPermissible Values
encounter_idVARCHARID variable for each patient encounter. This table only includes those encounters that have proning documented ever.
recorded_dttmDATETIMEDate and time when the vital is recorded.Datetime format should be %Y-%m-%d %H:%M:%S
position_nameVARCHARThis field is used to store the description of the position from the source data. This field is not used for analysis.No restriction
position_categoryVARCHARMap position_name to the to categories identified under CLIF.prone, not_prone

Example:

encounter_idrecorded_dttmposition_nameposition_category
132017-10-25 12:31:00Lying downnot_prone
132017-10-25 14:07:00Sittingnot_prone
132017-10-26 08:11:00Lying downnot_prone
132017-10-27 08:24:00Proneprone
132017-11-19 17:05:00Lying down;HOB equal/greater than 30 degreesnot_prone
132017-11-20 11:23:00Lying down;Proneprone