Updates to csv files detailing CDM v5.3.1 data structure. This is to be used as input to write code to create the pdf file which will be committed at a later date.

This commit is contained in:
clairblacketer 2020-04-20 11:46:13 -04:00
parent 19db496c38
commit 8e7ae874b1
4 changed files with 525 additions and 10995 deletions

View File

@ -0,0 +1,404 @@
cdmTableName,cdmFieldName,isRequired,cdmDatatype,userGuidance,etlConventions,isPrimaryKey,isForeignKey,fkTableName,fkFieldName,unique DQ identifiers
PERSON,person_id,Yes,integer,It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.,"Any person linkage that needs to occur to uniquely identify Persons ought to be done prior to writing this table. This identifier can be the original id from the source data provided it is an integer, otherwise it can be an autogenerated number.",Yes,No,,,
PERSON,gender_concept_id,Yes,integer,This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues.,Use the gender or sex value present in the data under the assumption that it is the biological sex at birth. If the source data captures gender identity it should be stored in the OBSERVATION table. Accepted gender concepts.,No,Yes,CONCEPT,CONCEPT_ID,
PERSON,year_of_birth,Yes,integer,,"For data sources with date of birth, the year should be extracted. For data sources where the year of birth is not available, the approximate year of birth could be derived based on age group categorization, if available.",No,No,,,
PERSON,month_of_birth,No,integer,,"For data sources that provide the precise date of birth, the month should be extracted and stored in this field.",No,No,,,
PERSON,day_of_birth,No,integer,,"For data sources that provide the precise date of birth, the day should be extracted and stored in this field.",No,No,,,
PERSON,birth_datetime,No,datetime,Compute age using birth_datetime.,"For data sources that provide the precise datetime of birth, that value should be stored in this field. If birth_datetime is not provided in the source, use the following logic to infer the date: If day_of_birth is null and month_of_birth is not null then use the first of the month in that year. If month_of_birth is null or if day_of_birth AND month_of_birth are both null and the person has records during their year of birth then use the date of the earliest record, otherwise use the 15th of June of that year. If time of birth is not given use midnight (00:00:0000).",No,No,,,
PERSON,race_concept_id,Yes,integer,This field captures race or ethnic background of the person.,"Only use this field if you have information about race or ethnic background. The Vocabulary contains Concepts about the main races and ethnic backgrounds in a hierarchical system. Due to the imprecise nature of human races and ethnic backgrounds, this is not a perfect system. Mixed races are not supported. If a clear race or ethnic background cannot be established, use Concept_Id 0.",No,Yes,CONCEPT,CONCEPT_ID,
PERSON,ethnicity_concept_id,Yes,integer,"This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between ""Hispanic"" and ""Not Hispanic"". Races and Ethnic backgrounds are not stored here.",Only use this field if you have US-based data and a source of this information. Do not attempt to infer Ethnicity from the race or ethnic background of the Person.,No,Yes,CONCEPT,CONCEPT_ID,
PERSON,location_id,No,integer,The location refers to the physical address of the person. This field should capture the last known location of the person. Any prior locations are captured in the LOCATION_HISTORY table.,"Put the location_id from the LOCATION table here that represents the most granular location information for the person. This could represent anything from postal code or parts thereof, state, or county for example. Since many databases contain deindentified data, it is common that the precision of the location is reduced to prevent re-identification. This field should capture the last known location. Any prior locations are captured in the LOCATION_HISTORY table.",No,Yes,LOCATION,LOCATION_ID,
PERSON,provider_id,No,integer,The Provider refers to the last known primary care provider (General Practitioner).,"Put the provider_id from the PROVIDER table of the last known general practitioner of the person. If there are multiple providers, it is up to the business to decide which to put here.",No,Yes,PROVIDER,PROVIDER_ID,
PERSON,care_site_id,No,integer,The Care Site refers to where the Provider typically provides the primary care.,,No,Yes,CARE_SITE,CARE_SITE_ID,
PERSON,person_source_value,No,varchar(50),Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic.,Some use cases require the ability to link back to persons in the source data. This field allows for the storing of the person value as it appears in the source. This field is not required but strongly recommended.,No,No,,,
PERSON,gender_source_value,No,varchar(50),This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only.,Put the biological sex of the person as it appears in the source data.,No,No,,,
PERSON,gender_source_concept_id,No,Integer,"Due to the small number of options, this tends to be zero.","If the source data codes biological sex in a non-standard vocabulary, store the concept_id here.",No,Yes,CONCEPT,CONCEPT_ID,
PERSON,race_source_value,No,varchar(50),This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only.,Put the race of the person as it appears in the source data.,No,No,,,
PERSON,race_source_concept_id,No,Integer,"Due to the small number of options, this tends to be zero.",If the source data codes race in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
PERSON,ethnicity_source_value,No,varchar(50),This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only.,"If the person has an ethnicity other than the OMB standard of ""Hispanic"" or ""Not Hispanic"" store that value from the source data here.",No,No,,,
PERSON,ethnicity_source_concept_id,No,Integer,"Due to the small number of options, this tends to be zero.","If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here.",No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION_PERIOD,observation_period_id,Yes,integer,A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id.,Assign a unique observation_period_id to each discrete Observation Period for a Person.,Yes,No,,,
OBSERVATION_PERIOD,person_id,Yes,integer,The Person ID of the PERSON record for which the Observation Period is recorded.,,No,Yes,PERSON,PERSON_ID,
OBSERVATION_PERIOD,observation_period_start_date,Yes,date,Use this date to determine the start date of the Observation Period,"It is often the case that the idea of Observation Periods does not exist in source data. In those cases, the observation_period_start_date can be inferred as the earliest Event date available for the Person. In insurance claim data, the Observation Period can be considered as the time period the Person is enrolled with a payer. If a Person switches plans but stays with the same payer, and therefore capturing of data continues, that change would be captured in PAYER_PLAN_PERIOD.",No,No,,,
OBSERVATION_PERIOD,observation_period_end_date,Yes,date,Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded.,"It is often the case that the idea of Observation Periods does not exist in source data. In those cases, the observation_period_end_date can be inferred as the last Event date available for the Person. In insurance claim data, the Observation Period can be considered as the time period the Person is enrolled with a payer.",No,No,,,
OBSERVATION_PERIOD,period_type_concept_id,Yes,Integer,"This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources.",Choose the observation_period_type_concept_id that best represents how the period was determined.,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_OCCURRENCE,visit_occurrence_id,Yes,integer,Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit.,This should be populated by creating a unique identifier for each unique interaction between a person and the healthcare system where the person receives a medical good or service over a span of time.,Yes,No,,,
VISIT_OCCURRENCE,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
VISIT_OCCURRENCE,visit_concept_id,Yes,integer,"This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.","Populate this field based on the kind of visit that took place for the person. For example this could be ""Inpatient Visit"", ""Outpatient Visit"", ""Ambulatory Visit"", etc. This table will contain standard concepts in the Visit domain. These concepts are arranged in a hierarchical structure to facilitate cohort definitions by rolling up to generally familiar Visits adopted in most healthcare systems worldwide.",No,Yes,CONCEPT,CONCEPT_ID,
VISIT_OCCURRENCE,visit_start_date,Yes,date,"For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.","When populating visit_start_date, you should think about the patient experience to make decisions on how to define visits. In the case of an inpatient visit this should be the date the patient was admitted to the hospital or institution. In all other cases this should be the date of the patient-provider interaction.",No,No,,,
VISIT_OCCURRENCE,visit_start_datetime,No,datetime,,"If no time is given for the start date of a visit, set it to midnight (00:00:0000).",No,No,,,
VISIT_OCCURRENCE,visit_end_date,Yes,date,For inpatient visits the end date is typically the discharge date.,"Visit end dates are mandatory. If end dates are not provided in the source there are three ways in which to derive them:
Outpatient Visit: visit_end_datetime = visit_start_datetime
Emergency Room Visit: visit_end_datetime = visit_start_datetime
Inpatient Visit: Usually there is information about discharge. If not, you should be able to derive the end date from the sudden decline of activity or from the absence of inpatient procedures/drugs.
Non-hospital institution Visits: Particularly for claims data, if end dates are not provided assume the visit is for the duration of month that it occurs.
For Inpatient Visits ongoing at the date of ETL, put date of processing the data into visit_end_datetime and visit_type_concept_id with 32220 ""Still patient"" to identify the visit as incomplete.
All other Visits: visit_end_datetime = visit_start_datetime. If this is a one-day visit the end date should match the start date.",No,No,,,
VISIT_OCCURRENCE,visit_end_datetime,No,datetime,,"If no time is given for the end date of a visit, set it to midnight (00:00:0000).",No,No,,,
VISIT_OCCURRENCE,visit_type_concept_id,Yes,Integer,"Use this field to understand the provenance of the visit record, or where the record comes from.","Populate this field based on the provenance of the visit record, as in whether it came from an EHR record or billing claim.",No,Yes,CONCEPT,CONCEPT_ID,
VISIT_OCCURRENCE,provider_id,No,integer,"There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table.","If there are multiple providers associated with a visit, you will need to choose which one to put here. The additional providers can be stored in the visit_detail table.",No,Yes,PROVIDER,PROVIDER_ID,
VISIT_OCCURRENCE,care_site_id,No,integer,This field provides information about the care site where the visit took place.,There should only be one care site associated with a visit.,No,Yes,CARE_SITE,CARE_SITE_ID,
VISIT_OCCURRENCE,visit_source_value,No,varchar(50),"This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.)","If there is information about the kind of visit in the source data that value should be stored here. If a visit is an amalgamation of visits from the source then use a hierarchy to choose the visit source value, such as IP -> ER-> OP. This should line up with the logic chosen to determine how visits are created.",No,No,,,
VISIT_OCCURRENCE,visit_source_concept_id,No,integer,,If the visit source value is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_OCCURRENCE,admitting_source_concept_id,No,integer,"Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.","If available, map the admitted_from_source_value to a standard concept in the visit domain.",No,Yes,CONCEPT,CONCEPT_ID,
VISIT_OCCURRENCE,admitting_source_value,No,varchar(50),,"This information may be called something different in the source data but the field is meant to contain a value indicating where a person was admitted from. Typically this applies only to visits that have a length of stay, like inpatient visits or long-term care visits.",No,No,,,
VISIT_OCCURRENCE,discharge_to_concept_id,No,integer,"Use this field to determine where the patient was discharged to after a visit. This concept is part of the visit domain and can indicate if a patient was discharged to home or sent to a long-term care facility, for example.","If available, map the discharge_to_source_value to a standard concept in the visit domain.",No,Yes,CONCEPT,CONCEPT_ID,
VISIT_OCCURRENCE,discharge_to_source_value,No,varchar(50),,"This information may be called something different in the source data but the field is meant to contain a value indicating where a person was discharged to after a visit, as in they went home or were moved to long-term care. Typically this applies only to visits that have a length of stay of a day or more.",No,No,,,
VISIT_OCCURRENCE,preceding_visit_occurrence_id,No,integer,Use this field to find the visit that occured for the person prior to the given visit. There could be a few days or a few years in between.,"The preceding_visit_id can be used to link a visit immediately preceding the current visit. Note this is not symmetrical, and there is no such thing as a ""following_visit_id"".",No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
CONDITION_OCCURRENCE,condition_occurrence_id,Yes,bigint,The unique key given to a condition record for a person. Refer to the ETL for how duplicate conditions during the same visit were handled. ,"Each instance of a condition present in the source data should be assigned this unique key. In some cases, a person can have multiple records of the same condition within the same visit. It is valid to keep these duplicates and assign them individual, unique, CONDITION_OCCURRENCE_IDs, though it is up to the ETL how they should be handled.",Yes,No,,,
CONDITION_OCCURRENCE,person_id,Yes,bigint,The PERSON_ID of the PERSON for whom the condition is recorded.,,No,Yes,PERSON,PERSON_ID,
CONDITION_OCCURRENCE,condition_concept_id,Yes,integer,"The CONDITION_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a condition","The CONCEPT_ID that the CONDITION_SOURCE_VALUE maps to. Only records whose source values map to concepts with a domain of ""Condition"" should go in this table. ",No,Yes,CONCEPT,CONCEPT_ID,
CONDITION_OCCURRENCE,condition_start_date,Yes,date,Use this date to determine the start date of the condition,"Most often data sources do not have the idea of a start date for a condition. Rather, if a source only has one date associated with a condition record it is acceptable to use that date for both the CONDITION_START_DATE and the CONDITION_END_DATE.",No,No,,,
CONDITION_OCCURRENCE,condition_start_datetime,No,datetime,,If a source does not specify datetime the convention is to set the time to midnight (00:00:0000),No,No,,,
CONDITION_OCCURRENCE,condition_end_date,No,date,Use this date to determine the end date of the condition,"Most often data sources do not have the idea of a start date for a condition. Rather, if a source only has one date associated with a condition record it is acceptable to use that date for both the CONDITION_START_DATE and the CONDITION_END_DATE.",No,No,,,
CONDITION_OCCURRENCE,condition_end_datetime,No,datetime,,If a source does not specify datetime the convention is to set the time to midnight (00:00:0000),No,No,,,
CONDITION_OCCURRENCE,condition_type_concept_id,Yes,integer,"This field can be used to determine the provenance of the Condition record, as in whether the condition was from an EHR system, insurance claim, registry, or other sources.",Choose the condition_type_concept_id that best represents the provenance of the record. ,No,Yes,CONCEPT,CONCEPT_ID,
CONDITION_OCCURRENCE,condition_status_concept_id,No,integer,"This concept represents the point during the visit the diagnosis was given (admitting diagnosis, final diagnosis), whether the diagnosis was determined due to laboratory findings, if the diagnosis was exclusionary, or if it was a preliminary diagnosis, among others. ","Presently, there is no designated vocabulary, domain, or class that represents condition status. The concepts with a relationship_id of ""subsumes"" with CONCEPT_ID 4021918 ""Qualifier for type of diagnosis"" should be used. These include admitting diagnosis, principal diagnosis, and secondary diagnosis.",No,Yes,CONCEPT,CONCEPT_ID,
CONDITION_OCCURRENCE,stop_reason,No,varchar(20),The Stop Reason indicates why a Condition is no longer valid with respect to the purpose within the source data. Note that a Stop Reason does not necessarily imply that the condition is no longer occurring.,This information is often not populated in source data and it is a valid etl choice to leave it blank if the information does not exist.,No,No,,,
CONDITION_OCCURRENCE,provider_id,No,integer,The provider associated with condition record. ,The ETL may need to make a choice as to which PROVIDER_ID to put here. Based on what is available this may or may not be different than the provider associated with the overall VISIT_OCCURRENCE record.,No,Yes,PROVIDER,PROVIDER_ID,
CONDITION_OCCURRENCE,visit_occurrence_id,No,integer,The visit during which the condition was diagnosed.,"Depending on the structure of the source data, this may have to be determined based on dates.",No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
CONDITION_OCCURRENCE,visit_detail_id,No,integer,"The VISIT_DETAIL record during which the condition was diagnosed. For example, if the person was in the ICU at the time of the diagnosis the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.",,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
CONDITION_OCCURRENCE,condition_source_value,No,varchar(50),"This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Condition necessary for a given analytic use case. Consider using CONDITION_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network. ",This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference.,No,No,,,
CONDITION_OCCURRENCE,condition_source_concept_id,No,integer,,If the CONDITION_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.,No,Yes,CONCEPT,CONCEPT_ID,
CONDITION_OCCURRENCE,condition_status_source_value,No,varchar(50),,This information may be called something different in the source data but the field is meant to contain a value indicating when and how a diagnosis was given to a patient. This source value is mapped to a standard concept which is stored in the CONDITION_STATUS_CONCEPT_ID field.,No,No,,,
DRUG_EXPOSURE,drug_exposure_id,Yes,bigint,Use this to identify unique dispensings or administrations of a drug product to a person,This should be populated by creating a unique identifier for each unique instance where a person receives a dispensing or administration of a drug.,Yes,No,,,
DRUG_EXPOSURE,person_id,Yes,bigint,,,No,Yes,PERSON,PERSON_ID,
DRUG_EXPOSURE,drug_concept_id,Yes,integer,"The DRUG_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a drug product or molecule otherwise introduced to the body.",Map source values to standard concepts. All concepts in the DRUG_EXPOSURE table should be in the 'Drug' domain.,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_EXPOSURE,drug_exposure_start_date,Yes,date,,"Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration procedure was recorded.",No,No,,,
DRUG_EXPOSURE,drug_exposure_start_datetime,No,datetime,,If time is unknown set it to midnight.,No,No,,,
DRUG_EXPOSURE,drug_exposure_end_date,Yes,date,,"The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient. This could be that the duration of DAYS_SUPPLY was reached, or because the exposure was stopped (medication changed, medication discontinued, etc.). To populate this field, start first with DAYS_SUPPLY using the calculation DRUG_EXPOSURE_END_DATE = DRUG_EXPOSURE_START_DATE + DAYS_SUPPLY -1 day. If DAYS_SUPPLY is not available then use the VERBATIM_END_DATE as it is given in the source data. If there is no verbatim end date then set DRUG_EXPOSURE_END_DATE equal to DRUG_EXPOSURE_START_DATE. When the native data suggests a drug exposure has a days supply less than 0, drop the record as it is unknown if a person has received the drug or not (THEMIS issue #24). If a patient has multiple records on the same day for the same drug or procedures the ETL should not de-dupe them unless there is probable reason to believe the item is a true data duplicate (THEMIS issue #14). Depending on different sources, it could be a known or an inferred date and denotes the last day at which the patient was still exposed to Drug.",No,No,,,
DRUG_EXPOSURE,drug_exposure_end_datetime,No,datetime,,If time is unknown set it to midnight.,No,No,,,
DRUG_EXPOSURE,verbatim_end_date,No,date,"This is the end date as it appears in the source data, if it is given.",Put the end date for the drug exposure as it appears in the source data. This may or may not be the same as DRUG_EXPOSURE_END_DATE given the logic for assigning DRUG_EXPOSURE_END_DATE.,No,No,,,
DRUG_EXPOSURE,drug_type_concept_id,Yes,integer,You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure,This field is meant to preserve the provenance of the record. Any standard concepts in the 'Type Concept' domain are valid here. ,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_EXPOSURE,stop_reason,No,varchar(20),"Reason a person stopped a medication. Reasons include regimen completed, changed, removed, etc.",,No,No,,,
DRUG_EXPOSURE,refills,No,integer,"The content of the refills field determines the current refill number, not the number of remaining refills. For example, for a drug prescription with 2 refills, the content of this field for the 3 Drug Exposure events are null, 1 and 2.",,No,No,,,
DRUG_EXPOSURE,quantity,No,float,,,No,No,,,
DRUG_EXPOSURE,days_supply,No,integer,,,No,No,,,
DRUG_EXPOSURE,sig,No,varchar(MAX),(and printed on the container),,No,No,,,
DRUG_EXPOSURE,route_concept_id,No,integer,"Route information can also be inferred from the Drug product itself by determining the Drug Form of the Concept, creating some partial overlap of the same type of information. Therefore, route information should be stored in DRUG_CONCEPT_ID (as a drug with corresponding Dose Form). The ROUTE_CONCEPT_ID could be used for storing more granular forms e.g. 'Intraventricular cardiac'.",,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_EXPOSURE,lot_number,No,varchar(50),,,No,No,,,
DRUG_EXPOSURE,provider_id,No,integer,,,No,Yes,PROVIDER,PROVIDER_ID,
DRUG_EXPOSURE,visit_occurrence_id,No,integer,,,No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
DRUG_EXPOSURE,visit_detail_id,No,integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
DRUG_EXPOSURE,drug_source_value,No,varchar(50),,"This code is mapped to a Standard Drug concept in the Standardized Vocabularies and the original code is, stored here for reference.",No,No,,,
DRUG_EXPOSURE,drug_source_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_EXPOSURE,route_source_value,No,varchar(50),,,No,No,,,
DRUG_EXPOSURE,dose_unit_source_value,No,varchar(50),,,No,No,,,
PROCEDURE_OCCURRENCE,procedure_occurrence_id,Yes,integer,,,Yes,No,,,
PROCEDURE_OCCURRENCE,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
PROCEDURE_OCCURRENCE,procedure_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
PROCEDURE_OCCURRENCE,procedure_date,Yes,date,,,No,No,,,
PROCEDURE_OCCURRENCE,procedure_datetime,No,datetime,,,No,No,,,
PROCEDURE_OCCURRENCE,procedure_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
PROCEDURE_OCCURRENCE,modifier_concept_id,No,integer,"These concepts are typically distinguished by 'Modifier' concept classes (e.g., 'CPT4 Modifier' as part of the 'CPT4' vocabulary).",,No,Yes,CONCEPT,CONCEPT_ID,
PROCEDURE_OCCURRENCE,quantity,No,integer,"If the quantity value is omitted, a single procedure is assumed.","If a Procedure has a quantity of '0' in the source, this should default to '1' in the ETL. If there is a record in the source it can be assumed the exposure occurred at least once (THEMIS issue #26).",No,No,,,
PROCEDURE_OCCURRENCE,provider_id,No,integer,,,No,No,PROVIDER,PROVIDER_ID,
PROCEDURE_OCCURRENCE,visit_occurrence_id,No,integer,,,No,No,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
PROCEDURE_OCCURRENCE,visit_detail_id,No,integer,,,No,No,VISIT_DETAIL,VISIT_DETAIL_ID,
PROCEDURE_OCCURRENCE,procedure_source_value,No,varchar(50),,"This code is mapped to a standard procedure Concept in the Standardized Vocabularies and the original code is, stored here for reference. Procedure source codes are typically ICD-9-Proc, CPT-4, HCPCS or OPCS-4 codes.",No,No,,,
PROCEDURE_OCCURRENCE,procedure_source_concept_id,No,integer,,,No,No,CONCEPT,CONCEPT_ID,
PROCEDURE_OCCURRENCE,modifier_source_value,No,varchar(50),,,No,No,,,
DEVICE_EXPOSURE,device_exposure_id,Yes,bigint,,,Yes,No,,,
DEVICE_EXPOSURE,person_id,Yes,bigint,,,No,Yes,PERSON,PERSON_ID,
DEVICE_EXPOSURE,device_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DEVICE_EXPOSURE,device_exposure_start_date,Yes,date,,,No,No,,,
DEVICE_EXPOSURE,device_exposure_start_datetime,No,datetime,,,No,No,,,
DEVICE_EXPOSURE,device_exposure_end_date,No,date,,,No,No,,,
DEVICE_EXPOSURE,device_exposure_end_datetime,No,datetime,,,No,No,,,
DEVICE_EXPOSURE,device_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DEVICE_EXPOSURE,unique_device_id,No,varchar(50),,"For medical devices that are regulated by the FDA, a Unique Device Identification (UDI) is provided if available in the data source and is recorded in the UNIQUE_DEVICE_ID field.",No,No,,,
DEVICE_EXPOSURE,quantity,No,integer,,,No,No,,,
DEVICE_EXPOSURE,provider_id,No,integer,,,No,Yes,PROVIDER,PROVIDER_ID,
DEVICE_EXPOSURE,visit_occurrence_id,No,integer,,,No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
DEVICE_EXPOSURE,visit_detail_id,No,integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
DEVICE_EXPOSURE,device_source_value,No,varchar(50),,,No,No,,,
DEVICE_EXPOSURE,device_source_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,measurement_id,Yes,integer,,,Yes,No,,,
MEASUREMENT,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
MEASUREMENT,measurement_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,measurement_date,Yes,date,,,No,No,,,
MEASUREMENT,measurement_datetime,No,datetime,,,No,No,,,
MEASUREMENT,measurement_time,No,varchar(10),This is present for backwards compatibility and will be deprecated in an upcoming version,,No,No,,,
MEASUREMENT,measurement_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,operator_concept_id,No,integer,"The meaning of Concept 4172703 for '=' is identical to omission of a OPERATOR_CONCEPT_ID value. Since the use of this field is rare, it's important when devising analyses to not to forget testing for the content of this field for values different from =.","If there is a negative value coming from the source, set the VALUE_AS_NUMBER to NULL, with the exception of the following Measurements (listed as LOINC codes):
1925-7 Base excess in Arterial blood by calculation
1927-3 Base excess in Venous blood by calculation Operators are <, <=, =, >=, > and these concepts belong to the 'Meas Value Operator' domain.
8632-2 QRS-Axis
11555-0 Base excess in Blood by calculation
1926-5 Base excess in Capillary blood by calculation
28638-5 Base excess in Arterial cord blood by calculation
28639-3 Base excess in Venous cord blood by calculation
THEMIS issue #16",No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,value_as_number,No,float,,,No,No,,,
MEASUREMENT,value_as_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,unit_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,range_low,No,float,Ranges have the same unit as the VALUE_AS_NUMBER.,If reference ranges for upper and lower limit of normal as provided (typically by a laboratory) these are stored in the RANGE_HIGH and RANGE_LOW fields. Ranges have the same unit as the VALUE_AS_NUMBER.,No,No,,,
MEASUREMENT,range_high,No,float,Ranges have the same unit as the VALUE_AS_NUMBER.,,No,No,,,
MEASUREMENT,provider_id,No,integer,,,No,Yes,PROVIDER,PROVIDER_ID,
MEASUREMENT,visit_occurrence_id,No,integer,,,No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
MEASUREMENT,visit_detail_id,No,integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
MEASUREMENT,measurement_source_value,No,varchar(50),,,No,No,,,
MEASUREMENT,measurement_source_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
MEASUREMENT,unit_source_value,No,varchar(50),,,No,No,,,
MEASUREMENT,value_source_value,No,varchar(50),,,No,No,,,
VISIT_DETAIL,visit_detail_id,Yes,integer,,,Yes,No,,,
VISIT_DETAIL,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
VISIT_DETAIL,visit_detail_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_DETAIL,visit_detail_start_date,Yes,date,,,No,No,,,
VISIT_DETAIL,visit_detail_start_datetime,No,datetime,,,No,No,,,
VISIT_DETAIL,visit_detail_end_date,Yes,date,,,No,No,,,
VISIT_DETAIL,visit_detail_end_datetime,No,datetime,,,No,No,,,
VISIT_DETAIL,visit_detail_type_concept_id,Yes,Integer,,,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_DETAIL,provider_id,No,integer,,,No,Yes,PROVIDER,PROVIDER_ID,
VISIT_DETAIL,care_site_id,No,integer,,,No,Yes,CARE_SITE,CARE_SITE_ID,
VISIT_DETAIL,visit_detail_source_value,No,string(50),,,No,No,,,
VISIT_DETAIL,visit_detail_source_concept_id,No,Integer,,,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_DETAIL,admitting_source_value,No,Varchar(50),,,No,No,,,
VISIT_DETAIL,admitting_source_concept_id,No,Integer,,,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_DETAIL,discharge_to_source_value,No,Varchar(50),,,No,No,,,
VISIT_DETAIL,discharge_to_concept_id,No,Integer,,,No,Yes,CONCEPT,CONCEPT_ID,
VISIT_DETAIL,preceding_visit_detail_id,No,Integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
VISIT_DETAIL,visit_detail_parent_id,No,Integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
VISIT_DETAIL,visit_occurrence_id,Yes,Integer,,,No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
NOTE,note_id,Yes,integer,,,Yes,No,,,
NOTE,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
NOTE,note_date,Yes,date,,,No,No,,,
NOTE,note_datetime,No,datetime,,,No,No,,,
NOTE,note_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE,note_class_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE,note_title,No,varchar(250),,,No,No,,,
NOTE,note_text,Yes,varchar(MAX),,,No,No,,,
NOTE,encoding_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE,language_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE,provider_id,No,integer,,,No,Yes,PROVIDER,PROVIDER_ID,
NOTE,visit_occurrence_id,No,integer,,,No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
NOTE,visit_detail_id,No,integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
NOTE,note_source_value,No,varchar(50),,,No,No,,,
NOTE_NLP,note_nlp_id,Yes,integer,,,Yes,No,,,
NOTE_NLP,note_id,Yes,integer,,,No,No,,,
NOTE_NLP,section_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE_NLP,snippet,No,varchar(250),,,No,No,,,
NOTE_NLP,offset,No,varchar(50),,,No,No,,,
NOTE_NLP,lexical_variant,Yes,varchar(250),,,No,No,,,
NOTE_NLP,note_nlp_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE_NLP,note_nlp_source_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
NOTE_NLP,nlp_system,No,varchar(250),,,No,No,,,
NOTE_NLP,nlp_date,Yes,date,,,No,No,,,
NOTE_NLP,nlp_datetime,No,datetime,,,No,No,,,
NOTE_NLP,term_exists,No,varchar(1),,"Term_exists is defined as a flag that indicates if the patient actually has or had the condition. Any of the following modifiers would make Term_exists false:
Negation = true
Subject = [anything other than the patient]
Conditional = true/li>
Rule_out = true
Uncertain = very low certainty or any lower certainties
A complete lack of modifiers would make Term_exists true.
",No,No,,,
NOTE_NLP,term_temporal,No,varchar(50),,"Term_temporal is to indicate if a condition is <20>present<6E> or just in the <20>past<73>. The following would be past:
History = true
Concept_date = anything before the time of the report",No,No,,,
NOTE_NLP,term_modifiers,No,varchar(2000),,"For the modifiers that are there, they would have to have these values:
Negation = false
Subject = patient
Conditional = false
Rule_out = false
Uncertain = true or high or moderate or even low (could argue about low). Term_modifiers will concatenate all modifiers for different types of entities (conditions, drugs, labs etc) into one string. Lab values will be saved as one of the modifiers. A list of allowable modifiers (e.g., signature for medications) and their possible values will be standardized later.",No,No,,,
OBSERVATION,observation_id,Yes,integer,,,Yes,No,,,
OBSERVATION,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
OBSERVATION,observation_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION,observation_date,Yes,date,,,No,No,,,
OBSERVATION,observation_datetime,No,datetime,,,No,No,,,
OBSERVATION,observation_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION,value_as_number,No,float,,,No,No,,,
OBSERVATION,value_as_string,No,varchar(60),,,No,No,,,
OBSERVATION,value_as_concept_id,No,Integer,,"Note that the value of VALUE_AS_CONCEPT_ID may be provided through mapping from a source Concept which contains the content of the Observation. In those situations, the CONCEPT_RELATIONSHIP table in addition to the 'Maps to' record contains a second record with the relationship_id set to 'Maps to value'. For example, ICD9CM V17.5 concept_id 44828510 'Family history of asthma' has a 'Maps to' relationship to 4167217 'Family history of clinical finding' as well as a 'Maps to value' record to 317009 'Asthma'.",No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION,qualifier_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION,unit_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION,provider_id,No,integer,,,No,Yes,PROVIDER,PROVIDER_ID,
OBSERVATION,visit_occurrence_id,No,integer,,,No,Yes,VISIT_OCCURRENCE,VISIT_OCCURRENCE_ID,
OBSERVATION,visit_detail_id,No,integer,,,No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,
OBSERVATION,observation_source_value,No,varchar(50),,,No,No,,,
OBSERVATION,observation_source_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
OBSERVATION,unit_source_value,No,varchar(50),,,No,No,,,
OBSERVATION,qualifier_source_value,No,varchar(50),,,No,No,,,
SPECIMEN,specimen_id,Yes,integer,,,Yes,No,,,
SPECIMEN,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
SPECIMEN,specimen_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SPECIMEN,specimen_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SPECIMEN,specimen_date,Yes,date,,,No,No,,,
SPECIMEN,specimen_datetime,No,datetime,,,No,No,,,
SPECIMEN,quantity,No,float,,,No,No,,,
SPECIMEN,unit_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SPECIMEN,anatomic_site_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SPECIMEN,disease_status_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SPECIMEN,specimen_source_id,No,varchar(50),,,No,No,,,
SPECIMEN,specimen_source_value,No,varchar(50),,,No,No,,,
SPECIMEN,unit_source_value,No,varchar(50),,,No,No,,,
SPECIMEN,anatomic_site_source_value,No,varchar(50),,,No,No,,,
SPECIMEN,disease_status_source_value,No,varchar(50),,,No,No,,,
FACT_RELATIONSHIP,domain_concept_id_1,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
FACT_RELATIONSHIP,fact_id_1,Yes,integer,,,No,No,,,
FACT_RELATIONSHIP,domain_concept_id_2,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
FACT_RELATIONSHIP,fact_id_2,Yes,integer,,,No,No,,,
FACT_RELATIONSHIP,relationship_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
LOCATION,location_id,Yes,integer,,,Yes,No,,,
LOCATION,address_1,No,varchar(50),,,No,No,,,
LOCATION,address_2,No,varchar(50),,,No,No,,,
LOCATION,city,No,varchar(50),,,No,No,,,
LOCATION,state,No,varchar(2),,,No,No,,,
LOCATION,zip,No,varchar(9),,"Zip codes are handled as strings of up to 9 characters length. For US addresses, these represent either a 3-digit abbreviated Zip code as provided by many sources for patient protection reasons, the full 5-digit Zip or the 9-digit (ZIP + 4) codes. Unless for specific reasons analytical methods should expect and utilize only the first 3 digits. For international addresses, different rules apply.",No,No,,,
LOCATION,county,No,varchar(20),,,No,No,,,
LOCATION,location_source_value,No,varchar(50),,,No,No,,,
CARE_SITE,care_site_id,Yes,integer,,Assign an id to each unique combination of location_id and place_of_service_source_value,Yes,No,,,
CARE_SITE,care_site_name,No,varchar(255),The name of the care_site as it appears in the source data,,No,No,,,
CARE_SITE,place_of_service_concept_id,No,integer,"This is a high-level way of characterizing a Care Site. Typically, however, Care Sites can provide care in multiple settings (inpatient, outpatient, etc.) and this granularity should be reflected in the visit.","Choose the concept in the visit domain that best represents the setting in which healthcare is provided in the Care Site. If most visits in a Care Site are Inpatient, then the place_of_service_concept_id should represent Inpatient. If information is present about a unique Care Site (e.g. Pharmacy) then a Care Site record should be created.",No,Yes,CONCEPT,CONCEPT_ID,
CARE_SITE,location_id,No,integer,The location_id from the LOCATION table representing the physical location of the care_site.,,No,Yes,LOCATION,LOCATION_ID,
CARE_SITE,care_site_source_value,No,varchar(50),The identifier of the care_site as it appears in the source data. This could be an identifier separate from the name of the care_site.,,No,No,,,
CARE_SITE,place_of_service_source_value,No,varchar(50),,Put the place of service of the care_site as it appears in the source data.,No,No,,,
PROVIDER,provider_id,Yes,integer,It is assumed that every provider with a different unique identifier is in fact a different person and should be treated independently.,"This identifier can be the original id from the source data provided it is an integer, otherwise it can be an autogenerated number.",Yes,No,,,
PROVIDER,provider_name,No,varchar(255),,"This field is not necessary as it is not necessary to have the actual identity of the Provider. Rather, the idea is to uniquely and anonymously identify providers of care across the database.",No,No,,,
PROVIDER,npi,No,varchar(20),This is the National Provider Number issued to health care providers in the US by the Centers for Medicare and Medicaid Services (CMS).,,No,No,,,
PROVIDER,dea,No,varchar(20),"This is the identifier issued by the DEA, a US federal agency, that allows a provider to write prescriptions for controlled substances.",,No,No,,,
PROVIDER,specialty_concept_id,No,integer,"This field either represents the most common specialty that occurs in the data or the most specific concept that represents all specialties listed, should the provider have more than one. This includes physician specialties such as internal medicine, emergency medicine, etc. and allied health professionals such as nurses, midwives, and pharmacists.","If a Provider has more than one Specialty, there are two options: 1. Choose a concept_id which is a common ancestor to the multiple specialties, or, 2. Choose the specialty that occurs most often for the provider. Concepts in this field should be Standard with a domain of Provider.",No,Yes,CONCEPT,CONCEPT_ID,
PROVIDER,care_site_id,No,integer,This is the CARE_SITE_ID for the location that the provider primarily practices in.,"If a Provider has more than one Care Site, the main or most often exerted CARE_SITE_ID should be recorded.",No,Yes,CARE_SITE,CARE_SITE_ID,
PROVIDER,year_of_birth,No,integer,,,No,No,,,
PROVIDER,gender_concept_id,No,integer,This field represents the recorded gender of the provider in the source data.,"If given, put a concept from the gender domain representing the recorded gender of the provider.",No,Yes,CONCEPT,CONCEPT_ID,
PROVIDER,provider_source_value,No,varchar(50),Use this field to link back to providers in the source data. This is typically used for error checking of ETL logic.,Some use cases require the ability to link back to providers in the source data. This field allows for the storing of the provider identifier as it appears in the source.,No,No,,,
PROVIDER,specialty_source_value,No,varchar(50),"This is the kind of provider or specialty as it appears in the source data. This includes physician specialties such as internal medicine, emergency medicine, etc. and allied health professionals such as nurses, midwives, and pharmacists.",Put the kind of provider as it appears in the source data. This field is up to the discretion of the ETL-er as to whether this should be the coded value from the source or the text description of the lookup value.,No,No,,,
PROVIDER,specialty_source_concept_id,No,integer,This is often zero as many sites use propietary codes to store physician speciality.,If the source data codes provider specialty in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
PROVIDER,gender_source_value,No,varchar(50),This is provider's gender as it appears in the source data.,Put the provider's gender as it appears in the source data. This field is up to the discretion of the ETL-er as to whether this should be the coded value from the source or the text description of the lookup value.,No,No,,,
PROVIDER,gender_source_concept_id,No,integer,This is often zero as many sites use propietary codes to store provider gender.,If the source data codes provider gender in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,payer_plan_period_id,Yes,integer,"A unique identifier for each unique combination of a Person, Payer, Plan, and Period of time.",,Yes,Yes,PERSON,PERSON_ID,
PAYER_PLAN_PERIOD,person_id,Yes,integer,The Person covered by the Plan.,"A single Person can have multiple, overlapping, PAYER_PLAN_PERIOD records",No,Yes,PERSON,PERSON_ID,
PAYER_PLAN_PERIOD,payer_plan_period_start_date,Yes,date,Start date of Plan coverage.,,No,No,,,
PAYER_PLAN_PERIOD,payer_plan_period_end_date,Yes,date,End date of Plan coverage.,,No,No,,,
PAYER_PLAN_PERIOD,payer_concept_id,No,integer,This field represents the organization who reimburses the provider which administers care to the Person.,"Map the Payer directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. The point is to stratify on this information and identify if Persons have the same payer, though the name of the Payer is not necessary.",No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,payer_source_value,No,varchar(50),This is the Payer as it appears in the source data.,,No,No,,,
PAYER_PLAN_PERIOD,payer_source_concept_id,No,integer,,If the source data codes the Payer in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,plan_concept_id,No,integer,This field represents the specific health benefit Plan the Person is enrolled in.,Map the Plan directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. The point is to stratify on this information and identify if Persons have the same health benefit Plan though the name of the Plan is not necessary.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,plan_source_value,No,varchar(50),This is the health benefit Plan of the Person as it appears in the source data.,,No,No,,,
PAYER_PLAN_PERIOD,plan_source_concept_id,No,integer,,If the source data codes the Plan in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,sponsor_concept_id,No,integer,"This field represents the sponsor of the Plan who finances the Plan. This includes self-insured, small group health plan and large group health plan.",Map the sponsor directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. The point is to stratify on this information and identify if Persons have the same sponsor though the name of the sponsor is not necessary.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,sponsor_source_value,No,varchar(50),The Plan sponsor as it appears in the source data.,,No,No,,,
PAYER_PLAN_PERIOD,sponsor_source_concept_id,No,integer,,If the source data codes the sponsor in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,family_source_value,No,varchar(50),The common identifier for all people (often a family) that covered by the same policy.,Often these are the common digits of the enrollment id of the policy members.,No,No,,,
PAYER_PLAN_PERIOD,stop_reason_concept_id,No,integer,"This field represents the reason the Person left the Plan, if known.",Map the stop reason directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information.,No,Yes,CONCEPT,CONCEPT_ID,
PAYER_PLAN_PERIOD,stop_reason_source_value,No,varchar(50),The Plan stop reason as it appears in the source data.,,No,No,,,
PAYER_PLAN_PERIOD,stop_reason_source_concept_id,No,integer,,If the source data codes the stop reason in an OMOP supported vocabulary store the concept_id here.,No,Yes,CONCEPT,CONCEPT_ID,
COST,cost_id,Yes,INTEGER,,,Yes,No,,,
COST,cost_event_id,Yes,INTEGER,,,No,No,,,
COST,cost_domain_id,Yes,VARCHAR(20),,,No,Yes,DOMAIN,DOMAIN_ID,
COST,cost_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
COST,currency_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
COST,total_charge,No,FLOAT,,,No,No,,,
COST,total_cost,No,FLOAT,,,No,No,,,
COST,total_paid,No,FLOAT,,,No,No,,,
COST,paid_by_payer,No,FLOAT,,,No,No,,,
COST,paid_by_patient,No,FLOAT,,,No,No,,,
COST,paid_patient_copay,No,FLOAT,,,No,Yes,CONCEPT,CONCEPT_ID,
COST,paid_patient_coinsurance,No,FLOAT,,,No,No,,,
COST,paid_patient_deductible,No,FLOAT,,,No,No,,,
COST,paid_by_primary,No,FLOAT,,,No,No,,,
COST,paid_ingredient_cost,No,FLOAT,,,No,No,,,
COST,paid_dispensing_fee,No,FLOAT,,,No,No,,,
COST,payer_plan_period_id,No,INTEGER,,,No,No,,,
COST,amount_allowed,No,FLOAT,,,No,No,,,
COST,revenue_code_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
COST,revenue_code_source_value,No,VARCHAR(50),Revenue codes are a method to charge for a class of procedures and conditions in the U.S. hospital system.,,No,No,,,
COST,drg_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
COST,drg_source_value,No,VARCHAR(3),Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups. ,,No,No,,,
DRUG_ERA,drug_era_id,Yes,integer,,,Yes,No,,,
DRUG_ERA,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
DRUG_ERA,drug_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_ERA,drug_era_start_date,Yes,datetime,,The Drug Era Start Date is the start date of the first Drug Exposure for a given ingredient. (NOT RIGHT),No,No,,,
DRUG_ERA,drug_era_end_date,Yes,datetime,,"The Drug Era End Date is the end date of the last Drug Exposure. The End Date of each Drug Exposure is either taken from the field drug_exposure_end_date or, as it is typically not available, inferred using the following rules:
For pharmacy prescription data, the date when the drug was dispensed plus the number of days of supply are used to extrapolate the End Date for the Drug Exposure. Depending on the country-specific healthcare system, this supply information is either explicitly provided in the day_supply field or inferred from package size or similar information.
For Procedure Drugs, usually the drug is administered on a single date (i.e., the administration date).
A standard Persistence Window of 30 days (gap, slack) is permitted between two subsequent such extrapolated DRUG_EXPOSURE records to be considered to be merged into a single Drug Era. (ARENT WE REQUIRING TO USE DRUG_EXPOSURE_END_DATE NOW????)",No,No,,,
DRUG_ERA,drug_exposure_count,No,integer,,,No,No,,,
DRUG_ERA,gap_days,No,integer,,"The Gap Days determine how many total drug-free days are observed between all Drug Exposure events that contribute to a DRUG_ERA record. It is assumed that the drugs are ""not stockpiled"" by the patient, i.e. that if a new drug prescription or refill is observed (a new DRUG_EXPOSURE record is written), the remaining supply from the previous events is abandoned. The difference between Persistence Window and Gap Days is that the former is the maximum drug-free time allowed between two subsequent DRUG_EXPOSURE records, while the latter is the sum of actual drug-free days for the given Drug Era under the above assumption of non-stockpiling.",No,No,,,
DOSE_ERA,dose_era_id,Yes,integer,,,Yes,No,,,
DOSE_ERA,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,
DOSE_ERA,drug_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DOSE_ERA,unit_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DOSE_ERA,dose_value,Yes,float,,,No,No,,,
DOSE_ERA,dose_era_start_date,Yes,datetime,,,No,No,,,
DOSE_ERA,dose_era_end_date,Yes,datetime,,,No,No,,,
CONDITION_ERA,condition_era_id,Yes,integer,,,Yes,No,,,
CONDITION_ERA,person_id,Yes,integer,,,No,No,PERSON,PERSON_ID,
CONDITION_ERA,condition_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONDITION_ERA,condition_era_start_date,Yes,datetime,,,No,No,,,
CONDITION_ERA,condition_era_end_date,Yes,datetime,,,No,No,,,
CONDITION_ERA,condition_occurrence_count,No,integer,,,No,No,,,
CONCEPT,concept_id,Yes,integer,,,Yes,No,,,
CONCEPT,concept_name,Yes,varchar(255),,,No,No,,,
CONCEPT,domain_id,Yes,varchar(20),,,No,Yes,DOMAIN,DOMAIN_ID,
CONCEPT,vocabulary_id,Yes,varchar(20),,,No,Yes,VOCABULARY,VOCABULARY_ID,
CONCEPT,concept_class_id,Yes,varchar(20),,,No,Yes,CONCEPT_CLASS,CONCEPT_CLASS_ID,
CONCEPT,standard_concept,No,varchar(1),,,No,No,,,
CONCEPT,concept_code,Yes,varchar(50),,,No,No,,,
CONCEPT,valid_start_date,Yes,date,,,No,No,,,
CONCEPT,valid_end_date,Yes,date,,,No,No,,,
CONCEPT,invalid_reason,No,varchar(1),,,No,No,,,
VOCABULARY,vocabulary_id,Yes,varchar(20),,,Yes,No,,,
VOCABULARY,vocabulary_name,Yes,varchar(255),,,No,No,,,
VOCABULARY,vocabulary_reference,Yes,varchar(255),,,No,No,,,
VOCABULARY,vocabulary_version,No,varchar(255),,,No,No,,,
VOCABULARY,vocabulary_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DOMAIN,domain_id,Yes,varchar(20),,,Yes,No,,,
DOMAIN,domain_name,Yes,varchar(255),,,No,No,,,
DOMAIN,domain_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_CLASS,concept_class_id,Yes,varchar(20),,,Yes,No,,,
CONCEPT_CLASS,concept_class_name,Yes,varchar(255),,,No,No,,,
CONCEPT_CLASS,concept_class_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_RELATIONSHIP,concept_id_1,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_RELATIONSHIP,concept_id_2,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_RELATIONSHIP,relationship_id,Yes,varchar(20),,,No,Yes,RELATIONSHIP,RELATIONSHIP_ID,
CONCEPT_RELATIONSHIP,valid_start_date,Yes,date,,,No,No,,,
CONCEPT_RELATIONSHIP,valid_end_date,Yes,date,,,No,No,,,
CONCEPT_RELATIONSHIP,invalid_reason,No,varchar(1),,,No,No,,,
RELATIONSHIP,relationship_id,Yes,varchar(20),,,Yes,No,,,
RELATIONSHIP,relationship_name,Yes,varchar(255),,,No,No,,,
RELATIONSHIP,is_hierarchical,Yes,varchar(1),,,No,No,,,
RELATIONSHIP,defines_ancestry,Yes,varchar(1),,,No,No,,,
RELATIONSHIP,reverse_relationship_id,Yes,varchar(20),,,No,No,,,
RELATIONSHIP,relationship_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_SYNONYM,concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_SYNONYM,concept_synonym_name,Yes,varchar(1000),,,No,No,,,
CONCEPT_SYNONYM,language_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_ANCESTOR,ancestor_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_ANCESTOR,descendant_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
CONCEPT_ANCESTOR,min_levels_of_separation,Yes,integer,,,No,No,,,
CONCEPT_ANCESTOR,max_levels_of_separation,Yes,integer,,,No,No,,,
SOURCE_TO_CONCEPT_MAP,source_code,Yes,varchar(50),,,No,No,,,
SOURCE_TO_CONCEPT_MAP,source_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SOURCE_TO_CONCEPT_MAP,source_vocabulary_id,Yes,varchar(20),,,No,No,,,
SOURCE_TO_CONCEPT_MAP,source_code_description,No,varchar(255),,,No,No,,,
SOURCE_TO_CONCEPT_MAP,target_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
SOURCE_TO_CONCEPT_MAP,target_vocabulary_id,Yes,varchar(20),,,No,Yes,VOCABULARY,VOCABULARY_ID,
SOURCE_TO_CONCEPT_MAP,valid_start_date,Yes,date,,,No,No,,,
SOURCE_TO_CONCEPT_MAP,valid_end_date,Yes,date,,,No,No,,,
SOURCE_TO_CONCEPT_MAP,invalid_reason,No,varchar(1),,,No,No,,,
DRUG_STRENGTH,drug_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_STRENGTH,ingredient_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_STRENGTH,amount_value,No,float,,,No,No,,,
DRUG_STRENGTH,amount_unit_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_STRENGTH,numerator_value,No,float,,,No,No,,,
DRUG_STRENGTH,numerator_unit_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_STRENGTH,denominator_value,No,float,,,No,No,,,
DRUG_STRENGTH,denominator_unit_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
DRUG_STRENGTH,box_size,No,integer,,,No,No,,,
DRUG_STRENGTH,valid_start_date,Yes,date,,,No,No,,,
DRUG_STRENGTH,valid_end_date,Yes,date,,,No,No,,,
DRUG_STRENGTH,invalid_reason,No,varchar(1),,,No,No,,,
COHORT_DEFINITION,cohort_definition_id,Yes,integer,,,No,No,,,
COHORT_DEFINITION,cohort_definition_name,Yes,varchar(255),,,No,No,,,
COHORT_DEFINITION,cohort_definition_description,No,varchar(MAX),,,No,No,,,
COHORT_DEFINITION,definition_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
COHORT_DEFINITION,cohort_definition_syntax,No,varchar(MAX),,,No,No,,,
COHORT_DEFINITION,subject_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
COHORT_DEFINITION,cohort_initiation_date,No,date,,,No,No,,,
ATTRIBUTE_DEFINITION,attribute_definition_id,Yes,integer,,,No,No,,,
ATTRIBUTE_DEFINITION,attribute_name,Yes,varchar(255),,,No,No,,,
ATTRIBUTE_DEFINITION,attribute_description,No,varchar(MAX),,,No,No,,,
ATTRIBUTE_DEFINITION,attribute_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,
ATTRIBUTE_DEFINITION,attribute_syntax,No,varchar(MAX),,,No,No,,,
1 cdmTableName cdmFieldName isRequired cdmDatatype userGuidance etlConventions isPrimaryKey isForeignKey fkTableName fkFieldName unique DQ identifiers
2 PERSON person_id Yes integer It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently. Any person linkage that needs to occur to uniquely identify Persons ought to be done prior to writing this table. This identifier can be the original id from the source data provided it is an integer, otherwise it can be an autogenerated number. Yes No
3 PERSON gender_concept_id Yes integer This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues. Use the gender or sex value present in the data under the assumption that it is the biological sex at birth. If the source data captures gender identity it should be stored in the OBSERVATION table. Accepted gender concepts. No Yes CONCEPT CONCEPT_ID
4 PERSON year_of_birth Yes integer For data sources with date of birth, the year should be extracted. For data sources where the year of birth is not available, the approximate year of birth could be derived based on age group categorization, if available. No No
5 PERSON month_of_birth No integer For data sources that provide the precise date of birth, the month should be extracted and stored in this field. No No
6 PERSON day_of_birth No integer For data sources that provide the precise date of birth, the day should be extracted and stored in this field. No No
7 PERSON birth_datetime No datetime Compute age using birth_datetime. For data sources that provide the precise datetime of birth, that value should be stored in this field. If birth_datetime is not provided in the source, use the following logic to infer the date: If day_of_birth is null and month_of_birth is not null then use the first of the month in that year. If month_of_birth is null or if day_of_birth AND month_of_birth are both null and the person has records during their year of birth then use the date of the earliest record, otherwise use the 15th of June of that year. If time of birth is not given use midnight (00:00:0000). No No
8 PERSON race_concept_id Yes integer This field captures race or ethnic background of the person. Only use this field if you have information about race or ethnic background. The Vocabulary contains Concepts about the main races and ethnic backgrounds in a hierarchical system. Due to the imprecise nature of human races and ethnic backgrounds, this is not a perfect system. Mixed races are not supported. If a clear race or ethnic background cannot be established, use Concept_Id 0. No Yes CONCEPT CONCEPT_ID
9 PERSON ethnicity_concept_id Yes integer This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between "Hispanic" and "Not Hispanic". Races and Ethnic backgrounds are not stored here. Only use this field if you have US-based data and a source of this information. Do not attempt to infer Ethnicity from the race or ethnic background of the Person. No Yes CONCEPT CONCEPT_ID
10 PERSON location_id No integer The location refers to the physical address of the person. This field should capture the last known location of the person. Any prior locations are captured in the LOCATION_HISTORY table. Put the location_id from the LOCATION table here that represents the most granular location information for the person. This could represent anything from postal code or parts thereof, state, or county for example. Since many databases contain deindentified data, it is common that the precision of the location is reduced to prevent re-identification. This field should capture the last known location. Any prior locations are captured in the LOCATION_HISTORY table. No Yes LOCATION LOCATION_ID
11 PERSON provider_id No integer The Provider refers to the last known primary care provider (General Practitioner). Put the provider_id from the PROVIDER table of the last known general practitioner of the person. If there are multiple providers, it is up to the business to decide which to put here. No Yes PROVIDER PROVIDER_ID
12 PERSON care_site_id No integer The Care Site refers to where the Provider typically provides the primary care. No Yes CARE_SITE CARE_SITE_ID
13 PERSON person_source_value No varchar(50) Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic. Some use cases require the ability to link back to persons in the source data. This field allows for the storing of the person value as it appears in the source. This field is not required but strongly recommended. No No
14 PERSON gender_source_value No varchar(50) This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only. Put the biological sex of the person as it appears in the source data. No No
15 PERSON gender_source_concept_id No Integer Due to the small number of options, this tends to be zero. If the source data codes biological sex in a non-standard vocabulary, store the concept_id here. No Yes CONCEPT CONCEPT_ID
16 PERSON race_source_value No varchar(50) This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only. Put the race of the person as it appears in the source data. No No
17 PERSON race_source_concept_id No Integer Due to the small number of options, this tends to be zero. If the source data codes race in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
18 PERSON ethnicity_source_value No varchar(50) This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only. If the person has an ethnicity other than the OMB standard of "Hispanic" or "Not Hispanic" store that value from the source data here. No No
19 PERSON ethnicity_source_concept_id No Integer Due to the small number of options, this tends to be zero. If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here. No Yes CONCEPT CONCEPT_ID
20 OBSERVATION_PERIOD observation_period_id Yes integer A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id. Assign a unique observation_period_id to each discrete Observation Period for a Person. Yes No
21 OBSERVATION_PERIOD person_id Yes integer The Person ID of the PERSON record for which the Observation Period is recorded. No Yes PERSON PERSON_ID
22 OBSERVATION_PERIOD observation_period_start_date Yes date Use this date to determine the start date of the Observation Period It is often the case that the idea of Observation Periods does not exist in source data. In those cases, the observation_period_start_date can be inferred as the earliest Event date available for the Person. In insurance claim data, the Observation Period can be considered as the time period the Person is enrolled with a payer. If a Person switches plans but stays with the same payer, and therefore capturing of data continues, that change would be captured in PAYER_PLAN_PERIOD. No No
23 OBSERVATION_PERIOD observation_period_end_date Yes date Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded. It is often the case that the idea of Observation Periods does not exist in source data. In those cases, the observation_period_end_date can be inferred as the last Event date available for the Person. In insurance claim data, the Observation Period can be considered as the time period the Person is enrolled with a payer. No No
24 OBSERVATION_PERIOD period_type_concept_id Yes Integer This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources. Choose the observation_period_type_concept_id that best represents how the period was determined. No Yes CONCEPT CONCEPT_ID
25 VISIT_OCCURRENCE visit_occurrence_id Yes integer Use this to identify unique interactions between a person and the health care system. This identifier links across the other CDM event tables to associate events with a visit. This should be populated by creating a unique identifier for each unique interaction between a person and the healthcare system where the person receives a medical good or service over a span of time. Yes No
26 VISIT_OCCURRENCE person_id Yes integer No Yes PERSON PERSON_ID
27 VISIT_OCCURRENCE visit_concept_id Yes integer This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain. Populate this field based on the kind of visit that took place for the person. For example this could be "Inpatient Visit", "Outpatient Visit", "Ambulatory Visit", etc. This table will contain standard concepts in the Visit domain. These concepts are arranged in a hierarchical structure to facilitate cohort definitions by rolling up to generally familiar Visits adopted in most healthcare systems worldwide. No Yes CONCEPT CONCEPT_ID
28 VISIT_OCCURRENCE visit_start_date Yes date For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same. When populating visit_start_date, you should think about the patient experience to make decisions on how to define visits. In the case of an inpatient visit this should be the date the patient was admitted to the hospital or institution. In all other cases this should be the date of the patient-provider interaction. No No
29 VISIT_OCCURRENCE visit_start_datetime No datetime If no time is given for the start date of a visit, set it to midnight (00:00:0000). No No
30 VISIT_OCCURRENCE visit_end_date Yes date For inpatient visits the end date is typically the discharge date. Visit end dates are mandatory. If end dates are not provided in the source there are three ways in which to derive them: Outpatient Visit: visit_end_datetime = visit_start_datetime Emergency Room Visit: visit_end_datetime = visit_start_datetime Inpatient Visit: Usually there is information about discharge. If not, you should be able to derive the end date from the sudden decline of activity or from the absence of inpatient procedures/drugs. Non-hospital institution Visits: Particularly for claims data, if end dates are not provided assume the visit is for the duration of month that it occurs. For Inpatient Visits ongoing at the date of ETL, put date of processing the data into visit_end_datetime and visit_type_concept_id with 32220 "Still patient" to identify the visit as incomplete. All other Visits: visit_end_datetime = visit_start_datetime. If this is a one-day visit the end date should match the start date. No No
31 VISIT_OCCURRENCE visit_end_datetime No datetime If no time is given for the end date of a visit, set it to midnight (00:00:0000). No No
32 VISIT_OCCURRENCE visit_type_concept_id Yes Integer Use this field to understand the provenance of the visit record, or where the record comes from. Populate this field based on the provenance of the visit record, as in whether it came from an EHR record or billing claim. No Yes CONCEPT CONCEPT_ID
33 VISIT_OCCURRENCE provider_id No integer There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table. If there are multiple providers associated with a visit, you will need to choose which one to put here. The additional providers can be stored in the visit_detail table. No Yes PROVIDER PROVIDER_ID
34 VISIT_OCCURRENCE care_site_id No integer This field provides information about the care site where the visit took place. There should only be one care site associated with a visit. No Yes CARE_SITE CARE_SITE_ID
35 VISIT_OCCURRENCE visit_source_value No varchar(50) This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.) If there is information about the kind of visit in the source data that value should be stored here. If a visit is an amalgamation of visits from the source then use a hierarchy to choose the visit source value, such as IP -> ER-> OP. This should line up with the logic chosen to determine how visits are created. No No
36 VISIT_OCCURRENCE visit_source_concept_id No integer If the visit source value is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here. No Yes CONCEPT CONCEPT_ID
37 VISIT_OCCURRENCE admitting_source_concept_id No integer Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example. If available, map the admitted_from_source_value to a standard concept in the visit domain. No Yes CONCEPT CONCEPT_ID
38 VISIT_OCCURRENCE admitting_source_value No varchar(50) This information may be called something different in the source data but the field is meant to contain a value indicating where a person was admitted from. Typically this applies only to visits that have a length of stay, like inpatient visits or long-term care visits. No No
39 VISIT_OCCURRENCE discharge_to_concept_id No integer Use this field to determine where the patient was discharged to after a visit. This concept is part of the visit domain and can indicate if a patient was discharged to home or sent to a long-term care facility, for example. If available, map the discharge_to_source_value to a standard concept in the visit domain. No Yes CONCEPT CONCEPT_ID
40 VISIT_OCCURRENCE discharge_to_source_value No varchar(50) This information may be called something different in the source data but the field is meant to contain a value indicating where a person was discharged to after a visit, as in they went home or were moved to long-term care. Typically this applies only to visits that have a length of stay of a day or more. No No
41 VISIT_OCCURRENCE preceding_visit_occurrence_id No integer Use this field to find the visit that occured for the person prior to the given visit. There could be a few days or a few years in between. The preceding_visit_id can be used to link a visit immediately preceding the current visit. Note this is not symmetrical, and there is no such thing as a "following_visit_id". No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
42 CONDITION_OCCURRENCE condition_occurrence_id Yes bigint The unique key given to a condition record for a person. Refer to the ETL for how duplicate conditions during the same visit were handled. Each instance of a condition present in the source data should be assigned this unique key. In some cases, a person can have multiple records of the same condition within the same visit. It is valid to keep these duplicates and assign them individual, unique, CONDITION_OCCURRENCE_IDs, though it is up to the ETL how they should be handled. Yes No
43 CONDITION_OCCURRENCE person_id Yes bigint The PERSON_ID of the PERSON for whom the condition is recorded. No Yes PERSON PERSON_ID
44 CONDITION_OCCURRENCE condition_concept_id Yes integer The CONDITION_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a condition The CONCEPT_ID that the CONDITION_SOURCE_VALUE maps to. Only records whose source values map to concepts with a domain of "Condition" should go in this table. No Yes CONCEPT CONCEPT_ID
45 CONDITION_OCCURRENCE condition_start_date Yes date Use this date to determine the start date of the condition Most often data sources do not have the idea of a start date for a condition. Rather, if a source only has one date associated with a condition record it is acceptable to use that date for both the CONDITION_START_DATE and the CONDITION_END_DATE. No No
46 CONDITION_OCCURRENCE condition_start_datetime No datetime If a source does not specify datetime the convention is to set the time to midnight (00:00:0000) No No
47 CONDITION_OCCURRENCE condition_end_date No date Use this date to determine the end date of the condition Most often data sources do not have the idea of a start date for a condition. Rather, if a source only has one date associated with a condition record it is acceptable to use that date for both the CONDITION_START_DATE and the CONDITION_END_DATE. No No
48 CONDITION_OCCURRENCE condition_end_datetime No datetime If a source does not specify datetime the convention is to set the time to midnight (00:00:0000) No No
49 CONDITION_OCCURRENCE condition_type_concept_id Yes integer This field can be used to determine the provenance of the Condition record, as in whether the condition was from an EHR system, insurance claim, registry, or other sources. Choose the condition_type_concept_id that best represents the provenance of the record. No Yes CONCEPT CONCEPT_ID
50 CONDITION_OCCURRENCE condition_status_concept_id No integer This concept represents the point during the visit the diagnosis was given (admitting diagnosis, final diagnosis), whether the diagnosis was determined due to laboratory findings, if the diagnosis was exclusionary, or if it was a preliminary diagnosis, among others. Presently, there is no designated vocabulary, domain, or class that represents condition status. The concepts with a relationship_id of "subsumes" with CONCEPT_ID 4021918 "Qualifier for type of diagnosis" should be used. These include admitting diagnosis, principal diagnosis, and secondary diagnosis. No Yes CONCEPT CONCEPT_ID
51 CONDITION_OCCURRENCE stop_reason No varchar(20) The Stop Reason indicates why a Condition is no longer valid with respect to the purpose within the source data. Note that a Stop Reason does not necessarily imply that the condition is no longer occurring. This information is often not populated in source data and it is a valid etl choice to leave it blank if the information does not exist. No No
52 CONDITION_OCCURRENCE provider_id No integer The provider associated with condition record. The ETL may need to make a choice as to which PROVIDER_ID to put here. Based on what is available this may or may not be different than the provider associated with the overall VISIT_OCCURRENCE record. No Yes PROVIDER PROVIDER_ID
53 CONDITION_OCCURRENCE visit_occurrence_id No integer The visit during which the condition was diagnosed. Depending on the structure of the source data, this may have to be determined based on dates. No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
54 CONDITION_OCCURRENCE visit_detail_id No integer The VISIT_DETAIL record during which the condition was diagnosed. For example, if the person was in the ICU at the time of the diagnosis the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit. No Yes VISIT_DETAIL VISIT_DETAIL_ID
55 CONDITION_OCCURRENCE condition_source_value No varchar(50) This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Condition necessary for a given analytic use case. Consider using CONDITION_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network. This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference. No No
56 CONDITION_OCCURRENCE condition_source_concept_id No integer If the CONDITION_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here. No Yes CONCEPT CONCEPT_ID
57 CONDITION_OCCURRENCE condition_status_source_value No varchar(50) This information may be called something different in the source data but the field is meant to contain a value indicating when and how a diagnosis was given to a patient. This source value is mapped to a standard concept which is stored in the CONDITION_STATUS_CONCEPT_ID field. No No
58 DRUG_EXPOSURE drug_exposure_id Yes bigint Use this to identify unique dispensings or administrations of a drug product to a person This should be populated by creating a unique identifier for each unique instance where a person receives a dispensing or administration of a drug. Yes No
59 DRUG_EXPOSURE person_id Yes bigint No Yes PERSON PERSON_ID
60 DRUG_EXPOSURE drug_concept_id Yes integer The DRUG_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a drug product or molecule otherwise introduced to the body. Map source values to standard concepts. All concepts in the DRUG_EXPOSURE table should be in the 'Drug' domain. No Yes CONCEPT CONCEPT_ID
61 DRUG_EXPOSURE drug_exposure_start_date Yes date Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration procedure was recorded. No No
62 DRUG_EXPOSURE drug_exposure_start_datetime No datetime If time is unknown set it to midnight. No No
63 DRUG_EXPOSURE drug_exposure_end_date Yes date The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient. This could be that the duration of DAYS_SUPPLY was reached, or because the exposure was stopped (medication changed, medication discontinued, etc.). To populate this field, start first with DAYS_SUPPLY using the calculation DRUG_EXPOSURE_END_DATE = DRUG_EXPOSURE_START_DATE + DAYS_SUPPLY -1 day. If DAYS_SUPPLY is not available then use the VERBATIM_END_DATE as it is given in the source data. If there is no verbatim end date then set DRUG_EXPOSURE_END_DATE equal to DRUG_EXPOSURE_START_DATE. When the native data suggests a drug exposure has a days supply less than 0, drop the record as it is unknown if a person has received the drug or not (THEMIS issue #24). If a patient has multiple records on the same day for the same drug or procedures the ETL should not de-dupe them unless there is probable reason to believe the item is a true data duplicate (THEMIS issue #14). Depending on different sources, it could be a known or an inferred date and denotes the last day at which the patient was still exposed to Drug. No No
64 DRUG_EXPOSURE drug_exposure_end_datetime No datetime If time is unknown set it to midnight. No No
65 DRUG_EXPOSURE verbatim_end_date No date This is the end date as it appears in the source data, if it is given. Put the end date for the drug exposure as it appears in the source data. This may or may not be the same as DRUG_EXPOSURE_END_DATE given the logic for assigning DRUG_EXPOSURE_END_DATE. No No
66 DRUG_EXPOSURE drug_type_concept_id Yes integer You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure This field is meant to preserve the provenance of the record. Any standard concepts in the 'Type Concept' domain are valid here. No Yes CONCEPT CONCEPT_ID
67 DRUG_EXPOSURE stop_reason No varchar(20) Reason a person stopped a medication. Reasons include regimen completed, changed, removed, etc. No No
68 DRUG_EXPOSURE refills No integer The content of the refills field determines the current refill number, not the number of remaining refills. For example, for a drug prescription with 2 refills, the content of this field for the 3 Drug Exposure events are null, 1 and 2. No No
69 DRUG_EXPOSURE quantity No float No No
70 DRUG_EXPOSURE days_supply No integer No No
71 DRUG_EXPOSURE sig No varchar(MAX) (and printed on the container) No No
72 DRUG_EXPOSURE route_concept_id No integer Route information can also be inferred from the Drug product itself by determining the Drug Form of the Concept, creating some partial overlap of the same type of information. Therefore, route information should be stored in DRUG_CONCEPT_ID (as a drug with corresponding Dose Form). The ROUTE_CONCEPT_ID could be used for storing more granular forms e.g. 'Intraventricular cardiac'. No Yes CONCEPT CONCEPT_ID
73 DRUG_EXPOSURE lot_number No varchar(50) No No
74 DRUG_EXPOSURE provider_id No integer No Yes PROVIDER PROVIDER_ID
75 DRUG_EXPOSURE visit_occurrence_id No integer No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
76 DRUG_EXPOSURE visit_detail_id No integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
77 DRUG_EXPOSURE drug_source_value No varchar(50) This code is mapped to a Standard Drug concept in the Standardized Vocabularies and the original code is, stored here for reference. No No
78 DRUG_EXPOSURE drug_source_concept_id No integer No Yes CONCEPT CONCEPT_ID
79 DRUG_EXPOSURE route_source_value No varchar(50) No No
80 DRUG_EXPOSURE dose_unit_source_value No varchar(50) No No
81 PROCEDURE_OCCURRENCE procedure_occurrence_id Yes integer Yes No
82 PROCEDURE_OCCURRENCE person_id Yes integer No Yes PERSON PERSON_ID
83 PROCEDURE_OCCURRENCE procedure_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
84 PROCEDURE_OCCURRENCE procedure_date Yes date No No
85 PROCEDURE_OCCURRENCE procedure_datetime No datetime No No
86 PROCEDURE_OCCURRENCE procedure_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
87 PROCEDURE_OCCURRENCE modifier_concept_id No integer These concepts are typically distinguished by 'Modifier' concept classes (e.g., 'CPT4 Modifier' as part of the 'CPT4' vocabulary). No Yes CONCEPT CONCEPT_ID
88 PROCEDURE_OCCURRENCE quantity No integer If the quantity value is omitted, a single procedure is assumed. If a Procedure has a quantity of '0' in the source, this should default to '1' in the ETL. If there is a record in the source it can be assumed the exposure occurred at least once (THEMIS issue #26). No No
89 PROCEDURE_OCCURRENCE provider_id No integer No No PROVIDER PROVIDER_ID
90 PROCEDURE_OCCURRENCE visit_occurrence_id No integer No No VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
91 PROCEDURE_OCCURRENCE visit_detail_id No integer No No VISIT_DETAIL VISIT_DETAIL_ID
92 PROCEDURE_OCCURRENCE procedure_source_value No varchar(50) This code is mapped to a standard procedure Concept in the Standardized Vocabularies and the original code is, stored here for reference. Procedure source codes are typically ICD-9-Proc, CPT-4, HCPCS or OPCS-4 codes. No No
93 PROCEDURE_OCCURRENCE procedure_source_concept_id No integer No No CONCEPT CONCEPT_ID
94 PROCEDURE_OCCURRENCE modifier_source_value No varchar(50) No No
95 DEVICE_EXPOSURE device_exposure_id Yes bigint Yes No
96 DEVICE_EXPOSURE person_id Yes bigint No Yes PERSON PERSON_ID
97 DEVICE_EXPOSURE device_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
98 DEVICE_EXPOSURE device_exposure_start_date Yes date No No
99 DEVICE_EXPOSURE device_exposure_start_datetime No datetime No No
100 DEVICE_EXPOSURE device_exposure_end_date No date No No
101 DEVICE_EXPOSURE device_exposure_end_datetime No datetime No No
102 DEVICE_EXPOSURE device_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
103 DEVICE_EXPOSURE unique_device_id No varchar(50) For medical devices that are regulated by the FDA, a Unique Device Identification (UDI) is provided if available in the data source and is recorded in the UNIQUE_DEVICE_ID field. No No
104 DEVICE_EXPOSURE quantity No integer No No
105 DEVICE_EXPOSURE provider_id No integer No Yes PROVIDER PROVIDER_ID
106 DEVICE_EXPOSURE visit_occurrence_id No integer No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
107 DEVICE_EXPOSURE visit_detail_id No integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
108 DEVICE_EXPOSURE device_source_value No varchar(50) No No
109 DEVICE_EXPOSURE device_source_concept_id No integer No Yes CONCEPT CONCEPT_ID
110 MEASUREMENT measurement_id Yes integer Yes No
111 MEASUREMENT person_id Yes integer No Yes PERSON PERSON_ID
112 MEASUREMENT measurement_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
113 MEASUREMENT measurement_date Yes date No No
114 MEASUREMENT measurement_datetime No datetime No No
115 MEASUREMENT measurement_time No varchar(10) This is present for backwards compatibility and will be deprecated in an upcoming version No No
116 MEASUREMENT measurement_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
117 MEASUREMENT operator_concept_id No integer The meaning of Concept 4172703 for '=' is identical to omission of a OPERATOR_CONCEPT_ID value. Since the use of this field is rare, it's important when devising analyses to not to forget testing for the content of this field for values different from =. If there is a negative value coming from the source, set the VALUE_AS_NUMBER to NULL, with the exception of the following Measurements (listed as LOINC codes): 1925-7 Base excess in Arterial blood by calculation 1927-3 Base excess in Venous blood by calculation Operators are <, <=, =, >=, > and these concepts belong to the 'Meas Value Operator' domain. 8632-2 QRS-Axis 11555-0 Base excess in Blood by calculation 1926-5 Base excess in Capillary blood by calculation 28638-5 Base excess in Arterial cord blood by calculation 28639-3 Base excess in Venous cord blood by calculation THEMIS issue #16 No Yes CONCEPT CONCEPT_ID
118 MEASUREMENT value_as_number No float No No
119 MEASUREMENT value_as_concept_id No integer No Yes CONCEPT CONCEPT_ID
120 MEASUREMENT unit_concept_id No integer No Yes CONCEPT CONCEPT_ID
121 MEASUREMENT range_low No float Ranges have the same unit as the VALUE_AS_NUMBER. If reference ranges for upper and lower limit of normal as provided (typically by a laboratory) these are stored in the RANGE_HIGH and RANGE_LOW fields. Ranges have the same unit as the VALUE_AS_NUMBER. No No
122 MEASUREMENT range_high No float Ranges have the same unit as the VALUE_AS_NUMBER. No No
123 MEASUREMENT provider_id No integer No Yes PROVIDER PROVIDER_ID
124 MEASUREMENT visit_occurrence_id No integer No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
125 MEASUREMENT visit_detail_id No integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
126 MEASUREMENT measurement_source_value No varchar(50) No No
127 MEASUREMENT measurement_source_concept_id No integer No Yes CONCEPT CONCEPT_ID
128 MEASUREMENT unit_source_value No varchar(50) No No
129 MEASUREMENT value_source_value No varchar(50) No No
130 VISIT_DETAIL visit_detail_id Yes integer Yes No
131 VISIT_DETAIL person_id Yes integer No Yes PERSON PERSON_ID
132 VISIT_DETAIL visit_detail_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
133 VISIT_DETAIL visit_detail_start_date Yes date No No
134 VISIT_DETAIL visit_detail_start_datetime No datetime No No
135 VISIT_DETAIL visit_detail_end_date Yes date No No
136 VISIT_DETAIL visit_detail_end_datetime No datetime No No
137 VISIT_DETAIL visit_detail_type_concept_id Yes Integer No Yes CONCEPT CONCEPT_ID
138 VISIT_DETAIL provider_id No integer No Yes PROVIDER PROVIDER_ID
139 VISIT_DETAIL care_site_id No integer No Yes CARE_SITE CARE_SITE_ID
140 VISIT_DETAIL visit_detail_source_value No string(50) No No
141 VISIT_DETAIL visit_detail_source_concept_id No Integer No Yes CONCEPT CONCEPT_ID
142 VISIT_DETAIL admitting_source_value No Varchar(50) No No
143 VISIT_DETAIL admitting_source_concept_id No Integer No Yes CONCEPT CONCEPT_ID
144 VISIT_DETAIL discharge_to_source_value No Varchar(50) No No
145 VISIT_DETAIL discharge_to_concept_id No Integer No Yes CONCEPT CONCEPT_ID
146 VISIT_DETAIL preceding_visit_detail_id No Integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
147 VISIT_DETAIL visit_detail_parent_id No Integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
148 VISIT_DETAIL visit_occurrence_id Yes Integer No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
149 NOTE note_id Yes integer Yes No
150 NOTE person_id Yes integer No Yes PERSON PERSON_ID
151 NOTE note_date Yes date No No
152 NOTE note_datetime No datetime No No
153 NOTE note_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
154 NOTE note_class_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
155 NOTE note_title No varchar(250) No No
156 NOTE note_text Yes varchar(MAX) No No
157 NOTE encoding_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
158 NOTE language_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
159 NOTE provider_id No integer No Yes PROVIDER PROVIDER_ID
160 NOTE visit_occurrence_id No integer No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
161 NOTE visit_detail_id No integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
162 NOTE note_source_value No varchar(50) No No
163 NOTE_NLP note_nlp_id Yes integer Yes No
164 NOTE_NLP note_id Yes integer No No
165 NOTE_NLP section_concept_id No integer No Yes CONCEPT CONCEPT_ID
166 NOTE_NLP snippet No varchar(250) No No
167 NOTE_NLP offset No varchar(50) No No
168 NOTE_NLP lexical_variant Yes varchar(250) No No
169 NOTE_NLP note_nlp_concept_id No integer No Yes CONCEPT CONCEPT_ID
170 NOTE_NLP note_nlp_source_concept_id No integer No Yes CONCEPT CONCEPT_ID
171 NOTE_NLP nlp_system No varchar(250) No No
172 NOTE_NLP nlp_date Yes date No No
173 NOTE_NLP nlp_datetime No datetime No No
174 NOTE_NLP term_exists No varchar(1) Term_exists is defined as a flag that indicates if the patient actually has or had the condition. Any of the following modifiers would make Term_exists false: Negation = true Subject = [anything other than the patient] Conditional = true/li> Rule_out = true Uncertain = very low certainty or any lower certainties A complete lack of modifiers would make Term_exists true. No No
175 NOTE_NLP term_temporal No varchar(50) Term_temporal is to indicate if a condition is �present� or just in the �past�. The following would be past: History = true Concept_date = anything before the time of the report No No
176 NOTE_NLP term_modifiers No varchar(2000) For the modifiers that are there, they would have to have these values: Negation = false Subject = patient Conditional = false Rule_out = false Uncertain = true or high or moderate or even low (could argue about low). Term_modifiers will concatenate all modifiers for different types of entities (conditions, drugs, labs etc) into one string. Lab values will be saved as one of the modifiers. A list of allowable modifiers (e.g., signature for medications) and their possible values will be standardized later. No No
177 OBSERVATION observation_id Yes integer Yes No
178 OBSERVATION person_id Yes integer No Yes PERSON PERSON_ID
179 OBSERVATION observation_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
180 OBSERVATION observation_date Yes date No No
181 OBSERVATION observation_datetime No datetime No No
182 OBSERVATION observation_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
183 OBSERVATION value_as_number No float No No
184 OBSERVATION value_as_string No varchar(60) No No
185 OBSERVATION value_as_concept_id No Integer Note that the value of VALUE_AS_CONCEPT_ID may be provided through mapping from a source Concept which contains the content of the Observation. In those situations, the CONCEPT_RELATIONSHIP table in addition to the 'Maps to' record contains a second record with the relationship_id set to 'Maps to value'. For example, ICD9CM V17.5 concept_id 44828510 'Family history of asthma' has a 'Maps to' relationship to 4167217 'Family history of clinical finding' as well as a 'Maps to value' record to 317009 'Asthma'. No Yes CONCEPT CONCEPT_ID
186 OBSERVATION qualifier_concept_id No integer No Yes CONCEPT CONCEPT_ID
187 OBSERVATION unit_concept_id No integer No Yes CONCEPT CONCEPT_ID
188 OBSERVATION provider_id No integer No Yes PROVIDER PROVIDER_ID
189 OBSERVATION visit_occurrence_id No integer No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
190 OBSERVATION visit_detail_id No integer No Yes VISIT_DETAIL VISIT_DETAIL_ID
191 OBSERVATION observation_source_value No varchar(50) No No
192 OBSERVATION observation_source_concept_id No integer No Yes CONCEPT CONCEPT_ID
193 OBSERVATION unit_source_value No varchar(50) No No
194 OBSERVATION qualifier_source_value No varchar(50) No No
195 SPECIMEN specimen_id Yes integer Yes No
196 SPECIMEN person_id Yes integer No Yes PERSON PERSON_ID
197 SPECIMEN specimen_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
198 SPECIMEN specimen_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
199 SPECIMEN specimen_date Yes date No No
200 SPECIMEN specimen_datetime No datetime No No
201 SPECIMEN quantity No float No No
202 SPECIMEN unit_concept_id No integer No Yes CONCEPT CONCEPT_ID
203 SPECIMEN anatomic_site_concept_id No integer No Yes CONCEPT CONCEPT_ID
204 SPECIMEN disease_status_concept_id No integer No Yes CONCEPT CONCEPT_ID
205 SPECIMEN specimen_source_id No varchar(50) No No
206 SPECIMEN specimen_source_value No varchar(50) No No
207 SPECIMEN unit_source_value No varchar(50) No No
208 SPECIMEN anatomic_site_source_value No varchar(50) No No
209 SPECIMEN disease_status_source_value No varchar(50) No No
210 FACT_RELATIONSHIP domain_concept_id_1 Yes integer No Yes CONCEPT CONCEPT_ID
211 FACT_RELATIONSHIP fact_id_1 Yes integer No No
212 FACT_RELATIONSHIP domain_concept_id_2 Yes integer No Yes CONCEPT CONCEPT_ID
213 FACT_RELATIONSHIP fact_id_2 Yes integer No No
214 FACT_RELATIONSHIP relationship_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
215 LOCATION location_id Yes integer Yes No
216 LOCATION address_1 No varchar(50) No No
217 LOCATION address_2 No varchar(50) No No
218 LOCATION city No varchar(50) No No
219 LOCATION state No varchar(2) No No
220 LOCATION zip No varchar(9) Zip codes are handled as strings of up to 9 characters length. For US addresses, these represent either a 3-digit abbreviated Zip code as provided by many sources for patient protection reasons, the full 5-digit Zip or the 9-digit (ZIP + 4) codes. Unless for specific reasons analytical methods should expect and utilize only the first 3 digits. For international addresses, different rules apply. No No
221 LOCATION county No varchar(20) No No
222 LOCATION location_source_value No varchar(50) No No
223 CARE_SITE care_site_id Yes integer Assign an id to each unique combination of location_id and place_of_service_source_value Yes No
224 CARE_SITE care_site_name No varchar(255) The name of the care_site as it appears in the source data No No
225 CARE_SITE place_of_service_concept_id No integer This is a high-level way of characterizing a Care Site. Typically, however, Care Sites can provide care in multiple settings (inpatient, outpatient, etc.) and this granularity should be reflected in the visit. Choose the concept in the visit domain that best represents the setting in which healthcare is provided in the Care Site. If most visits in a Care Site are Inpatient, then the place_of_service_concept_id should represent Inpatient. If information is present about a unique Care Site (e.g. Pharmacy) then a Care Site record should be created. No Yes CONCEPT CONCEPT_ID
226 CARE_SITE location_id No integer The location_id from the LOCATION table representing the physical location of the care_site. No Yes LOCATION LOCATION_ID
227 CARE_SITE care_site_source_value No varchar(50) The identifier of the care_site as it appears in the source data. This could be an identifier separate from the name of the care_site. No No
228 CARE_SITE place_of_service_source_value No varchar(50) Put the place of service of the care_site as it appears in the source data. No No
229 PROVIDER provider_id Yes integer It is assumed that every provider with a different unique identifier is in fact a different person and should be treated independently. This identifier can be the original id from the source data provided it is an integer, otherwise it can be an autogenerated number. Yes No
230 PROVIDER provider_name No varchar(255) This field is not necessary as it is not necessary to have the actual identity of the Provider. Rather, the idea is to uniquely and anonymously identify providers of care across the database. No No
231 PROVIDER npi No varchar(20) This is the National Provider Number issued to health care providers in the US by the Centers for Medicare and Medicaid Services (CMS). No No
232 PROVIDER dea No varchar(20) This is the identifier issued by the DEA, a US federal agency, that allows a provider to write prescriptions for controlled substances. No No
233 PROVIDER specialty_concept_id No integer This field either represents the most common specialty that occurs in the data or the most specific concept that represents all specialties listed, should the provider have more than one. This includes physician specialties such as internal medicine, emergency medicine, etc. and allied health professionals such as nurses, midwives, and pharmacists. If a Provider has more than one Specialty, there are two options: 1. Choose a concept_id which is a common ancestor to the multiple specialties, or, 2. Choose the specialty that occurs most often for the provider. Concepts in this field should be Standard with a domain of Provider. No Yes CONCEPT CONCEPT_ID
234 PROVIDER care_site_id No integer This is the CARE_SITE_ID for the location that the provider primarily practices in. If a Provider has more than one Care Site, the main or most often exerted CARE_SITE_ID should be recorded. No Yes CARE_SITE CARE_SITE_ID
235 PROVIDER year_of_birth No integer No No
236 PROVIDER gender_concept_id No integer This field represents the recorded gender of the provider in the source data. If given, put a concept from the gender domain representing the recorded gender of the provider. No Yes CONCEPT CONCEPT_ID
237 PROVIDER provider_source_value No varchar(50) Use this field to link back to providers in the source data. This is typically used for error checking of ETL logic. Some use cases require the ability to link back to providers in the source data. This field allows for the storing of the provider identifier as it appears in the source. No No
238 PROVIDER specialty_source_value No varchar(50) This is the kind of provider or specialty as it appears in the source data. This includes physician specialties such as internal medicine, emergency medicine, etc. and allied health professionals such as nurses, midwives, and pharmacists. Put the kind of provider as it appears in the source data. This field is up to the discretion of the ETL-er as to whether this should be the coded value from the source or the text description of the lookup value. No No
239 PROVIDER specialty_source_concept_id No integer This is often zero as many sites use propietary codes to store physician speciality. If the source data codes provider specialty in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
240 PROVIDER gender_source_value No varchar(50) This is provider's gender as it appears in the source data. Put the provider's gender as it appears in the source data. This field is up to the discretion of the ETL-er as to whether this should be the coded value from the source or the text description of the lookup value. No No
241 PROVIDER gender_source_concept_id No integer This is often zero as many sites use propietary codes to store provider gender. If the source data codes provider gender in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
242 PAYER_PLAN_PERIOD payer_plan_period_id Yes integer A unique identifier for each unique combination of a Person, Payer, Plan, and Period of time. Yes Yes PERSON PERSON_ID
243 PAYER_PLAN_PERIOD person_id Yes integer The Person covered by the Plan. A single Person can have multiple, overlapping, PAYER_PLAN_PERIOD records No Yes PERSON PERSON_ID
244 PAYER_PLAN_PERIOD payer_plan_period_start_date Yes date Start date of Plan coverage. No No
245 PAYER_PLAN_PERIOD payer_plan_period_end_date Yes date End date of Plan coverage. No No
246 PAYER_PLAN_PERIOD payer_concept_id No integer This field represents the organization who reimburses the provider which administers care to the Person. Map the Payer directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. The point is to stratify on this information and identify if Persons have the same payer, though the name of the Payer is not necessary. No Yes CONCEPT CONCEPT_ID
247 PAYER_PLAN_PERIOD payer_source_value No varchar(50) This is the Payer as it appears in the source data. No No
248 PAYER_PLAN_PERIOD payer_source_concept_id No integer If the source data codes the Payer in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
249 PAYER_PLAN_PERIOD plan_concept_id No integer This field represents the specific health benefit Plan the Person is enrolled in. Map the Plan directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. The point is to stratify on this information and identify if Persons have the same health benefit Plan though the name of the Plan is not necessary. No Yes CONCEPT CONCEPT_ID
250 PAYER_PLAN_PERIOD plan_source_value No varchar(50) This is the health benefit Plan of the Person as it appears in the source data. No No
251 PAYER_PLAN_PERIOD plan_source_concept_id No integer If the source data codes the Plan in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
252 PAYER_PLAN_PERIOD sponsor_concept_id No integer This field represents the sponsor of the Plan who finances the Plan. This includes self-insured, small group health plan and large group health plan. Map the sponsor directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. The point is to stratify on this information and identify if Persons have the same sponsor though the name of the sponsor is not necessary. No Yes CONCEPT CONCEPT_ID
253 PAYER_PLAN_PERIOD sponsor_source_value No varchar(50) The Plan sponsor as it appears in the source data. No No
254 PAYER_PLAN_PERIOD sponsor_source_concept_id No integer If the source data codes the sponsor in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
255 PAYER_PLAN_PERIOD family_source_value No varchar(50) The common identifier for all people (often a family) that covered by the same policy. Often these are the common digits of the enrollment id of the policy members. No No
256 PAYER_PLAN_PERIOD stop_reason_concept_id No integer This field represents the reason the Person left the Plan, if known. Map the stop reason directly to a standard CONCEPT_ID. If one does not exists please contact the vocabulary team. There is no global controlled vocabulary available for this information. No Yes CONCEPT CONCEPT_ID
257 PAYER_PLAN_PERIOD stop_reason_source_value No varchar(50) The Plan stop reason as it appears in the source data. No No
258 PAYER_PLAN_PERIOD stop_reason_source_concept_id No integer If the source data codes the stop reason in an OMOP supported vocabulary store the concept_id here. No Yes CONCEPT CONCEPT_ID
259 COST cost_id Yes INTEGER Yes No
260 COST cost_event_id Yes INTEGER No No
261 COST cost_domain_id Yes VARCHAR(20) No Yes DOMAIN DOMAIN_ID
262 COST cost_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
263 COST currency_concept_id No integer No Yes CONCEPT CONCEPT_ID
264 COST total_charge No FLOAT No No
265 COST total_cost No FLOAT No No
266 COST total_paid No FLOAT No No
267 COST paid_by_payer No FLOAT No No
268 COST paid_by_patient No FLOAT No No
269 COST paid_patient_copay No FLOAT No Yes CONCEPT CONCEPT_ID
270 COST paid_patient_coinsurance No FLOAT No No
271 COST paid_patient_deductible No FLOAT No No
272 COST paid_by_primary No FLOAT No No
273 COST paid_ingredient_cost No FLOAT No No
274 COST paid_dispensing_fee No FLOAT No No
275 COST payer_plan_period_id No INTEGER No No
276 COST amount_allowed No FLOAT No No
277 COST revenue_code_concept_id No integer No Yes CONCEPT CONCEPT_ID
278 COST revenue_code_source_value No VARCHAR(50) Revenue codes are a method to charge for a class of procedures and conditions in the U.S. hospital system. No No
279 COST drg_concept_id No integer No Yes CONCEPT CONCEPT_ID
280 COST drg_source_value No VARCHAR(3) Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups. No No
281 DRUG_ERA drug_era_id Yes integer Yes No
282 DRUG_ERA person_id Yes integer No Yes PERSON PERSON_ID
283 DRUG_ERA drug_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
284 DRUG_ERA drug_era_start_date Yes datetime The Drug Era Start Date is the start date of the first Drug Exposure for a given ingredient. (NOT RIGHT) No No
285 DRUG_ERA drug_era_end_date Yes datetime The Drug Era End Date is the end date of the last Drug Exposure. The End Date of each Drug Exposure is either taken from the field drug_exposure_end_date or, as it is typically not available, inferred using the following rules: For pharmacy prescription data, the date when the drug was dispensed plus the number of days of supply are used to extrapolate the End Date for the Drug Exposure. Depending on the country-specific healthcare system, this supply information is either explicitly provided in the day_supply field or inferred from package size or similar information. For Procedure Drugs, usually the drug is administered on a single date (i.e., the administration date). A standard Persistence Window of 30 days (gap, slack) is permitted between two subsequent such extrapolated DRUG_EXPOSURE records to be considered to be merged into a single Drug Era. (ARENT WE REQUIRING TO USE DRUG_EXPOSURE_END_DATE NOW????) No No
286 DRUG_ERA drug_exposure_count No integer No No
287 DRUG_ERA gap_days No integer The Gap Days determine how many total drug-free days are observed between all Drug Exposure events that contribute to a DRUG_ERA record. It is assumed that the drugs are "not stockpiled" by the patient, i.e. that if a new drug prescription or refill is observed (a new DRUG_EXPOSURE record is written), the remaining supply from the previous events is abandoned. The difference between Persistence Window and Gap Days is that the former is the maximum drug-free time allowed between two subsequent DRUG_EXPOSURE records, while the latter is the sum of actual drug-free days for the given Drug Era under the above assumption of non-stockpiling. No No
288 DOSE_ERA dose_era_id Yes integer Yes No
289 DOSE_ERA person_id Yes integer No Yes PERSON PERSON_ID
290 DOSE_ERA drug_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
291 DOSE_ERA unit_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
292 DOSE_ERA dose_value Yes float No No
293 DOSE_ERA dose_era_start_date Yes datetime No No
294 DOSE_ERA dose_era_end_date Yes datetime No No
295 CONDITION_ERA condition_era_id Yes integer Yes No
296 CONDITION_ERA person_id Yes integer No No PERSON PERSON_ID
297 CONDITION_ERA condition_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
298 CONDITION_ERA condition_era_start_date Yes datetime No No
299 CONDITION_ERA condition_era_end_date Yes datetime No No
300 CONDITION_ERA condition_occurrence_count No integer No No
301 CONCEPT concept_id Yes integer Yes No
302 CONCEPT concept_name Yes varchar(255) No No
303 CONCEPT domain_id Yes varchar(20) No Yes DOMAIN DOMAIN_ID
304 CONCEPT vocabulary_id Yes varchar(20) No Yes VOCABULARY VOCABULARY_ID
305 CONCEPT concept_class_id Yes varchar(20) No Yes CONCEPT_CLASS CONCEPT_CLASS_ID
306 CONCEPT standard_concept No varchar(1) No No
307 CONCEPT concept_code Yes varchar(50) No No
308 CONCEPT valid_start_date Yes date No No
309 CONCEPT valid_end_date Yes date No No
310 CONCEPT invalid_reason No varchar(1) No No
311 VOCABULARY vocabulary_id Yes varchar(20) Yes No
312 VOCABULARY vocabulary_name Yes varchar(255) No No
313 VOCABULARY vocabulary_reference Yes varchar(255) No No
314 VOCABULARY vocabulary_version No varchar(255) No No
315 VOCABULARY vocabulary_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
316 DOMAIN domain_id Yes varchar(20) Yes No
317 DOMAIN domain_name Yes varchar(255) No No
318 DOMAIN domain_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
319 CONCEPT_CLASS concept_class_id Yes varchar(20) Yes No
320 CONCEPT_CLASS concept_class_name Yes varchar(255) No No
321 CONCEPT_CLASS concept_class_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
322 CONCEPT_RELATIONSHIP concept_id_1 Yes integer No Yes CONCEPT CONCEPT_ID
323 CONCEPT_RELATIONSHIP concept_id_2 Yes integer No Yes CONCEPT CONCEPT_ID
324 CONCEPT_RELATIONSHIP relationship_id Yes varchar(20) No Yes RELATIONSHIP RELATIONSHIP_ID
325 CONCEPT_RELATIONSHIP valid_start_date Yes date No No
326 CONCEPT_RELATIONSHIP valid_end_date Yes date No No
327 CONCEPT_RELATIONSHIP invalid_reason No varchar(1) No No
328 RELATIONSHIP relationship_id Yes varchar(20) Yes No
329 RELATIONSHIP relationship_name Yes varchar(255) No No
330 RELATIONSHIP is_hierarchical Yes varchar(1) No No
331 RELATIONSHIP defines_ancestry Yes varchar(1) No No
332 RELATIONSHIP reverse_relationship_id Yes varchar(20) No No
333 RELATIONSHIP relationship_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
334 CONCEPT_SYNONYM concept_id Yes integer No Yes CONCEPT CONCEPT_ID
335 CONCEPT_SYNONYM concept_synonym_name Yes varchar(1000) No No
336 CONCEPT_SYNONYM language_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
337 CONCEPT_ANCESTOR ancestor_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
338 CONCEPT_ANCESTOR descendant_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
339 CONCEPT_ANCESTOR min_levels_of_separation Yes integer No No
340 CONCEPT_ANCESTOR max_levels_of_separation Yes integer No No
341 SOURCE_TO_CONCEPT_MAP source_code Yes varchar(50) No No
342 SOURCE_TO_CONCEPT_MAP source_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
343 SOURCE_TO_CONCEPT_MAP source_vocabulary_id Yes varchar(20) No No
344 SOURCE_TO_CONCEPT_MAP source_code_description No varchar(255) No No
345 SOURCE_TO_CONCEPT_MAP target_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
346 SOURCE_TO_CONCEPT_MAP target_vocabulary_id Yes varchar(20) No Yes VOCABULARY VOCABULARY_ID
347 SOURCE_TO_CONCEPT_MAP valid_start_date Yes date No No
348 SOURCE_TO_CONCEPT_MAP valid_end_date Yes date No No
349 SOURCE_TO_CONCEPT_MAP invalid_reason No varchar(1) No No
350 DRUG_STRENGTH drug_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
351 DRUG_STRENGTH ingredient_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
352 DRUG_STRENGTH amount_value No float No No
353 DRUG_STRENGTH amount_unit_concept_id No integer No Yes CONCEPT CONCEPT_ID
354 DRUG_STRENGTH numerator_value No float No No
355 DRUG_STRENGTH numerator_unit_concept_id No integer No Yes CONCEPT CONCEPT_ID
356 DRUG_STRENGTH denominator_value No float No No
357 DRUG_STRENGTH denominator_unit_concept_id No integer No Yes CONCEPT CONCEPT_ID
358 DRUG_STRENGTH box_size No integer No No
359 DRUG_STRENGTH valid_start_date Yes date No No
360 DRUG_STRENGTH valid_end_date Yes date No No
361 DRUG_STRENGTH invalid_reason No varchar(1) No No
362 COHORT_DEFINITION cohort_definition_id Yes integer No No
363 COHORT_DEFINITION cohort_definition_name Yes varchar(255) No No
364 COHORT_DEFINITION cohort_definition_description No varchar(MAX) No No
365 COHORT_DEFINITION definition_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
366 COHORT_DEFINITION cohort_definition_syntax No varchar(MAX) No No
367 COHORT_DEFINITION subject_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
368 COHORT_DEFINITION cohort_initiation_date No date No No
369 ATTRIBUTE_DEFINITION attribute_definition_id Yes integer No No
370 ATTRIBUTE_DEFINITION attribute_name Yes varchar(255) No No
371 ATTRIBUTE_DEFINITION attribute_description No varchar(MAX) No No
372 ATTRIBUTE_DEFINITION attribute_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
373 ATTRIBUTE_DEFINITION attribute_syntax No varchar(MAX) No No

View File

@ -1,408 +0,0 @@
"","field","required","type","description","table","schema"
"1","condition_occurrence_id","Yes","INTEGER","A unique identifier for each Condition Occurrence event.","condition_occurrence","cdm"
"2","person_id","Yes","INTEGER","A foreign key identifier to the Person who is experiencing the condition. The demographic details of that Person are stored in the PERSON table.","condition_occurrence","cdm"
"3","condition_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Condition Concept identifier in the Standardized Vocabularies.","condition_occurrence","cdm"
"4","condition_start_date","Yes","DATE","The date when the instance of the Condition is recorded.","condition_occurrence","cdm"
"5","condition_start_datetime","No","DATETIME","The date and time when the instance of the Condition is recorded.","condition_occurrence","cdm"
"6","condition_end_date","No","DATE","The date when the instance of the Condition is considered to have ended.","condition_occurrence","cdm"
"7","condition_end_datetime","No","DATE","The date when the instance of the Condition is considered to have ended.","condition_occurrence","cdm"
"8","condition_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the source data from which the condition was recorded, the level of standardization, and the type of occurrence.","condition_occurrence","cdm"
"9","stop_reason","No","VARCHAR(20)","The reason that the condition was no longer present, as indicated in the source data.","condition_occurrence","cdm"
"10","provider_id","No","INTEGER","A foreign key to the Provider in the PROVIDER table who was responsible for capturing (diagnosing) the Condition.","condition_occurrence","cdm"
"11","visit_occurrence_id","No","INTEGER","A foreign key to the visit in the VISIT_OCCURRENCE table during which the Condition was determined (diagnosed).","condition_occurrence","cdm"
"12","visit_detail_id","No","INTEGER","A foreign key to the visit in the VISIT_DETAIL table during which the Condition was determined (diagnosed).","condition_occurrence","cdm"
"13","condition_source_value","No","VARCHAR(50)","The source code for the condition as it appears in the source data. This code is mapped to a standard condition concept in the Standardized Vocabularies and the original code is stored here for reference.","condition_occurrence","cdm"
"14","condition_source_concept_id","No","INTEGER","A foreign key to a Condition Concept that refers to the code used in the source.","condition_occurrence","cdm"
"15","condition_status_source_value","No","VARCHAR(50)","The source code for the condition status as it appears in the source data.","condition_occurrence","cdm"
"16","condition_status_concept_id","No","INTEGER","A foreign key to the predefined Concept in the Standard Vocabulary reflecting the condition status","condition_occurrence","cdm"
"17","person_id","Yes","INTEGER","A foreign key identifier to the deceased person. The demographic details of that person are stored in the person table.","death","cdm"
"18","death_date","Yes","DATE","The date the person was deceased. If the precise date including day or month is not known or not allowed, December is used as the default month, and the last day of the month the default day.","death","cdm"
"19","death_datetime","No","DATETIME","The date and time the person was deceased. If the precise date including day or month is not known or not allowed, December is used as the default month, and the last day of the month the default day.","death","cdm"
"20","death_type_concept_id","Yes","INTEGER","A foreign key referring to the predefined concept identifier in the Standardized Vocabularies reflecting how the death was represented in the source data.","death","cdm"
"21","cause_concept_id","No","INTEGER","A foreign key referring to a standard concept identifier in the Standardized Vocabularies for conditions.","death","cdm"
"22","cause_source_value","No","VARCHAR(50)","The source code for the cause of death as it appears in the source data. This code is mapped to a standard concept in the Standardized Vocabularies and the original code is, stored here for reference.","death","cdm"
"23","cause_source_concept_id","No","INTEGER","A foreign key to the concept that refers to the code used in the source. Note, this variable name is abbreviated to ensure it will be allowable across database platforms.","death","cdm"
"24","device_exposure_id","Yes","INTEGER","A system-generated unique identifier for each Device Exposure.","device_exposure","cdm"
"25","person_id","Yes","INTEGER","A foreign key identifier to the Person who is subjected to the Device. The demographic details of that person are stored in the Person table.","device_exposure","cdm"
"26","device_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the Device concept.","device_exposure","cdm"
"27","device_exposure_start_date","Yes","DATE","The date the Device or supply was applied or used.","device_exposure","cdm"
"28","device_exposure_start_datetime","No","DATETIME","The date and time the Device or supply was applied or used.","device_exposure","cdm"
"29","device_exposure_end_date","No","DATE","The date the Device or supply was removed from use.","device_exposure","cdm"
"30","device_exposure_end_datetime","No","DATETIME","The date and time the Device or supply was removed from use.","device_exposure","cdm"
"31","device_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of Device Exposure recorded. It indicates how the Device Exposure was represented in the source data.","device_exposure","cdm"
"32","unique_device_id","No","VARCHAR(50)","A UDI or equivalent identifying the instance of the Device used in the Person.","device_exposure","cdm"
"33","quantity","No","INTEGER","The number of individual Devices used for the exposure.","device_exposure","cdm"
"34","provider_id","No","INTEGER","A foreign key to the provider in the PROVIDER table who initiated of administered the Device.","device_exposure","cdm"
"35","visit_occurrence_id","No","INTEGER","A foreign key to the visit in the VISIT_OCCURRENCE table during which the device was used.","device_exposure","cdm"
"36","visit_detail_id","No","INTEGER","A foreign key to the visit detail in the VISIT_DETAIL table during which the Drug Exposure was initiated.","device_exposure","cdm"
"37","device_source_value","No","VARCHAR(50)","The source code for the Device as it appears in the source data. This code is mapped to a standard Device Concept in the Standardized Vocabularies and the original code is stored here for reference.","device_exposure","cdm"
"38","device_source_concept_id","No","INTEGER","A foreign key to a Device Concept that refers to the code used in the source.","device_exposure","cdm"
"39","drug_exposure_id","Yes","INTEGER","A system-generated unique identifier for each Drug utilization event.","drug_exposure","cdm"
"40","person_id","Yes","INTEGER","A foreign key identifier to the person who is subjected to the Drug. The demographic details of that person are stored in the person table.","drug_exposure","cdm"
"41","drug_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the Drug concept.","drug_exposure","cdm"
"42","drug_exposure_start_date","Yes","DATE","The start date for the current instance of Drug utilization. Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration procedure was recorded.","drug_exposure","cdm"
"43","drug_exposure_start_datetime","No","DATETIME","The start date and time for the current instance of Drug utilization. Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration procedure was recorded.","drug_exposure","cdm"
"44","drug_exposure_end_date","Yes","DATE","The end date for the current instance of Drug utilization. It is not available from all sources.","drug_exposure","cdm"
"45","drug_exposure_end_datetime","No","DATETIME","The end date and time for the current instance of Drug utilization. It is not available from all sources.","drug_exposure","cdm"
"46","verbatim_end_date","No","DATE","The known end date of a drug_exposure as provided by the source","drug_exposure","cdm"
"47","drug_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of Drug Exposure recorded. It indicates how the Drug Exposure was represented in the source data.","drug_exposure","cdm"
"48","stop_reason","No","VARCHAR(20)","The reason the Drug was stopped. Reasons include regimen completed, changed, removed, etc.","drug_exposure","cdm"
"49","refills","No","INTEGER","The number of refills after the initial prescription. The initial prescription is not counted, values start with 0.","drug_exposure","cdm"
"50","quantity","No","FLOAT","The quantity of drug as recorded in the original prescription or dispensing record.","drug_exposure","cdm"
"51","days_supply","No","INTEGER","The number of days of supply of the medication as recorded in the original prescription or dispensing record.","drug_exposure","cdm"
"52","sig","No","VARCHAR(MAX)","The directions (""signetur"") on the Drug prescription as recorded in the original prescription (and printed on the container) or dispensing record.","drug_exposure","cdm"
"53","route_concept_id","No","INTEGER","A foreign key to a predefined concept in the Standardized Vocabularies reflecting the route of administration.","drug_exposure","cdm"
"54","lot_number","No","VARCHAR(50)","An identifier assigned to a particular quantity or lot of Drug product from the manufacturer.","drug_exposure","cdm"
"55","provider_id","No","INTEGER","A foreign key to the provider in the PROVIDER table who initiated (prescribed or administered) the Drug Exposure.","drug_exposure","cdm"
"56","visit_occurrence_id","No","INTEGER","A foreign key to the Visit in the VISIT_OCCURRENCE table during which the Drug Exposure was initiated.","drug_exposure","cdm"
"57","visit_detail_id","No","INTEGER","A foreign key to the Visit Detail in the VISIT_DETAIL table during which the Drug Exposure was initiated.","drug_exposure","cdm"
"58","drug_source_value","No","VARCHAR(50)","The source code for the Drug as it appears in the source data. This code is mapped to a Standard Drug concept in the Standardized Vocabularies and the original code is, stored here for reference.","drug_exposure","cdm"
"59","drug_source_concept_id","No","INTEGER","A foreign key to a Drug Concept that refers to the code used in the source.","drug_exposure","cdm"
"60","route_source_value","No","VARCHAR(50)","The information about the route of administration as detailed in the source.","drug_exposure","cdm"
"61","dose_unit_source_value","No","VARCHAR(50)","The information about the dose unit as detailed in the source.","drug_exposure","cdm"
"62","domain_concept_id_1","Yes","INTEGER","The concept representing the domain of fact one, from which the corresponding table can be inferred.","fact_relationship","cdm"
"63","fact_id_1","Yes","INTEGER","The unique identifier in the table corresponding to the domain of fact one.","fact_relationship","cdm"
"64","domain_concept_id_2","Yes","INTEGER","The concept representing the domain of fact two, from which the corresponding table can be inferred.","fact_relationship","cdm"
"65","fact_id_2","Yes","INTEGER","The unique identifier in the table corresponding to the domain of fact two.","fact_relationship","cdm"
"66","relationship_concept_id","Yes","INTEGER","A foreign key to a Standard Concept ID of relationship in the Standardized Vocabularies.","fact_relationship","cdm"
"67","measurement_id","Yes","INTEGER","A unique identifier for each Measurement.","measurement","cdm"
"68","person_id","Yes","INTEGER","A foreign key identifier to the Person about whom the measurement was recorded. The demographic details of that Person are stored in the PERSON table.","measurement","cdm"
"69","measurement_concept_id","Yes","INTEGER","A foreign key to the standard measurement concept identifier in the Standardized Vocabularies.","measurement","cdm"
"70","measurement_date","Yes","DATE","The date of the Measurement.","measurement","cdm"
"71","measurement_datetime","No","DATETIME","The date and time of the Measurement. Some database systems don't have a datatype of time. To accomodate all temporal analyses, datatype datetime can be used (combining measurement_date and measurement_time [forum discussion](http://forums.ohdsi.org/t/date-time-and-datetime-problem-and-the-world-of-hours-and-1day/314))","measurement","cdm"
"72","measurement_time","No","VARCHAR(10)","The time of the Measurement. This is present for backwards compatibility and will deprecated in an upcoming version","measurement","cdm"
"73","measurement_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the provenance from where the Measurement record was recorded.","measurement","cdm"
"74","operator_concept_id","No","INTEGER","A foreign key identifier to the predefined Concept in the Standardized Vocabularies reflecting the mathematical operator that is applied to the value_as_number. Operators are <, <=, =, >=, >.","measurement","cdm"
"75","value_as_number","No","FLOAT","A Measurement result where the result is expressed as a numeric value.","measurement","cdm"
"76","value_as_concept_id","No","INTEGER","A foreign key to a Measurement result represented as a Concept from the Standardized Vocabularies (e.g., positive/negative, present/absent, low/high, etc.).","measurement","cdm"
"77","unit_concept_id","No","INTEGER","A foreign key to a Standard Concept ID of Measurement Units in the Standardized Vocabularies.","measurement","cdm"
"78","range_low","No","FLOAT","The lower limit of the normal range of the Measurement result. The lower range is assumed to be of the same unit of measure as the Measurement value.","measurement","cdm"
"79","range_high","No","FLOAT","The upper limit of the normal range of the Measurement. The upper range is assumed to be of the same unit of measure as the Measurement value.","measurement","cdm"
"80","provider_id","No","INTEGER","A foreign key to the provider in the PROVIDER table who was responsible for initiating or obtaining the measurement.","measurement","cdm"
"81","visit_occurrence_id","No","INTEGER","A foreign key to the Visit in the VISIT_OCCURRENCE table during which the Measurement was recorded.","measurement","cdm"
"82","visit_detail_id","No","INTEGER","A foreign key to the Visit Detail in the VISIT_DETAIL table during which the Measurement was recorded.","measurement","cdm"
"83","measurement_source_value","No","VARCHAR(50)","The Measurement name as it appears in the source data. This code is mapped to a Standard Concept in the Standardized Vocabularies and the original code is stored here for reference.","measurement","cdm"
"84","measurement_source_concept_id","No","INTEGER","A foreign key to a Concept in the Standard Vocabularies that refers to the code used in the source.","measurement","cdm"
"85","unit_source_value","No","VARCHAR(50)","The source code for the unit as it appears in the source data. This code is mapped to a standard unit concept in the Standardized Vocabularies and the original code is stored here for reference.","measurement","cdm"
"86","value_source_value","No","VARCHAR(50)","The source value associated with the content of the value_as_number or value_as_concept_id as stored in the source data.","measurement","cdm"
"87","note_id","Yes","INTEGER","A unique identifier for each note.","note","cdm"
"88","person_id","Yes","INTEGER","A foreign key identifier to the Person about whom the Note was recorded. The demographic details of that Person are stored in the PERSON table.","note","cdm"
"89","note_date","Yes","DATE","The date the note was recorded.","note","cdm"
"90","note_datetime","No","DATETIME","The date and time the note was recorded.","note","cdm"
"91","note_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the type, origin or provenance of the Note.","note","cdm"
"92","note_class_concept_id","Yes","INTEGER","A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the HL7 LOINC Document Type Vocabulary classification of the note.","note","cdm"
"93","note_title","No","VARCHAR(250)","The title of the Note as it appears in the source.","note","cdm"
"94","note_text","Yes","VARCHAR(MAX)","The content of the Note.","note","cdm"
"95","encoding_concept_id","Yes","INTEGER","A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the note character encoding type","note","cdm"
"96","language_concept_id","Yes","INTEGER","A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the language of the note","note","cdm"
"97","provider_id","No","INTEGER","A foreign key to the Provider in the PROVIDER table who took the Note.","note","cdm"
"98","visit_occurrence_id","No","INTEGER","A foreign key to the Visit in the VISIT_OCCURRENCE table when the Note was taken.","note","cdm"
"99","visit_detail_id","No","INTEGER","A foreign key to the Visit in the VISIT_DETAIL table when the Note was taken.","note","cdm"
"100","note_source_value","No","VARCHAR(50)","The source value associated with the origin of the Note","note","cdm"
"101","yes","integer","A UNIQUE IDENTIFIER FOR EACH TERM EXTRACTED FROM A NOTE.",NA,"note_nlp","cdm"
"102","yes","integer","A FOREIGN KEY TO THE NOTE TABLE NOTE THE TERM WAS EXTRACTED FROM.",NA,"note_nlp","cdm"
"103","no","integer","A FOREIGN KEY TO THE PREDEFINED CONCEPT IN THE STANDARDIZED VOCABULARIES REPRESENTING THE SECTION OF THE EXTRACTED TERM.",NA,"note_nlp","cdm"
"104","no","varchar(250)","A SMALL WINDOW OF TEXT SURROUNDING THE TERM.",NA,"note_nlp","cdm"
"105","no","varchar(50)","CHARACTER OFFSET OF THE EXTRACTED TERM IN THE INPUT NOTE.",NA,"note_nlp","cdm"
"106","yes","varchar(250)","RAW TEXT EXTRACTED FROM THE NLP TOOL.",NA,"note_nlp","cdm"
"107","no","integer","A FOREIGN KEY TO THE PREDEFINED CONCEPT IN THE STANDARDIZED VOCABULARIES REFLECTING THE NORMALIZED CONCEPT FOR THE EXTRACTED TERM. DOMAIN OF THE TERM IS REPRESENTED AS PART OF THE CONCEPT TABLE.",NA,"note_nlp","cdm"
"108","no","integer","A FOREIGN KEY TO A CONCEPT THAT REFERS TO THE CODE IN THE SOURCE VOCABULARY USED BY THE NLP SYSTEM",NA,"note_nlp","cdm"
"109","no","varchar(250)","NAME AND VERSION OF THE NLP SYSTEM THAT EXTRACTED THE TERM.USEFUL FOR DATA PROVENANCE.",NA,"note_nlp","cdm"
"110","yes","date","THE DATE OF THE NOTE PROCESSING.USEFUL FOR DATA PROVENANCE.",NA,"note_nlp","cdm"
"111","no","datetime","THE DATE AND TIME OF THE NOTE PROCESSING. USEFUL FOR DATA PROVENANCE.",NA,"note_nlp","cdm"
"112","no","varchar(1)","A SUMMARY MODIFIER THAT SIGNIFIES PRESENCE OR ABSENCE OF THE TERM FOR A GIVEN PATIENT. USEFUL FOR QUICK QUERYING.",NA,"note_nlp","cdm"
"113","no","varchar(50)","AN OPTIONAL TIME MODIFIER ASSOCIATED WITH THE EXTRACTED TERM. (FOR NOW “PAST” OR “PRESENT” ONLY). STANDARDIZE IT LATER.",NA,"note_nlp","cdm"
"114","no","varchar(2000)","A COMPACT DESCRIPTION OF ALL THE MODIFIERS OF THE SPECIFIC TERM EXTRACTED BY THE NLP SYSTEM. (E.G. “SON HAS RASH” ? “NEGATED=NO,SUBJECT=FAMILY, CERTAINTY=UNDEF,CONDITIONAL=FALSE,GENERAL=FALSE”).",NA,"note_nlp","cdm"
"115","observation_id","Yes","INTEGER","A unique identifier for each observation.","observation","cdm"
"116","person_id","Yes","INTEGER","A foreign key identifier to the Person about whom the observation was recorded. The demographic details of that Person are stored in the PERSON table.","observation","cdm"
"117","observation_concept_id","Yes","INTEGER","A foreign key to the standard observation concept identifier in the Standardized Vocabularies.","observation","cdm"
"118","observation_date","Yes","DATE","The date of the observation.","observation","cdm"
"119","observation_datetime","No","DATETIME","The date and time of the observation.","observation","cdm"
"120","observation_type_concept_id","Yes","INTEGER","A foreign key to the predefined concept identifier in the Standardized Vocabularies reflecting the type of the observation.","observation","cdm"
"121","value_as_number","No","FLOAT","The observation result stored as a number. This is applicable to observations where the result is expressed as a numeric value.","observation","cdm"
"122","value_as_string","No","VARCHAR(60)","The observation result stored as a string. This is applicable to observations where the result is expressed as verbatim text.","observation","cdm"
"123","value_as_concept_id","No","INTEGER","A foreign key to an observation result stored as a Concept ID. This is applicable to observations where the result can be expressed as a Standard Concept from the Standardized Vocabularies (e.g., positive/negative, present/absent, low/high, etc.).","observation","cdm"
"124","qualifier_concept_id","No","INTEGER","A foreign key to a Standard Concept ID for a qualifier (e.g., severity of drug-drug interaction alert)","observation","cdm"
"125","unit_concept_id","No","INTEGER","A foreign key to a Standard Concept ID of measurement units in the Standardized Vocabularies.","observation","cdm"
"126","provider_id","No","INTEGER","A foreign key to the provider in the PROVIDER table who was responsible for making the observation.","observation","cdm"
"127","visit_occurrence_id","No","INTEGER","A foreign key to the visit in the VISIT_OCCURRENCE table during which the observation was recorded.","observation","cdm"
"128","visit_detail_id","No","INTEGER","A foreign key to the visit in the VISIT_DETAIL table during which the observation was recorded.","observation","cdm"
"129","observation_source_value","No","VARCHAR(50)","The observation code as it appears in the source data. This code is mapped to a Standard Concept in the Standardized Vocabularies and the original code is, stored here for reference.","observation","cdm"
"130","observation_source_concept_id","No","INTEGER","A foreign key to a Concept that refers to the code used in the source.","observation","cdm"
"131","unit_source_value","No","VARCHAR(50)","The source code for the unit as it appears in the source data. This code is mapped to a standard unit concept in the Standardized Vocabularies and the original code is, stored here for reference.","observation","cdm"
"132","qualifier_source_value","No","VARCHAR(50)","The source value associated with a qualifier to characterize the observation","observation","cdm"
"133","observation_period_id","Yes","INTEGER","A unique identifier for each observation period.","observation_period","cdm"
"134","person_id","Yes","INTEGER","A foreign key identifier to the person for whom the observation period is defined. The demographic details of that person are stored in the person table.","observation_period","cdm"
"135","observation_period_start_date","Yes","DATE","The start date of the observation period for which data are available from the data source.","observation_period","cdm"
"136","observation_period_end_date","Yes","DATE","The end date of the observation period for which data are available from the data source.","observation_period","cdm"
"137","period_type_concept_id","Yes","INTEGER","A foreign key identifier to the predefined concept in the Standardized Vocabularies reflecting the source of the observation period information","observation_period","cdm"
"138","person_id","Yes","INTEGER","A unique identifier for each person.","person","cdm"
"139","gender_concept_id","Yes","INTEGER","A foreign key that refers to an identifier in the CONCEPT table for the unique gender of the person.","person","cdm"
"140","year_of_birth","Yes","INTEGER","The year of birth of the person. For data sources with date of birth, the year is extracted. For data sources where the year of birth is not available, the approximate year of birth is derived based on any age group categorization available.","person","cdm"
"141","month_of_birth","No","INTEGER","The month of birth of the person. For data sources that provide the precise date of birth, the month is extracted and stored in this field.","person","cdm"
"142","day_of_birth","No","INTEGER","The day of the month of birth of the person. For data sources that provide the precise date of birth, the day is extracted and stored in this field.","person","cdm"
"143","birth_datetime","No","DATETIME","The date and time of birth of the person.","person","cdm"
"144","race_concept_id","Yes","INTEGER","A foreign key that refers to an identifier in the CONCEPT table for the unique race of the person.","person","cdm"
"145","ethnicity_concept_id","Yes","INTEGER","A foreign key that refers to the standard concept identifier in the Standardized Vocabularies for the ethnicity of the person.","person","cdm"
"146","location_id","No","INTEGER","A foreign key to the place of residency for the person in the location table, where the detailed address information is stored.","person","cdm"
"147","provider_id","No","INTEGER","A foreign key to the primary care provider the person is seeing in the provider table.","person","cdm"
"148","care_site_id","No","INTEGER","A foreign key to the site of primary care in the care_site table, where the details of the care site are stored.","person","cdm"
"149","person_source_value","No","VARCHAR(50)","An (encrypted) key derived from the person identifier in the source data. This is necessary when a use case requires a link back to the person data at the source dataset.","person","cdm"
"150","gender_source_value","No","VARCHAR(50)","The source code for the gender of the person as it appears in the source data. The person’s gender is mapped to a standard gender concept in the Standardized Vocabularies; the original value is stored here for reference.","person","cdm"
"151","gender_source_concept_id","No","INTEGER","A foreign key to the gender concept that refers to the code used in the source.","person","cdm"
"152","race_source_value","No","VARCHAR(50)","The source code for the race of the person as it appears in the source data. The person race is mapped to a standard race concept in the Standardized Vocabularies and the original value is stored here for reference.","person","cdm"
"153","race_source_concept_id","No","INTEGER","A foreign key to the race concept that refers to the code used in the source.","person","cdm"
"154","ethnicity_source_value","No","VARCHAR(50)","The source code for the ethnicity of the person as it appears in the source data. The person ethnicity is mapped to a standard ethnicity concept in the Standardized Vocabularies and the original code is, stored here for reference.","person","cdm"
"155","ethnicity_source_concept_id","No","INTEGER","A foreign key to the ethnicity concept that refers to the code used in the source.","person","cdm"
"156","procedure_occurrence_id","Yes","INTEGER","A system-generated unique identifier for each Procedure Occurrence.","procedure_occurrence","cdm"
"157","person_id","Yes","INTEGER","A foreign key identifier to the Person who is subjected to the Procedure. The demographic details of that Person are stored in the PERSON table.","procedure_occurrence","cdm"
"158","procedure_concept_id","Yes","INTEGER","A foreign key that refers to a standard procedure Concept identifier in the Standardized Vocabularies.","procedure_occurrence","cdm"
"159","procedure_date","Yes","DATE","The date on which the Procedure was performed.","procedure_occurrence","cdm"
"160","procedure_datetime","No","DATETIME","The date and time on which the Procedure was performed.","procedure_occurrence","cdm"
"161","procedure_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of source data from which the procedure record is derived.","procedure_occurrence","cdm"
"162","modifier_concept_id","No","INTEGER","A foreign key to a Standard Concept identifier for a modifier to the Procedure (e.g. bilateral)","procedure_occurrence","cdm"
"163","quantity","No","INTEGER","The quantity of procedures ordered or administered.","procedure_occurrence","cdm"
"164","provider_id","No","INTEGER","A foreign key to the provider in the PROVIDER table who was responsible for carrying out the procedure.","procedure_occurrence","cdm"
"165","visit_occurrence_id","No","INTEGER","A foreign key to the Visit in the VISIT_OCCURRENCE table during which the Procedure was carried out.","procedure_occurrence","cdm"
"166","visit_detail_id","No","INTEGER","A foreign key to the Visit Detail in the VISIT_DETAIL table during which the Procedure was carried out.","procedure_occurrence","cdm"
"167","procedure_source_value","No","VARCHAR(50)","The source code for the Procedure as it appears in the source data. This code is mapped to a standard procedure Concept in the Standardized Vocabularies and the original code is, stored here for reference. Procedure source codes are typically ICD-9-Proc, CPT-4, HCPCS or OPCS-4 codes.","procedure_occurrence","cdm"
"168","procedure_source_concept_id","No","INTEGER","A foreign key to a Procedure Concept that refers to the code used in the source.","procedure_occurrence","cdm"
"169","modifier_source_value","No","VARCHAR(50)","The source code for the qualifier as it appears in the source data.","procedure_occurrence","cdm"
"170","specimen_id","Yes","INTEGER","A unique identifier for each specimen.","specimen","cdm"
"171","person_id","Yes","INTEGER","A foreign key identifier to the Person for whom the Specimen is recorded.","specimen","cdm"
"172","specimen_concept_id","Yes","INTEGER","A foreign key referring to a Standard Concept identifier in the Standardized Vocabularies for the Specimen.","specimen","cdm"
"173","specimen_type_concept_id","Yes","INTEGER","A foreign key referring to the Concept identifier in the Standardized Vocabularies reflecting the system of record from which the Specimen was represented in the source data.","specimen","cdm"
"174","specimen_date","Yes","DATE","The date the specimen was obtained from the Person.","specimen","cdm"
"175","specimen_datetime","No","DATETIME","The date and time on the date when the Specimen was obtained from the person.","specimen","cdm"
"176","quantity","No","FLOAT","The amount of specimen collection from the person during the sampling procedure.","specimen","cdm"
"177","unit_concept_id","No","INTEGER","A foreign key to a Standard Concept identifier for the Unit associated with the numeric quantity of the Specimen collection.","specimen","cdm"
"178","anatomic_site_concept_id","No","INTEGER","A foreign key to a Standard Concept identifier for the anatomic location of specimen collection.","specimen","cdm"
"179","disease_status_concept_id","No","INTEGER","A foreign key to a Standard Concept identifier for the Disease Status of specimen collection.","specimen","cdm"
"180","specimen_source_id","No","VARCHAR(50)","The Specimen identifier as it appears in the source data.","specimen","cdm"
"181","specimen_source_value","No","VARCHAR(50)","The Specimen value as it appears in the source data. This value is mapped to a Standard Concept in the Standardized Vocabularies and the original code is, stored here for reference.","specimen","cdm"
"182","unit_source_value","No","VARCHAR(50)","The information about the Unit as detailed in the source.","specimen","cdm"
"183","anatomic_site_source_value","No","VARCHAR(50)","The information about the anatomic site as detailed in the source.","specimen","cdm"
"184","disease_status_source_value","No","VARCHAR(50)","The information about the disease status as detailed in the source.","specimen","cdm"
"185","visit_detail_id","Yes","INTEGER","A unique identifier for each Person's visit or encounter at a healthcare provider.","visit_detail","cdm"
"186","person_id","Yes","INTEGER","A foreign key identifier to the Person for whom the visit is recorded. The demographic details of that Person are stored in the PERSON table.","visit_detail","cdm"
"187","visit_concept_id","Yes","INTEGER","A foreign key that refers to a visit Concept identifier in the Standardized Vocabularies.","visit_detail","cdm"
"188","visit_start_date","Yes","DATE","The start date of the visit.","visit_detail","cdm"
"189","visit_start_datetime","No","DATETIME","The date and time of the visit started.","visit_detail","cdm"
"190","visit_end_date","Yes","DATE","The end date of the visit. If this is a one-day visit the end date should match the start date.","visit_detail","cdm"
"191","visit_end_datetime","No","DATETIME","The date and time of the visit end.","visit_detail","cdm"
"192","visit_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of source data from which the visit record is derived.","visit_detail","cdm"
"193","provider_id","No","INTEGER","A foreign key to the provider in the provider table who was associated with the visit.","visit_detail","cdm"
"194","care_site_id","No","INTEGER","A foreign key to the care site in the care site table that was visited.","visit_detail","cdm"
"195","visit_source_value","No","STRING(50)","The source code for the visit as it appears in the source data.","visit_detail","cdm"
"196","visit_source_concept_id","No","INTEGER","A foreign key to a Concept that refers to the code used in the source.","visit_detail","cdm"
"197","admitting_source_value","No","VARCHAR(50)","The source code for the admitting source as it appears in the source data.","visit_detail","cdm"
"198","admitting_source_concept_id","No","INTEGER","A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the admitting source for a visit.","visit_detail","cdm"
"199","discharge_to_source_value","No","VARCHAR(50)","The source code for the discharge disposition as it appears in the source data.","visit_detail","cdm"
"200","discharge_to_concept_id","No","INTEGER","A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the discharge disposition for a visit.","visit_detail","cdm"
"201","preceding_visit_detail_id","No","INTEGER","A foreign key to the VISIT_DETAIL table of the visit immediately preceding this visit","visit_detail","cdm"
"202","visit_detail_parent_id","No","INTEGER","A foreign key to the VISIT_DETAIL table record to represent the immediate parent visit-detail record.","visit_detail","cdm"
"203","visit_occurrence_id","Yes","INTEGER","A foreign key that refers to the record in the VISIT_OCCURRENCE table. This is a required field, because for every visit_detail is a child of visit_occurrence and cannot exist without a corresponding parent record in visit_occurrence.","visit_detail","cdm"
"204","visit_occurrence_id","Yes","INTEGER","A unique identifier for each Person's visit or encounter at a healthcare provider.","visit_occurrence","cdm"
"205","person_id","Yes","INTEGER","A foreign key identifier to the Person for whom the visit is recorded. The demographic details of that Person are stored in the PERSON table.","visit_occurrence","cdm"
"206","visit_concept_id","Yes","INTEGER","A foreign key that refers to a visit Concept identifier in the Standardized Vocabularies.","visit_occurrence","cdm"
"207","visit_start_date","Yes","DATE","The start date of the visit.","visit_occurrence","cdm"
"208","visit_start_datetime","No","DATETIME","The date and time of the visit started.","visit_occurrence","cdm"
"209","visit_end_date","Yes","DATE","The end date of the visit. If this is a one-day visit the end date should match the start date.","visit_occurrence","cdm"
"210","visit_end_datetime","No","DATETIME","The date and time of the visit end.","visit_occurrence","cdm"
"211","visit_type_concept_id","Yes","INTEGER","A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of source data from which the visit record is derived.","visit_occurrence","cdm"
"212","provider_id","No","INTEGER","A foreign key to the provider in the provider table who was associated with the visit.","visit_occurrence","cdm"
"213","care_site_id","No","INTEGER","A foreign key to the care site in the care site table that was visited.","visit_occurrence","cdm"
"214","visit_source_value","No","VARCHAR(50)","The source code for the visit as it appears in the source data.","visit_occurrence","cdm"
"215","visit_source_concept_id","No","INTEGER","A foreign key to a Concept that refers to the code used in the source.","visit_occurrence","cdm"
"216","admitting_source_concept_id","No","INTEGER","A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the admitting source for a visit.","visit_occurrence","cdm"
"217","admitting_source_value","No","VARCHAR(50)","The source code for the admitting source as it appears in the source data.","visit_occurrence","cdm"
"218","discharge_to_concept_id","No","INTEGER","A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the discharge disposition for a visit.","visit_occurrence","cdm"
"219","discharge_to_source_value","No","VARCHAR(50)","The source code for the discharge disposition as it appears in the source data.","visit_occurrence","cdm"
"220","preceding_visit_occurrence_id","No","INTEGER","A foreign key to the VISIT_OCCURRENCE table of the visit immediately preceding this visit","visit_occurrence","cdm"
"221","cohort_definition_id","Yes","INTEGER","A foreign key to a record in the COHORT_DEFINITION table containing relevant Cohort Definition information.","cohort","results"
"222","subject_id","Yes","INTEGER","A foreign key to the subject in the cohort. These could be referring to records in the PERSON, PROVIDER, VISIT_OCCURRENCE table.","cohort","results"
"223","cohort_start_date","Yes","DATE","The date when the Cohort Definition criteria for the Person, Provider or Visit first match.","cohort","results"
"224","cohort_end_date","Yes","DATE","The date when the Cohort Definition criteria for the Person, Provider or Visit no longer match or the Cohort membership was terminated.","cohort","results"
"225","cohort_definition_id","Yes","INTEGER","A foreign key to a record in the [COHORT_DEFINITION](https://github.com/OHDSI/CommonDataModel/wiki/COHORT_DEFINITION) table containing relevant Cohort Definition information.","cohort_attribute","results"
"226","subject_id","Yes","INTEGER","A foreign key to the subject in the Cohort. These could be referring to records in the PERSON, PROVIDER, VISIT_OCCURRENCE table.","cohort_attribute","results"
"227","cohort_start_date","Yes","DATE","The date when the Cohort Definition criteria for the Person, Provider or Visit first match.","cohort_attribute","results"
"228","cohort_end_date","Yes","DATE","The date when the Cohort Definition criteria for the Person, Provider or Visit no longer match or the Cohort membership was terminated.","cohort_attribute","results"
"229","attribute_definition_id","Yes","INTEGER","A foreign key to a record in the [ATTRIBUTE_DEFINITION](https://github.com/OHDSI/CommonDataModel/wiki/ATTRIBUTE_DEFINITION) table containing relevant Attribute Definition information.","cohort_attribute","results"
"230","value_as_number","No","FLOAT","The attribute result stored as a number. This is applicable to attributes where the result is expressed as a numeric value.","cohort_attribute","results"
"231","value_as_concept_id","No","INTEGER","The attribute result stored as a Concept ID. This is applicable to attributes where the result is expressed as a categorical value.","cohort_attribute","results"
"232","condition_era_id","Yes","INTEGER","A unique identifier for each Condition Era.","condition_era","cdm"
"233","person_id","Yes","INTEGER","A foreign key identifier to the Person who is experiencing the Condition during the Condition Era. The demographic details of that Person are stored in the PERSON table.","condition_era","cdm"
"234","condition_concept_id","Yes","INTEGER","A foreign key that refers to a standard Condition Concept identifier in the Standardized Vocabularies.","condition_era","cdm"
"235","condition_era_start_date","Yes","DATE","The start date for the Condition Era constructed from the individual instances of Condition Occurrences. It is the start date of the very first chronologically recorded instance of the condition.","condition_era","cdm"
"236","condition_era_end_date","Yes","DATE","The end date for the Condition Era constructed from the individual instances of Condition Occurrences. It is the end date of the final continuously recorded instance of the Condition.","condition_era","cdm"
"237","condition_occurrence_count","No","INTEGER","The number of individual Condition Occurrences used to construct the condition era.","condition_era","cdm"
"238","dose_era_id","Yes","INTEGER","A unique identifier for each Dose Era.","dose_era","cdm"
"239","person_id","Yes","INTEGER","A foreign key identifier to the Person who is subjected to the drug during the drug era. The demographic details of that Person are stored in the PERSON table.","dose_era","cdm"
"240","drug_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the active Ingredient Concept.","dose_era","cdm"
"241","unit_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the unit concept.","dose_era","cdm"
"242","dose_value","Yes","FLOAT","The numeric value of the dose.","dose_era","cdm"
"243","dose_era_start_date","Yes","DATE","The start date for the drug era constructed from the individual instances of drug exposures. It is the start date of the very first chronologically recorded instance of utilization of a drug.","dose_era","cdm"
"244","dose_era_end_date","Yes","DATE","The end date for the drug era constructed from the individual instance of drug exposures. It is the end date of the final continuously recorded instance of utilization of a drug.","dose_era","cdm"
"245","drug_era_id","Yes","INTEGER","A unique identifier for each Drug Era.","drug_era","cdm"
"246","person_id","Yes","INTEGER","A foreign key identifier to the Person who is subjected to the Drug during the fDrug Era. The demographic details of that Person are stored in the PERSON table.","drug_era","cdm"
"247","drug_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the Ingredient Concept.","drug_era","cdm"
"248","drug_era_start_date","Yes","DATE","The start date for the Drug Era constructed from the individual instances of Drug Exposures. It is the start date of the very first chronologically recorded instance of conutilization of a Drug.","drug_era","cdm"
"249","drug_era_end_date","Yes","DATE","The end date for the drug era constructed from the individual instance of drug exposures. It is the end date of the final continuously recorded instance of utilization of a drug.","drug_era","cdm"
"250","drug_exposure_count","No","INTEGER","The number of individual Drug Exposure occurrences used to construct the Drug Era.","drug_era","cdm"
"251","gap_days","No","INTEGER","The number of days that are not covered by DRUG_EXPOSURE records that were used to make up the era record.","drug_era","cdm"
"252","cost_id","Yes","INTEGER","A unique identifier for each COST record.","cost","cdm"
"253","cost_event_id","Yes","INTEGER","A foreign key identifier to the event (e.g. Measurement, Procedure, Visit, Drug Exposure, etc) record for which cost data are recorded.","cost","cdm"
"254","cost_domain_id","Yes","VARCHAR(20)","The concept representing the domain of the cost event, from which the corresponding table can be inferred that contains the entity for which cost information is recorded.","cost","cdm"
"255","cost_type_concept_id","Yes","INTEGER","A foreign key identifier to a concept in the CONCEPT table for the provenance or the source of the COST data: Calculated from insurance claim information, provider revenue, calculated from cost-to-charge ratio, reported from accounting database, etc.","cost","cdm"
"256","currency_concept_id","No","INTEGER","A foreign key identifier to the concept representing the 3-letter code used to delineate international currencies, such as USD for US Dollar.","cost","cdm"
"257","total_charge","No","FLOAT","The total amount charged by some provider of goods or services (e.g. hospital, physician pharmacy, dme provider) to payers (insurance companies, the patient).","cost","cdm"
"258","total_cost","No","FLOAT","The cost incurred by the provider of goods or services.","cost","cdm"
"259","total_paid","No","FLOAT","The total amount actually paid from all payers for goods or services of the provider.","cost","cdm"
"260","paid_by_payer","No","FLOAT","The amount paid by the Payer for the goods or services.","cost","cdm"
"261","paid_by_patient","No","FLOAT","The total amount paid by the Person as a share of the expenses.","cost","cdm"
"262","paid_patient_copay","No","FLOAT","The amount paid by the Person as a fixed contribution to the expenses.","cost","cdm"
"263","paid_patient_coinsurance","No","FLOAT","The amount paid by the Person as a joint assumption of risk. Typically, this is a percentage of the expenses defined by the Payer Plan after the Person's deductible is exceeded.","cost","cdm"
"264","paid_patient_deductible","No","FLOAT","The amount paid by the Person that is counted toward the deductible defined by the Payer Plan. paid_patient_deductible does contribute to the paid_by_patient variable.","cost","cdm"
"265","paid_by_primary","No","FLOAT","The amount paid by a primary Payer through the coordination of benefits.","cost","cdm"
"266","paid_ingredient_cost","No","FLOAT","The amount paid by the Payer to a pharmacy for the drug, excluding the amount paid for dispensing the drug. paid_ingredient_cost contributes to the paid_by_payer field if this field is populated with a nonzero value.","cost","cdm"
"267","paid_dispensing_fee","No","FLOAT","The amount paid by the Payer to a pharmacy for dispensing a drug, excluding the amount paid for the drug ingredient. paid_dispensing_fee contributes to the paid_by_payer field if this field is populated with a nonzero value.","cost","cdm"
"268","payer_plan_period_id","No","INTEGER","A foreign key to the PAYER_PLAN_PERIOD table, where the details of the Payer, Plan and Family are stored. Record the payer_plan_id that relates to the payer who contributed to the paid_by_payer field.","cost","cdm"
"269","amount_allowed","No","FLOAT","The contracted amount agreed between the payer and provider.","cost","cdm"
"270","revenue_code_concept_id","No","INTEGER","A foreign key referring to a Standard Concept ID in the Standardized Vocabularies for Revenue codes.","cost","cdm"
"271","revenue_code_source_value","No","VARCHAR(50)","The source code for the Revenue code as it appears in the source data, stored here for reference.","cost","cdm"
"272","drg_concept_id","No","INTEGER","A foreign key to the predefined concept in the DRG Vocabulary reflecting the DRG for a visit.","cost","cdm"
"273","drg_source_value","No","VARCHAR(3)","The 3-digit DRG source code as it appears in the source data.","cost","cdm"
"274","payer_plan_period_id","Yes","INTEGER","A identifier for each unique combination of payer, sponsor, plan, family code and time span.","payer_plan_period","cdm"
"275","person_id","Yes","INTEGER","A foreign key identifier to the Person covered by the payer. The demographic details of that Person are stored in the PERSON table.","payer_plan_period","cdm"
"276","payer_plan_period_start_date","Yes","DATE","The start date of the payer plan period.","payer_plan_period","cdm"
"277","payer_plan_period_end_date","Yes","DATE","The end date of the payer plan period.","payer_plan_period","cdm"
"278","payer_concept_id","No","INTEGER","A foreign key that refers to a Standard Payer concept identifiers in the Standardized Vocabularies","payer_plan_period","cdm"
"279","payer_source_value","No","VARCHAR(50)","The source code for the payer as it appears in the source data.","payer_plan_period","cdm"
"280","payer_source_concept_id","No","INTEGER","A foreign key to a payer concept that refers to the code used in the source.","payer_plan_period","cdm"
"281","plan_concept_id","No","INTEGER","A foreign key that refers to a Standard plan that represents the health benefit plan in the Standardized Vocabularies","payer_plan_period","cdm"
"282","plan_source_value","No","VARCHAR(50)","The source code for the Person's health benefit plan as it appears in the source data.","payer_plan_period","cdm"
"283","plan_source_concept_id","No","INTEGER","A foreign key to a plan concept that refers to the code used in the source.","payer_plan_period","cdm"
"284","sponsor_concept_id","No","INTEGER","A foreign key that refers to a Standard plan that represents the sponsor in the Standardized Vocabularies","payer_plan_period","cdm"
"285","sponsor_source_value","No","VARCHAR(50)","The source code for the Person's sponsor of the health plan as it appears in the source data.","payer_plan_period","cdm"
"286","sponsor_source_concept_id*","No","INTEGER","A foreign key to a sponsor concept that refers to the code used in the source.","payer_plan_period","cdm"
"287","family_source_value","No","VARCHAR(50)","The source code for the Person's family as it appears in the source data.","payer_plan_period","cdm"
"288","stop_reason_concept_id","No","INTEGER","A foreign key that refers to a Standard termination reason that represents the reason for the termination in the Standardized Vocabularies.","payer_plan_period","cdm"
"289","stop_reason_source_value","No","VARCHAR(50)","The reason for stop-coverage of the record.","payer_plan_period","cdm"
"290","stop_reason_source_concept_id","No","INTEGER","A foreign key to a stop-coverage concept that refers to the code used in the source.","payer_plan_period","cdm"
"291","care_site_id","Yes","INTEGER","A unique identifier for each Care Site.","care_site","cdm"
"292","care_site_name","No","VARCHAR(255)","The verbatim description or name of the Care Site as in data source","care_site","cdm"
"293","place_of_service_concept_id","No","INTEGER","A foreign key that refers to a Place of Service Concept ID in the Standardized Vocabularies.","care_site","cdm"
"294","location_id","No","INTEGER","A foreign key to the geographic Location in the LOCATION table, where the detailed address information is stored.","care_site","cdm"
"295","care_site_source_value","No","VARCHAR(50)","The identifier for the Care Site in the source data, stored here for reference.","care_site","cdm"
"296","place_of_service_source_value","No","VARCHAR(50)","The source code for the Place of Service as it appears in the source data, stored here for reference.","care_site","cdm"
"297","location_id","Yes","INTEGER","A unique identifier for each geographic location.","location","cdm"
"298","address_1","No","VARCHAR(50)","The address field 1, typically used for the street address, as it appears in the source data.","location","cdm"
"299","address_2","No","VARCHAR(50)","The address field 2, typically used for additional detail such as buildings, suites, floors, as it appears in the source data.","location","cdm"
"300","city","No","VARCHAR(50)","The city field as it appears in the source data.","location","cdm"
"301","state","No","VARCHAR(2)","The state field as it appears in the source data.","location","cdm"
"302","zip","No","VARCHAR(9)","The zip or postal code.","location","cdm"
"303","county","No","VARCHAR(20)","The county.","location","cdm"
"304","location_source_value","No","VARCHAR(50)","The verbatim information that is used to uniquely identify the location as it appears in the source data.","location","cdm"
"305","provider_id","Yes","INTEGER","A unique identifier for each Provider.","provider","cdm"
"306","provider_name","No","VARCHAR(255)","A description of the Provider.","provider","cdm"
"307","npi","No","VARCHAR(20)","The National Provider Identifier (NPI) of the provider.","provider","cdm"
"308","dea","No","VARCHAR(20)","The Drug Enforcement Administration (DEA) number of the provider.","provider","cdm"
"309","specialty_concept_id","No","INTEGER","A foreign key to a Standard Specialty Concept ID in the Standardized Vocabularies.","provider","cdm"
"310","care_site_id","No","INTEGER","A foreign key to the main Care Site where the provider is practicing.","provider","cdm"
"311","year_of_birth","No","INTEGER","The year of birth of the Provider.","provider","cdm"
"312","gender_concept_id","No","INTEGER","The gender of the Provider.","provider","cdm"
"313","provider_source_value","No","VARCHAR(50)","The identifier used for the Provider in the source data, stored here for reference.","provider","cdm"
"314","specialty_source_value","No","VARCHAR(50)","The source code for the Provider specialty as it appears in the source data, stored here for reference.","provider","cdm"
"315","specialty_source_concept_id","No","INTEGER","A foreign key to a Concept that refers to the code used in the source.","provider","cdm"
"316","gender_source_value","No","VARCHAR(50)","The gender code for the Provider as it appears in the source data, stored here for reference.","provider","cdm"
"317","gender_source_concept_id","No","INTEGER","A foreign key to a Concept that refers to the code used in the source.","provider","cdm"
"318","cdm_source_name","Yes","VARCHAR(255)","The full name of the source","cdm_source","cdm"
"319","cdm_source_abbreviation","No","VARCHAR(25)","An abbreviation of the name","cdm_source","cdm"
"320","cdm_holder","No","VARCHAR(255)","The name of the organization responsible for the development of the CDM instance","cdm_source","cdm"
"321","source_description","No","CLOB","A description of the source data origin and purpose for collection. The description may contain a summary of the period of time that is expected to be covered by this dataset.","cdm_source","cdm"
"322","source_documentation_reference","No","VARCHAR(255)","URL or other external reference to location of source documentation","cdm_source","cdm"
"323","cdm_etl_reference","No","VARCHAR(255)","URL or other external reference to location of ETL specification documentation and ETL source code","cdm_source","cdm"
"324","source_release_date","No","DATE","The date for which the source data are most current, such as the last day of data capture","cdm_source","cdm"
"325","cdm_release_date","No","DATE","The date when the CDM was instantiated","cdm_source","cdm"
"326","cdm_version","No","VARCHAR(10)","The version of CDM used","cdm_source","cdm"
"327","vocabulary_version","No","VARCHAR(20)","The version of the vocabulary used","cdm_source","cdm"
"328","metadata_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Metadata Concept identifier in the Standardized Vocabularies.","metadata","cdm"
"329","metadata_type_concept_id","Yes","INTEGER","A foreign key that refers to a Standard Type Concept identifier in the Standardized Vocabularies.","metadata","cdm"
"330","name","Yes","VARCHAR(250)","The name of the Concept stored in metadata_concept_id or a description of the data being stored.","metadata","cdm"
"331","value_as_string","No","NVARCHAR","The metadata value stored as a string.","metadata","cdm"
"332","value_as_concept_id","No","INTEGER","A foreign key to a metadata value stored as a Concept ID.","metadata","cdm"
"333","metadata date","No","DATE","The date associated with the metadata","metadata","cdm"
"334","metadata_datetime","No","DATETIME","The date and time associated with the metadata","metadata","cdm"
"335","attribute_definition_id","Yes","INTEGER","A unique identifier for each Attribute.","attribute_definition","cdm"
"336","attribute_name","Yes","VARCHAR(255)","A short description of the Attribute.","attribute_definition","cdm"
"337","attribute_description","No","VARCHAR(MAX)","A complete description of the Attribute definition","attribute_definition","cdm"
"338","attribute_type_concept_id","Yes","INTEGER","Type defining what kind of Attribute Definition the record represents and how the syntax may be executed","attribute_definition","cdm"
"339","attribute_syntax","No","VARCHAR(MAX)","Syntax or code to operationalize the Attribute definition","attribute_definition","cdm"
"340","cohort_definition_id","Yes","INTEGER","A unique identifier for each Cohort.","cohort_definition","cdm"
"341","cohort_definition_name","Yes","VARCHAR(255)","A short description of the Cohort.","cohort_definition","cdm"
"342","cohort_definition_description","No","VARCHAR(MAX)","A complete description of the Cohort definition","cohort_definition","cdm"
"343","definition_type_concept_id","Yes","INTEGER","Type defining what kind of Cohort Definition the record represents and how the syntax may be executed","cohort_definition","cdm"
"344","cohort_definition_syntax","No","VARCHAR(MAX)","Syntax or code to operationalize the Cohort definition","cohort_definition","cdm"
"345","subject_concept_id","Yes","INTEGER","A foreign key to the Concept to which defines the domain of subjects that are members of the cohort (e.g., Person, Provider, Visit).","cohort_definition","cdm"
"346","cohort_initiation_date","No","DATE","A date to indicate when the Cohort was initiated in the COHORT table","cohort_definition","cdm"
"347","concept_id","Yes","INTEGER","A unique identifier for each Concept across all domains.","concept","cdm"
"348","concept_name","Yes","VARCHAR(255)","An unambiguous, meaningful and descriptive name for the Concept.","concept","cdm"
"349","domain_id","Yes","VARCHAR(20)","A foreign key to the [DOMAIN](https://github.com/OHDSI/CommonDataModel/wiki/DOMAIN) table the Concept belongs to.","concept","cdm"
"350","vocabulary_id","Yes","VARCHAR(20)","A foreign key to the [VOCABULARY](https://github.com/OHDSI/CommonDataModel/wiki/VOCABULARY) table indicating from which source the Concept has been adapted.","concept","cdm"
"351","concept_class_id","Yes","VARCHAR(20)","The attribute or concept class of the Concept. Examples are 'Clinical Drug', 'Ingredient', 'Clinical Finding' etc.","concept","cdm"
"352","standard_concept","No","VARCHAR(1)","This flag determines where a Concept is a Standard Concept, i.e. is used in the data, a Classification Concept, or a non-standard Source Concept. The allowables values are 'S' (Standard Concept) and 'C' (Classification Concept), otherwise the content is NULL.","concept","cdm"
"353","concept_code","Yes","VARCHAR(50)","The concept code represents the identifier of the Concept in the source vocabulary, such as SNOMED-CT concept IDs, RxNorm RXCUIs etc. Note that concept codes are not unique across vocabularies.","concept","cdm"
"354","valid_start_date","Yes","DATE","The date when the Concept was first recorded. The default value is 1-Jan-1970, meaning, the Concept has no (known) date of inception.","concept","cdm"
"355","valid_end_date","Yes","DATE","The date when the Concept became invalid because it was deleted or superseded (updated) by a new concept. The default value is 31-Dec-2099, meaning, the Concept is valid until it becomes deprecated.","concept","cdm"
"356","invalid_reason","No","VARCHAR(1)","Reason the Concept was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value.","concept","cdm"
"357","ancestor_concept_id","Yes","INTEGER","A foreign key to the concept in the concept table for the higher-level concept that forms the ancestor in the relationship.","concept_ancestor","cdm"
"358","descendant_concept_id","Yes","INTEGER","A foreign key to the concept in the concept table for the lower-level concept that forms the descendant in the relationship.","concept_ancestor","cdm"
"359","min_levels_of_separation","Yes","INTEGER","The minimum separation in number of levels of hierarchy between ancestor and descendant concepts. This is an attribute that is used to simplify hierarchic analysis.","concept_ancestor","cdm"
"360","max_levels_of_separation","Yes","INTEGER","The maximum separation in number of levels of hierarchy between ancestor and descendant concepts. This is an attribute that is used to simplify hierarchic analysis.","concept_ancestor","cdm"
"361","concept_class_id","Yes","VARCHAR(20)","A unique key for each class.","concept_class","cdm"
"362","concept_class_name","Yes","VARCHAR(255)","The name describing the Concept Class, e.g. ""Clinical Finding"", ""Ingredient"", etc.","concept_class","cdm"
"363","concept_class_concept_id","Yes","INTEGER","A foreign key that refers to an identifier in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table for the unique Concept Class the record belongs to.","concept_class","cdm"
"364","concept_id_1","Yes","INTEGER","A foreign key to a Concept in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table associated with the relationship. Relationships are directional, and this field represents the source concept designation.","concept_relationship","cdm"
"365","concept_id_2","Yes","INTEGER","A foreign key to a Concept in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table associated with the relationship. Relationships are directional, and this field represents the destination concept designation.","concept_relationship","cdm"
"366","relationship_id","Yes","VARCHAR(20)","A unique identifier to the type or nature of the Relationship as defined in the [RELATIONSHIP](https://github.com/OHDSI/CommonDataModel/wiki/RELATIONSHIP) table.","concept_relationship","cdm"
"367","valid_start_date","Yes","DATE","The date when the instance of the Concept Relationship is first recorded.","concept_relationship","cdm"
"368","valid_end_date","Yes","DATE","The date when the Concept Relationship became invalid because it was deleted or superseded (updated) by a new relationship. Default value is 31-Dec-2099.","concept_relationship","cdm"
"369","invalid_reason","No","VARCHAR(1)","Reason the relationship was invalidated. Possible values are 'D' (deleted), 'U' (replaced with an update) or NULL when valid_end_date has the default value.","concept_relationship","cdm"
"370","concept_id","Yes","INTEGER","A foreign key to the Concept in the CONCEPT table.","concept_synonym","cdm"
"371","concept_synonym_name","Yes","VARCHAR(1000)","The alternative name for the Concept.","concept_synonym","cdm"
"372","language_concept_id","Yes","INTEGER","A foreign key to a Concept representing the language.","concept_synonym","cdm"
"373","domain_id","Yes","VARCHAR(20)","A unique key for each domain.","domain","cdm"
"374","domain_name","Yes","VARCHAR(255)","The name describing the Domain, e.g. ""Condition"", ""Procedure"", ""Measurement"" etc.","domain","cdm"
"375","domain_concept_id","Yes","INTEGER","A foreign key that refers to an identifier in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table for the unique Domain Concept the Domain record belongs to.","domain","cdm"
"376","drug_concept_id","Yes","INTEGER","A foreign key to the Concept in the CONCEPT table representing the identifier for Branded Drug or Clinical Drug Concept.","drug_strength","cdm"
"377","ingredient_concept_id","Yes","INTEGER","A foreign key to the Concept in the CONCEPT table, representing the identifier for drug Ingredient Concept contained within the drug product.","drug_strength","cdm"
"378","amount_value","No","FLOAT","The numeric value associated with the amount of active ingredient contained within the product.","drug_strength","cdm"
"379","amount_unit_concept_id","No","INTEGER","A foreign key to the Concept in the CONCEPT table representing the identifier for the Unit for the absolute amount of active ingredient.","drug_strength","cdm"
"380","numerator_value","No","FLOAT","The numeric value associated with the concentration of the active ingredient contained in the product","drug_strength","cdm"
"381","numerator_unit_concept_id","No","INTEGER","A foreign key to the Concept in the CONCEPT table representing the identifier for the numerator Unit for the concentration of active ingredient.","drug_strength","cdm"
"382","denominator_value","No","FLOAT","The amount of total liquid (or other divisible product, such as ointment, gel, spray, etc.).","drug_strength","cdm"
"383","denominator_unit_concept_id","No","INTEGER","A foreign key to the Concept in the CONCEPT table representing the identifier for the denominator Unit for the concentration of active ingredient.","drug_strength","cdm"
"384","box_size","No","INTEGER","The number of units of Clinical of Branded Drug, or Quantified Clinical or Branded Drug contained in a box as dispensed to the patient","drug_strength","cdm"
"385","valid_start_date","Yes","DATE","The date when the Concept was first recorded. The default value is 1-Jan-1970.","drug_strength","cdm"
"386","valid_end_date","Yes","DATE","The date when the concept became invalid because it was deleted or superseded (updated) by a new Concept. The default value is 31-Dec-2099.","drug_strength","cdm"
"387","invalid_reason","No","VARCHAR(1)","Reason the concept was invalidated. Possible values are 'D' (deleted), 'U' (replaced with an update) or NULL when valid_end_date has the default value.","drug_strength","cdm"
"388","relationship_id","Yes","VARCHAR(20)","The type of relationship captured by the relationship record.","relationship","cdm"
"389","relationship_name","Yes","VARCHAR(255)","The text that describes the relationship type.","relationship","cdm"
"390","is_hierarchical","Yes","VARCHAR(1)","Defines whether a relationship defines concepts into classes or hierarchies. Values are 1 for hierarchical relationship or 0 if not.","relationship","cdm"
"391","defines_ancestry","Yes","VARCHAR(1)","Defines whether a hierarchical relationship contributes to the concept_ancestor table. These are subsets of the hierarchical relationships. Valid values are 1 or 0.","relationship","cdm"
"392","reverse_relationship_id","Yes","VARCHAR(20)","The identifier for the relationship used to define the reverse relationship between two concepts.","relationship","cdm"
"393","relationship_concept_id","Yes","INTEGER","A foreign key that refers to an identifier in the CONCEPT table for the unique relationship concept.","relationship","cdm"
"394","source_code","Yes","VARCHAR(50)","The source code being translated into a Standard Concept.","source_to_concept_map","cdm"
"395","source_concept_id","Yes","INTEGER","A foreign key to the Source Concept that is being translated into a Standard Concept.","source_to_concept_map","cdm"
"396","source_vocabulary_id","Yes","VARCHAR(20)","A foreign key to the VOCABULARY table defining the vocabulary of the source code that is being translated to a Standard Concept.","source_to_concept_map","cdm"
"397","source_code_description","No","VARCHAR(255)","An optional description for the source code. This is included as a convenience to compare the description of the source code to the name of the concept.","source_to_concept_map","cdm"
"398","target_concept_id","Yes","INTEGER","A foreign key to the target Concept to which the source code is being mapped.","source_to_concept_map","cdm"
"399","target_vocabulary_id","Yes","VARCHAR(20)","A foreign key to the VOCABULARY table defining the vocabulary of the target Concept.","source_to_concept_map","cdm"
"400","valid_start_date","Yes","DATE","The date when the mapping instance was first recorded.","source_to_concept_map","cdm"
"401","valid_end_date","Yes","DATE","The date when the mapping instance became invalid because it was deleted or superseded (updated) by a new relationship. Default value is 31-Dec-2099.","source_to_concept_map","cdm"
"402","invalid_reason","No","VARCHAR(1)","Reason the mapping instance was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value.","source_to_concept_map","cdm"
"403","vocabulary_id","Yes","VARCHAR(20)","A unique identifier for each Vocabulary, such as ICD9CM, SNOMED, Visit.","vocabulary","cdm"
"404","vocabulary_name","Yes","VARCHAR(255)","The name describing the vocabulary, for example ""International Classification of Diseases, Ninth Revision, Clinical Modification, Volume 1 and 2 (NCHS)"" etc.","vocabulary","cdm"
"405","vocabulary_reference","Yes","VARCHAR(255)","External reference to documentation or available download of the about the vocabulary.","vocabulary","cdm"
"406","vocabulary_version","No","VARCHAR(255)","Version of the Vocabulary as indicated in the source.","vocabulary","cdm"
"407","vocabulary_concept_id","Yes","INTEGER","A foreign key that refers to a standard concept identifier in the CONCEPT table for the Vocabulary the VOCABULARY record belongs to.","vocabulary","cdm"
1 field required type description table schema
2 1 condition_occurrence_id Yes INTEGER A unique identifier for each Condition Occurrence event. condition_occurrence cdm
3 2 person_id Yes INTEGER A foreign key identifier to the Person who is experiencing the condition. The demographic details of that Person are stored in the PERSON table. condition_occurrence cdm
4 3 condition_concept_id Yes INTEGER A foreign key that refers to a Standard Condition Concept identifier in the Standardized Vocabularies. condition_occurrence cdm
5 4 condition_start_date Yes DATE The date when the instance of the Condition is recorded. condition_occurrence cdm
6 5 condition_start_datetime No DATETIME The date and time when the instance of the Condition is recorded. condition_occurrence cdm
7 6 condition_end_date No DATE The date when the instance of the Condition is considered to have ended. condition_occurrence cdm
8 7 condition_end_datetime No DATE The date when the instance of the Condition is considered to have ended. condition_occurrence cdm
9 8 condition_type_concept_id Yes INTEGER A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the source data from which the condition was recorded, the level of standardization, and the type of occurrence. condition_occurrence cdm
10 9 stop_reason No VARCHAR(20) The reason that the condition was no longer present, as indicated in the source data. condition_occurrence cdm
11 10 provider_id No INTEGER A foreign key to the Provider in the PROVIDER table who was responsible for capturing (diagnosing) the Condition. condition_occurrence cdm
12 11 visit_occurrence_id No INTEGER A foreign key to the visit in the VISIT_OCCURRENCE table during which the Condition was determined (diagnosed). condition_occurrence cdm
13 12 visit_detail_id No INTEGER A foreign key to the visit in the VISIT_DETAIL table during which the Condition was determined (diagnosed). condition_occurrence cdm
14 13 condition_source_value No VARCHAR(50) The source code for the condition as it appears in the source data. This code is mapped to a standard condition concept in the Standardized Vocabularies and the original code is stored here for reference. condition_occurrence cdm
15 14 condition_source_concept_id No INTEGER A foreign key to a Condition Concept that refers to the code used in the source. condition_occurrence cdm
16 15 condition_status_source_value No VARCHAR(50) The source code for the condition status as it appears in the source data. condition_occurrence cdm
17 16 condition_status_concept_id No INTEGER A foreign key to the predefined Concept in the Standard Vocabulary reflecting the condition status condition_occurrence cdm
18 17 person_id Yes INTEGER A foreign key identifier to the deceased person. The demographic details of that person are stored in the person table. death cdm
19 18 death_date Yes DATE The date the person was deceased. If the precise date including day or month is not known or not allowed, December is used as the default month, and the last day of the month the default day. death cdm
20 19 death_datetime No DATETIME The date and time the person was deceased. If the precise date including day or month is not known or not allowed, December is used as the default month, and the last day of the month the default day. death cdm
21 20 death_type_concept_id Yes INTEGER A foreign key referring to the predefined concept identifier in the Standardized Vocabularies reflecting how the death was represented in the source data. death cdm
22 21 cause_concept_id No INTEGER A foreign key referring to a standard concept identifier in the Standardized Vocabularies for conditions. death cdm
23 22 cause_source_value No VARCHAR(50) The source code for the cause of death as it appears in the source data. This code is mapped to a standard concept in the Standardized Vocabularies and the original code is, stored here for reference. death cdm
24 23 cause_source_concept_id No INTEGER A foreign key to the concept that refers to the code used in the source. Note, this variable name is abbreviated to ensure it will be allowable across database platforms. death cdm
25 24 device_exposure_id Yes INTEGER A system-generated unique identifier for each Device Exposure. device_exposure cdm
26 25 person_id Yes INTEGER A foreign key identifier to the Person who is subjected to the Device. The demographic details of that person are stored in the Person table. device_exposure cdm
27 26 device_concept_id Yes INTEGER A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the Device concept. device_exposure cdm
28 27 device_exposure_start_date Yes DATE The date the Device or supply was applied or used. device_exposure cdm
29 28 device_exposure_start_datetime No DATETIME The date and time the Device or supply was applied or used. device_exposure cdm
30 29 device_exposure_end_date No DATE The date the Device or supply was removed from use. device_exposure cdm
31 30 device_exposure_end_datetime No DATETIME The date and time the Device or supply was removed from use. device_exposure cdm
32 31 device_type_concept_id Yes INTEGER A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of Device Exposure recorded. It indicates how the Device Exposure was represented in the source data. device_exposure cdm
33 32 unique_device_id No VARCHAR(50) A UDI or equivalent identifying the instance of the Device used in the Person. device_exposure cdm
34 33 quantity No INTEGER The number of individual Devices used for the exposure. device_exposure cdm
35 34 provider_id No INTEGER A foreign key to the provider in the PROVIDER table who initiated of administered the Device. device_exposure cdm
36 35 visit_occurrence_id No INTEGER A foreign key to the visit in the VISIT_OCCURRENCE table during which the device was used. device_exposure cdm
37 36 visit_detail_id No INTEGER A foreign key to the visit detail in the VISIT_DETAIL table during which the Drug Exposure was initiated. device_exposure cdm
38 37 device_source_value No VARCHAR(50) The source code for the Device as it appears in the source data. This code is mapped to a standard Device Concept in the Standardized Vocabularies and the original code is stored here for reference. device_exposure cdm
39 38 device_source_concept_id No INTEGER A foreign key to a Device Concept that refers to the code used in the source. device_exposure cdm
40 39 drug_exposure_id Yes INTEGER A system-generated unique identifier for each Drug utilization event. drug_exposure cdm
41 40 person_id Yes INTEGER A foreign key identifier to the person who is subjected to the Drug. The demographic details of that person are stored in the person table. drug_exposure cdm
42 41 drug_concept_id Yes INTEGER A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the Drug concept. drug_exposure cdm
43 42 drug_exposure_start_date Yes DATE The start date for the current instance of Drug utilization. Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration procedure was recorded. drug_exposure cdm
44 43 drug_exposure_start_datetime No DATETIME The start date and time for the current instance of Drug utilization. Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration procedure was recorded. drug_exposure cdm
45 44 drug_exposure_end_date Yes DATE The end date for the current instance of Drug utilization. It is not available from all sources. drug_exposure cdm
46 45 drug_exposure_end_datetime No DATETIME The end date and time for the current instance of Drug utilization. It is not available from all sources. drug_exposure cdm
47 46 verbatim_end_date No DATE The known end date of a drug_exposure as provided by the source drug_exposure cdm
48 47 drug_type_concept_id Yes INTEGER A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of Drug Exposure recorded. It indicates how the Drug Exposure was represented in the source data. drug_exposure cdm
49 48 stop_reason No VARCHAR(20) The reason the Drug was stopped. Reasons include regimen completed, changed, removed, etc. drug_exposure cdm
50 49 refills No INTEGER The number of refills after the initial prescription. The initial prescription is not counted, values start with 0. drug_exposure cdm
51 50 quantity No FLOAT The quantity of drug as recorded in the original prescription or dispensing record. drug_exposure cdm
52 51 days_supply No INTEGER The number of days of supply of the medication as recorded in the original prescription or dispensing record. drug_exposure cdm
53 52 sig No VARCHAR(MAX) The directions ("signetur") on the Drug prescription as recorded in the original prescription (and printed on the container) or dispensing record. drug_exposure cdm
54 53 route_concept_id No INTEGER A foreign key to a predefined concept in the Standardized Vocabularies reflecting the route of administration. drug_exposure cdm
55 54 lot_number No VARCHAR(50) An identifier assigned to a particular quantity or lot of Drug product from the manufacturer. drug_exposure cdm
56 55 provider_id No INTEGER A foreign key to the provider in the PROVIDER table who initiated (prescribed or administered) the Drug Exposure. drug_exposure cdm
57 56 visit_occurrence_id No INTEGER A foreign key to the Visit in the VISIT_OCCURRENCE table during which the Drug Exposure was initiated. drug_exposure cdm
58 57 visit_detail_id No INTEGER A foreign key to the Visit Detail in the VISIT_DETAIL table during which the Drug Exposure was initiated. drug_exposure cdm
59 58 drug_source_value No VARCHAR(50) The source code for the Drug as it appears in the source data. This code is mapped to a Standard Drug concept in the Standardized Vocabularies and the original code is, stored here for reference. drug_exposure cdm
60 59 drug_source_concept_id No INTEGER A foreign key to a Drug Concept that refers to the code used in the source. drug_exposure cdm
61 60 route_source_value No VARCHAR(50) The information about the route of administration as detailed in the source. drug_exposure cdm
62 61 dose_unit_source_value No VARCHAR(50) The information about the dose unit as detailed in the source. drug_exposure cdm
63 62 domain_concept_id_1 Yes INTEGER The concept representing the domain of fact one, from which the corresponding table can be inferred. fact_relationship cdm
64 63 fact_id_1 Yes INTEGER The unique identifier in the table corresponding to the domain of fact one. fact_relationship cdm
65 64 domain_concept_id_2 Yes INTEGER The concept representing the domain of fact two, from which the corresponding table can be inferred. fact_relationship cdm
66 65 fact_id_2 Yes INTEGER The unique identifier in the table corresponding to the domain of fact two. fact_relationship cdm
67 66 relationship_concept_id Yes INTEGER A foreign key to a Standard Concept ID of relationship in the Standardized Vocabularies. fact_relationship cdm
68 67 measurement_id Yes INTEGER A unique identifier for each Measurement. measurement cdm
69 68 person_id Yes INTEGER A foreign key identifier to the Person about whom the measurement was recorded. The demographic details of that Person are stored in the PERSON table. measurement cdm
70 69 measurement_concept_id Yes INTEGER A foreign key to the standard measurement concept identifier in the Standardized Vocabularies. measurement cdm
71 70 measurement_date Yes DATE The date of the Measurement. measurement cdm
72 71 measurement_datetime No DATETIME The date and time of the Measurement. Some database systems don't have a datatype of time. To accomodate all temporal analyses, datatype datetime can be used (combining measurement_date and measurement_time [forum discussion](http://forums.ohdsi.org/t/date-time-and-datetime-problem-and-the-world-of-hours-and-1day/314)) measurement cdm
73 72 measurement_time No VARCHAR(10) The time of the Measurement. This is present for backwards compatibility and will deprecated in an upcoming version measurement cdm
74 73 measurement_type_concept_id Yes INTEGER A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the provenance from where the Measurement record was recorded. measurement cdm
75 74 operator_concept_id No INTEGER A foreign key identifier to the predefined Concept in the Standardized Vocabularies reflecting the mathematical operator that is applied to the value_as_number. Operators are <, <=, =, >=, >. measurement cdm
76 75 value_as_number No FLOAT A Measurement result where the result is expressed as a numeric value. measurement cdm
77 76 value_as_concept_id No INTEGER A foreign key to a Measurement result represented as a Concept from the Standardized Vocabularies (e.g., positive/negative, present/absent, low/high, etc.). measurement cdm
78 77 unit_concept_id No INTEGER A foreign key to a Standard Concept ID of Measurement Units in the Standardized Vocabularies. measurement cdm
79 78 range_low No FLOAT The lower limit of the normal range of the Measurement result. The lower range is assumed to be of the same unit of measure as the Measurement value. measurement cdm
80 79 range_high No FLOAT The upper limit of the normal range of the Measurement. The upper range is assumed to be of the same unit of measure as the Measurement value. measurement cdm
81 80 provider_id No INTEGER A foreign key to the provider in the PROVIDER table who was responsible for initiating or obtaining the measurement. measurement cdm
82 81 visit_occurrence_id No INTEGER A foreign key to the Visit in the VISIT_OCCURRENCE table during which the Measurement was recorded. measurement cdm
83 82 visit_detail_id No INTEGER A foreign key to the Visit Detail in the VISIT_DETAIL table during which the Measurement was recorded. measurement cdm
84 83 measurement_source_value No VARCHAR(50) The Measurement name as it appears in the source data. This code is mapped to a Standard Concept in the Standardized Vocabularies and the original code is stored here for reference. measurement cdm
85 84 measurement_source_concept_id No INTEGER A foreign key to a Concept in the Standard Vocabularies that refers to the code used in the source. measurement cdm
86 85 unit_source_value No VARCHAR(50) The source code for the unit as it appears in the source data. This code is mapped to a standard unit concept in the Standardized Vocabularies and the original code is stored here for reference. measurement cdm
87 86 value_source_value No VARCHAR(50) The source value associated with the content of the value_as_number or value_as_concept_id as stored in the source data. measurement cdm
88 87 note_id Yes INTEGER A unique identifier for each note. note cdm
89 88 person_id Yes INTEGER A foreign key identifier to the Person about whom the Note was recorded. The demographic details of that Person are stored in the PERSON table. note cdm
90 89 note_date Yes DATE The date the note was recorded. note cdm
91 90 note_datetime No DATETIME The date and time the note was recorded. note cdm
92 91 note_type_concept_id Yes INTEGER A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the type, origin or provenance of the Note. note cdm
93 92 note_class_concept_id Yes INTEGER A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the HL7 LOINC Document Type Vocabulary classification of the note. note cdm
94 93 note_title No VARCHAR(250) The title of the Note as it appears in the source. note cdm
95 94 note_text Yes VARCHAR(MAX) The content of the Note. note cdm
96 95 encoding_concept_id Yes INTEGER A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the note character encoding type note cdm
97 96 language_concept_id Yes INTEGER A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the language of the note note cdm
98 97 provider_id No INTEGER A foreign key to the Provider in the PROVIDER table who took the Note. note cdm
99 98 visit_occurrence_id No INTEGER A foreign key to the Visit in the VISIT_OCCURRENCE table when the Note was taken. note cdm
100 99 visit_detail_id No INTEGER A foreign key to the Visit in the VISIT_DETAIL table when the Note was taken. note cdm
101 100 note_source_value No VARCHAR(50) The source value associated with the origin of the Note note cdm
102 101 yes integer A UNIQUE IDENTIFIER FOR EACH TERM EXTRACTED FROM A NOTE. NA note_nlp cdm
103 102 yes integer A FOREIGN KEY TO THE NOTE TABLE NOTE THE TERM WAS EXTRACTED FROM. NA note_nlp cdm
104 103 no integer A FOREIGN KEY TO THE PREDEFINED CONCEPT IN THE STANDARDIZED VOCABULARIES REPRESENTING THE SECTION OF THE EXTRACTED TERM. NA note_nlp cdm
105 104 no varchar(250) A SMALL WINDOW OF TEXT SURROUNDING THE TERM. NA note_nlp cdm
106 105 no varchar(50) CHARACTER OFFSET OF THE EXTRACTED TERM IN THE INPUT NOTE. NA note_nlp cdm
107 106 yes varchar(250) RAW TEXT EXTRACTED FROM THE NLP TOOL. NA note_nlp cdm
108 107 no integer A FOREIGN KEY TO THE PREDEFINED CONCEPT IN THE STANDARDIZED VOCABULARIES REFLECTING THE NORMALIZED CONCEPT FOR THE EXTRACTED TERM. DOMAIN OF THE TERM IS REPRESENTED AS PART OF THE CONCEPT TABLE. NA note_nlp cdm
109 108 no integer A FOREIGN KEY TO A CONCEPT THAT REFERS TO THE CODE IN THE SOURCE VOCABULARY USED BY THE NLP SYSTEM NA note_nlp cdm
110 109 no varchar(250) NAME AND VERSION OF THE NLP SYSTEM THAT EXTRACTED THE TERM.USEFUL FOR DATA PROVENANCE. NA note_nlp cdm
111 110 yes date THE DATE OF THE NOTE PROCESSING.USEFUL FOR DATA PROVENANCE. NA note_nlp cdm
112 111 no datetime THE DATE AND TIME OF THE NOTE PROCESSING. USEFUL FOR DATA PROVENANCE. NA note_nlp cdm
113 112 no varchar(1) A SUMMARY MODIFIER THAT SIGNIFIES PRESENCE OR ABSENCE OF THE TERM FOR A GIVEN PATIENT. USEFUL FOR QUICK QUERYING. NA note_nlp cdm
114 113 no varchar(50) AN OPTIONAL TIME MODIFIER ASSOCIATED WITH THE EXTRACTED TERM. (FOR NOW PAST OR PRESENT ONLY). STANDARDIZE IT LATER. NA note_nlp cdm
115 114 no varchar(2000) A COMPACT DESCRIPTION OF ALL THE MODIFIERS OF THE SPECIFIC TERM EXTRACTED BY THE NLP SYSTEM. (E.G. SON HAS RASH ? NEGATED=NO,SUBJECT=FAMILY, CERTAINTY=UNDEF,CONDITIONAL=FALSE,GENERAL=FALSE). NA note_nlp cdm
116 115 observation_id Yes INTEGER A unique identifier for each observation. observation cdm
117 116 person_id Yes INTEGER A foreign key identifier to the Person about whom the observation was recorded. The demographic details of that Person are stored in the PERSON table. observation cdm
118 117 observation_concept_id Yes INTEGER A foreign key to the standard observation concept identifier in the Standardized Vocabularies. observation cdm
119 118 observation_date Yes DATE The date of the observation. observation cdm
120 119 observation_datetime No DATETIME The date and time of the observation. observation cdm
121 120 observation_type_concept_id Yes INTEGER A foreign key to the predefined concept identifier in the Standardized Vocabularies reflecting the type of the observation. observation cdm
122 121 value_as_number No FLOAT The observation result stored as a number. This is applicable to observations where the result is expressed as a numeric value. observation cdm
123 122 value_as_string No VARCHAR(60) The observation result stored as a string. This is applicable to observations where the result is expressed as verbatim text. observation cdm
124 123 value_as_concept_id No INTEGER A foreign key to an observation result stored as a Concept ID. This is applicable to observations where the result can be expressed as a Standard Concept from the Standardized Vocabularies (e.g., positive/negative, present/absent, low/high, etc.). observation cdm
125 124 qualifier_concept_id No INTEGER A foreign key to a Standard Concept ID for a qualifier (e.g., severity of drug-drug interaction alert) observation cdm
126 125 unit_concept_id No INTEGER A foreign key to a Standard Concept ID of measurement units in the Standardized Vocabularies. observation cdm
127 126 provider_id No INTEGER A foreign key to the provider in the PROVIDER table who was responsible for making the observation. observation cdm
128 127 visit_occurrence_id No INTEGER A foreign key to the visit in the VISIT_OCCURRENCE table during which the observation was recorded. observation cdm
129 128 visit_detail_id No INTEGER A foreign key to the visit in the VISIT_DETAIL table during which the observation was recorded. observation cdm
130 129 observation_source_value No VARCHAR(50) The observation code as it appears in the source data. This code is mapped to a Standard Concept in the Standardized Vocabularies and the original code is, stored here for reference. observation cdm
131 130 observation_source_concept_id No INTEGER A foreign key to a Concept that refers to the code used in the source. observation cdm
132 131 unit_source_value No VARCHAR(50) The source code for the unit as it appears in the source data. This code is mapped to a standard unit concept in the Standardized Vocabularies and the original code is, stored here for reference. observation cdm
133 132 qualifier_source_value No VARCHAR(50) The source value associated with a qualifier to characterize the observation observation cdm
134 133 observation_period_id Yes INTEGER A unique identifier for each observation period. observation_period cdm
135 134 person_id Yes INTEGER A foreign key identifier to the person for whom the observation period is defined. The demographic details of that person are stored in the person table. observation_period cdm
136 135 observation_period_start_date Yes DATE The start date of the observation period for which data are available from the data source. observation_period cdm
137 136 observation_period_end_date Yes DATE The end date of the observation period for which data are available from the data source. observation_period cdm
138 137 period_type_concept_id Yes INTEGER A foreign key identifier to the predefined concept in the Standardized Vocabularies reflecting the source of the observation period information observation_period cdm
139 138 person_id Yes INTEGER A unique identifier for each person. person cdm
140 139 gender_concept_id Yes INTEGER A foreign key that refers to an identifier in the CONCEPT table for the unique gender of the person. person cdm
141 140 year_of_birth Yes INTEGER The year of birth of the person. For data sources with date of birth, the year is extracted. For data sources where the year of birth is not available, the approximate year of birth is derived based on any age group categorization available. person cdm
142 141 month_of_birth No INTEGER The month of birth of the person. For data sources that provide the precise date of birth, the month is extracted and stored in this field. person cdm
143 142 day_of_birth No INTEGER The day of the month of birth of the person. For data sources that provide the precise date of birth, the day is extracted and stored in this field. person cdm
144 143 birth_datetime No DATETIME The date and time of birth of the person. person cdm
145 144 race_concept_id Yes INTEGER A foreign key that refers to an identifier in the CONCEPT table for the unique race of the person. person cdm
146 145 ethnicity_concept_id Yes INTEGER A foreign key that refers to the standard concept identifier in the Standardized Vocabularies for the ethnicity of the person. person cdm
147 146 location_id No INTEGER A foreign key to the place of residency for the person in the location table, where the detailed address information is stored. person cdm
148 147 provider_id No INTEGER A foreign key to the primary care provider the person is seeing in the provider table. person cdm
149 148 care_site_id No INTEGER A foreign key to the site of primary care in the care_site table, where the details of the care site are stored. person cdm
150 149 person_source_value No VARCHAR(50) An (encrypted) key derived from the person identifier in the source data. This is necessary when a use case requires a link back to the person data at the source dataset. person cdm
151 150 gender_source_value No VARCHAR(50) The source code for the gender of the person as it appears in the source data. The person’s gender is mapped to a standard gender concept in the Standardized Vocabularies; the original value is stored here for reference. person cdm
152 151 gender_source_concept_id No INTEGER A foreign key to the gender concept that refers to the code used in the source. person cdm
153 152 race_source_value No VARCHAR(50) The source code for the race of the person as it appears in the source data. The person race is mapped to a standard race concept in the Standardized Vocabularies and the original value is stored here for reference. person cdm
154 153 race_source_concept_id No INTEGER A foreign key to the race concept that refers to the code used in the source. person cdm
155 154 ethnicity_source_value No VARCHAR(50) The source code for the ethnicity of the person as it appears in the source data. The person ethnicity is mapped to a standard ethnicity concept in the Standardized Vocabularies and the original code is, stored here for reference. person cdm
156 155 ethnicity_source_concept_id No INTEGER A foreign key to the ethnicity concept that refers to the code used in the source. person cdm
157 156 procedure_occurrence_id Yes INTEGER A system-generated unique identifier for each Procedure Occurrence. procedure_occurrence cdm
158 157 person_id Yes INTEGER A foreign key identifier to the Person who is subjected to the Procedure. The demographic details of that Person are stored in the PERSON table. procedure_occurrence cdm
159 158 procedure_concept_id Yes INTEGER A foreign key that refers to a standard procedure Concept identifier in the Standardized Vocabularies. procedure_occurrence cdm
160 159 procedure_date Yes DATE The date on which the Procedure was performed. procedure_occurrence cdm
161 160 procedure_datetime No DATETIME The date and time on which the Procedure was performed. procedure_occurrence cdm
162 161 procedure_type_concept_id Yes INTEGER A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of source data from which the procedure record is derived. procedure_occurrence cdm
163 162 modifier_concept_id No INTEGER A foreign key to a Standard Concept identifier for a modifier to the Procedure (e.g. bilateral) procedure_occurrence cdm
164 163 quantity No INTEGER The quantity of procedures ordered or administered. procedure_occurrence cdm
165 164 provider_id No INTEGER A foreign key to the provider in the PROVIDER table who was responsible for carrying out the procedure. procedure_occurrence cdm
166 165 visit_occurrence_id No INTEGER A foreign key to the Visit in the VISIT_OCCURRENCE table during which the Procedure was carried out. procedure_occurrence cdm
167 166 visit_detail_id No INTEGER A foreign key to the Visit Detail in the VISIT_DETAIL table during which the Procedure was carried out. procedure_occurrence cdm
168 167 procedure_source_value No VARCHAR(50) The source code for the Procedure as it appears in the source data. This code is mapped to a standard procedure Concept in the Standardized Vocabularies and the original code is, stored here for reference. Procedure source codes are typically ICD-9-Proc, CPT-4, HCPCS or OPCS-4 codes. procedure_occurrence cdm
169 168 procedure_source_concept_id No INTEGER A foreign key to a Procedure Concept that refers to the code used in the source. procedure_occurrence cdm
170 169 modifier_source_value No VARCHAR(50) The source code for the qualifier as it appears in the source data. procedure_occurrence cdm
171 170 specimen_id Yes INTEGER A unique identifier for each specimen. specimen cdm
172 171 person_id Yes INTEGER A foreign key identifier to the Person for whom the Specimen is recorded. specimen cdm
173 172 specimen_concept_id Yes INTEGER A foreign key referring to a Standard Concept identifier in the Standardized Vocabularies for the Specimen. specimen cdm
174 173 specimen_type_concept_id Yes INTEGER A foreign key referring to the Concept identifier in the Standardized Vocabularies reflecting the system of record from which the Specimen was represented in the source data. specimen cdm
175 174 specimen_date Yes DATE The date the specimen was obtained from the Person. specimen cdm
176 175 specimen_datetime No DATETIME The date and time on the date when the Specimen was obtained from the person. specimen cdm
177 176 quantity No FLOAT The amount of specimen collection from the person during the sampling procedure. specimen cdm
178 177 unit_concept_id No INTEGER A foreign key to a Standard Concept identifier for the Unit associated with the numeric quantity of the Specimen collection. specimen cdm
179 178 anatomic_site_concept_id No INTEGER A foreign key to a Standard Concept identifier for the anatomic location of specimen collection. specimen cdm
180 179 disease_status_concept_id No INTEGER A foreign key to a Standard Concept identifier for the Disease Status of specimen collection. specimen cdm
181 180 specimen_source_id No VARCHAR(50) The Specimen identifier as it appears in the source data. specimen cdm
182 181 specimen_source_value No VARCHAR(50) The Specimen value as it appears in the source data. This value is mapped to a Standard Concept in the Standardized Vocabularies and the original code is, stored here for reference. specimen cdm
183 182 unit_source_value No VARCHAR(50) The information about the Unit as detailed in the source. specimen cdm
184 183 anatomic_site_source_value No VARCHAR(50) The information about the anatomic site as detailed in the source. specimen cdm
185 184 disease_status_source_value No VARCHAR(50) The information about the disease status as detailed in the source. specimen cdm
186 185 visit_detail_id Yes INTEGER A unique identifier for each Person's visit or encounter at a healthcare provider. visit_detail cdm
187 186 person_id Yes INTEGER A foreign key identifier to the Person for whom the visit is recorded. The demographic details of that Person are stored in the PERSON table. visit_detail cdm
188 187 visit_concept_id Yes INTEGER A foreign key that refers to a visit Concept identifier in the Standardized Vocabularies. visit_detail cdm
189 188 visit_start_date Yes DATE The start date of the visit. visit_detail cdm
190 189 visit_start_datetime No DATETIME The date and time of the visit started. visit_detail cdm
191 190 visit_end_date Yes DATE The end date of the visit. If this is a one-day visit the end date should match the start date. visit_detail cdm
192 191 visit_end_datetime No DATETIME The date and time of the visit end. visit_detail cdm
193 192 visit_type_concept_id Yes INTEGER A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of source data from which the visit record is derived. visit_detail cdm
194 193 provider_id No INTEGER A foreign key to the provider in the provider table who was associated with the visit. visit_detail cdm
195 194 care_site_id No INTEGER A foreign key to the care site in the care site table that was visited. visit_detail cdm
196 195 visit_source_value No STRING(50) The source code for the visit as it appears in the source data. visit_detail cdm
197 196 visit_source_concept_id No INTEGER A foreign key to a Concept that refers to the code used in the source. visit_detail cdm
198 197 admitting_source_value No VARCHAR(50) The source code for the admitting source as it appears in the source data. visit_detail cdm
199 198 admitting_source_concept_id No INTEGER A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the admitting source for a visit. visit_detail cdm
200 199 discharge_to_source_value No VARCHAR(50) The source code for the discharge disposition as it appears in the source data. visit_detail cdm
201 200 discharge_to_concept_id No INTEGER A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the discharge disposition for a visit. visit_detail cdm
202 201 preceding_visit_detail_id No INTEGER A foreign key to the VISIT_DETAIL table of the visit immediately preceding this visit visit_detail cdm
203 202 visit_detail_parent_id No INTEGER A foreign key to the VISIT_DETAIL table record to represent the immediate parent visit-detail record. visit_detail cdm
204 203 visit_occurrence_id Yes INTEGER A foreign key that refers to the record in the VISIT_OCCURRENCE table. This is a required field, because for every visit_detail is a child of visit_occurrence and cannot exist without a corresponding parent record in visit_occurrence. visit_detail cdm
205 204 visit_occurrence_id Yes INTEGER A unique identifier for each Person's visit or encounter at a healthcare provider. visit_occurrence cdm
206 205 person_id Yes INTEGER A foreign key identifier to the Person for whom the visit is recorded. The demographic details of that Person are stored in the PERSON table. visit_occurrence cdm
207 206 visit_concept_id Yes INTEGER A foreign key that refers to a visit Concept identifier in the Standardized Vocabularies. visit_occurrence cdm
208 207 visit_start_date Yes DATE The start date of the visit. visit_occurrence cdm
209 208 visit_start_datetime No DATETIME The date and time of the visit started. visit_occurrence cdm
210 209 visit_end_date Yes DATE The end date of the visit. If this is a one-day visit the end date should match the start date. visit_occurrence cdm
211 210 visit_end_datetime No DATETIME The date and time of the visit end. visit_occurrence cdm
212 211 visit_type_concept_id Yes INTEGER A foreign key to the predefined Concept identifier in the Standardized Vocabularies reflecting the type of source data from which the visit record is derived. visit_occurrence cdm
213 212 provider_id No INTEGER A foreign key to the provider in the provider table who was associated with the visit. visit_occurrence cdm
214 213 care_site_id No INTEGER A foreign key to the care site in the care site table that was visited. visit_occurrence cdm
215 214 visit_source_value No VARCHAR(50) The source code for the visit as it appears in the source data. visit_occurrence cdm
216 215 visit_source_concept_id No INTEGER A foreign key to a Concept that refers to the code used in the source. visit_occurrence cdm
217 216 admitting_source_concept_id No INTEGER A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the admitting source for a visit. visit_occurrence cdm
218 217 admitting_source_value No VARCHAR(50) The source code for the admitting source as it appears in the source data. visit_occurrence cdm
219 218 discharge_to_concept_id No INTEGER A foreign key to the predefined concept in the Place of Service Vocabulary reflecting the discharge disposition for a visit. visit_occurrence cdm
220 219 discharge_to_source_value No VARCHAR(50) The source code for the discharge disposition as it appears in the source data. visit_occurrence cdm
221 220 preceding_visit_occurrence_id No INTEGER A foreign key to the VISIT_OCCURRENCE table of the visit immediately preceding this visit visit_occurrence cdm
222 221 cohort_definition_id Yes INTEGER A foreign key to a record in the COHORT_DEFINITION table containing relevant Cohort Definition information. cohort results
223 222 subject_id Yes INTEGER A foreign key to the subject in the cohort. These could be referring to records in the PERSON, PROVIDER, VISIT_OCCURRENCE table. cohort results
224 223 cohort_start_date Yes DATE The date when the Cohort Definition criteria for the Person, Provider or Visit first match. cohort results
225 224 cohort_end_date Yes DATE The date when the Cohort Definition criteria for the Person, Provider or Visit no longer match or the Cohort membership was terminated. cohort results
226 225 cohort_definition_id Yes INTEGER A foreign key to a record in the [COHORT_DEFINITION](https://github.com/OHDSI/CommonDataModel/wiki/COHORT_DEFINITION) table containing relevant Cohort Definition information. cohort_attribute results
227 226 subject_id Yes INTEGER A foreign key to the subject in the Cohort. These could be referring to records in the PERSON, PROVIDER, VISIT_OCCURRENCE table. cohort_attribute results
228 227 cohort_start_date Yes DATE The date when the Cohort Definition criteria for the Person, Provider or Visit first match. cohort_attribute results
229 228 cohort_end_date Yes DATE The date when the Cohort Definition criteria for the Person, Provider or Visit no longer match or the Cohort membership was terminated. cohort_attribute results
230 229 attribute_definition_id Yes INTEGER A foreign key to a record in the [ATTRIBUTE_DEFINITION](https://github.com/OHDSI/CommonDataModel/wiki/ATTRIBUTE_DEFINITION) table containing relevant Attribute Definition information. cohort_attribute results
231 230 value_as_number No FLOAT The attribute result stored as a number. This is applicable to attributes where the result is expressed as a numeric value. cohort_attribute results
232 231 value_as_concept_id No INTEGER The attribute result stored as a Concept ID. This is applicable to attributes where the result is expressed as a categorical value. cohort_attribute results
233 232 condition_era_id Yes INTEGER A unique identifier for each Condition Era. condition_era cdm
234 233 person_id Yes INTEGER A foreign key identifier to the Person who is experiencing the Condition during the Condition Era. The demographic details of that Person are stored in the PERSON table. condition_era cdm
235 234 condition_concept_id Yes INTEGER A foreign key that refers to a standard Condition Concept identifier in the Standardized Vocabularies. condition_era cdm
236 235 condition_era_start_date Yes DATE The start date for the Condition Era constructed from the individual instances of Condition Occurrences. It is the start date of the very first chronologically recorded instance of the condition. condition_era cdm
237 236 condition_era_end_date Yes DATE The end date for the Condition Era constructed from the individual instances of Condition Occurrences. It is the end date of the final continuously recorded instance of the Condition. condition_era cdm
238 237 condition_occurrence_count No INTEGER The number of individual Condition Occurrences used to construct the condition era. condition_era cdm
239 238 dose_era_id Yes INTEGER A unique identifier for each Dose Era. dose_era cdm
240 239 person_id Yes INTEGER A foreign key identifier to the Person who is subjected to the drug during the drug era. The demographic details of that Person are stored in the PERSON table. dose_era cdm
241 240 drug_concept_id Yes INTEGER A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the active Ingredient Concept. dose_era cdm
242 241 unit_concept_id Yes INTEGER A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the unit concept. dose_era cdm
243 242 dose_value Yes FLOAT The numeric value of the dose. dose_era cdm
244 243 dose_era_start_date Yes DATE The start date for the drug era constructed from the individual instances of drug exposures. It is the start date of the very first chronologically recorded instance of utilization of a drug. dose_era cdm
245 244 dose_era_end_date Yes DATE The end date for the drug era constructed from the individual instance of drug exposures. It is the end date of the final continuously recorded instance of utilization of a drug. dose_era cdm
246 245 drug_era_id Yes INTEGER A unique identifier for each Drug Era. drug_era cdm
247 246 person_id Yes INTEGER A foreign key identifier to the Person who is subjected to the Drug during the fDrug Era. The demographic details of that Person are stored in the PERSON table. drug_era cdm
248 247 drug_concept_id Yes INTEGER A foreign key that refers to a Standard Concept identifier in the Standardized Vocabularies for the Ingredient Concept. drug_era cdm
249 248 drug_era_start_date Yes DATE The start date for the Drug Era constructed from the individual instances of Drug Exposures. It is the start date of the very first chronologically recorded instance of conutilization of a Drug. drug_era cdm
250 249 drug_era_end_date Yes DATE The end date for the drug era constructed from the individual instance of drug exposures. It is the end date of the final continuously recorded instance of utilization of a drug. drug_era cdm
251 250 drug_exposure_count No INTEGER The number of individual Drug Exposure occurrences used to construct the Drug Era. drug_era cdm
252 251 gap_days No INTEGER The number of days that are not covered by DRUG_EXPOSURE records that were used to make up the era record. drug_era cdm
253 252 cost_id Yes INTEGER A unique identifier for each COST record. cost cdm
254 253 cost_event_id Yes INTEGER A foreign key identifier to the event (e.g. Measurement, Procedure, Visit, Drug Exposure, etc) record for which cost data are recorded. cost cdm
255 254 cost_domain_id Yes VARCHAR(20) The concept representing the domain of the cost event, from which the corresponding table can be inferred that contains the entity for which cost information is recorded. cost cdm
256 255 cost_type_concept_id Yes INTEGER A foreign key identifier to a concept in the CONCEPT table for the provenance or the source of the COST data: Calculated from insurance claim information, provider revenue, calculated from cost-to-charge ratio, reported from accounting database, etc. cost cdm
257 256 currency_concept_id No INTEGER A foreign key identifier to the concept representing the 3-letter code used to delineate international currencies, such as USD for US Dollar. cost cdm
258 257 total_charge No FLOAT The total amount charged by some provider of goods or services (e.g. hospital, physician pharmacy, dme provider) to payers (insurance companies, the patient). cost cdm
259 258 total_cost No FLOAT The cost incurred by the provider of goods or services. cost cdm
260 259 total_paid No FLOAT The total amount actually paid from all payers for goods or services of the provider. cost cdm
261 260 paid_by_payer No FLOAT The amount paid by the Payer for the goods or services. cost cdm
262 261 paid_by_patient No FLOAT The total amount paid by the Person as a share of the expenses. cost cdm
263 262 paid_patient_copay No FLOAT The amount paid by the Person as a fixed contribution to the expenses. cost cdm
264 263 paid_patient_coinsurance No FLOAT The amount paid by the Person as a joint assumption of risk. Typically, this is a percentage of the expenses defined by the Payer Plan after the Person's deductible is exceeded. cost cdm
265 264 paid_patient_deductible No FLOAT The amount paid by the Person that is counted toward the deductible defined by the Payer Plan. paid_patient_deductible does contribute to the paid_by_patient variable. cost cdm
266 265 paid_by_primary No FLOAT The amount paid by a primary Payer through the coordination of benefits. cost cdm
267 266 paid_ingredient_cost No FLOAT The amount paid by the Payer to a pharmacy for the drug, excluding the amount paid for dispensing the drug. paid_ingredient_cost contributes to the paid_by_payer field if this field is populated with a nonzero value. cost cdm
268 267 paid_dispensing_fee No FLOAT The amount paid by the Payer to a pharmacy for dispensing a drug, excluding the amount paid for the drug ingredient. paid_dispensing_fee contributes to the paid_by_payer field if this field is populated with a nonzero value. cost cdm
269 268 payer_plan_period_id No INTEGER A foreign key to the PAYER_PLAN_PERIOD table, where the details of the Payer, Plan and Family are stored. Record the payer_plan_id that relates to the payer who contributed to the paid_by_payer field. cost cdm
270 269 amount_allowed No FLOAT The contracted amount agreed between the payer and provider. cost cdm
271 270 revenue_code_concept_id No INTEGER A foreign key referring to a Standard Concept ID in the Standardized Vocabularies for Revenue codes. cost cdm
272 271 revenue_code_source_value No VARCHAR(50) The source code for the Revenue code as it appears in the source data, stored here for reference. cost cdm
273 272 drg_concept_id No INTEGER A foreign key to the predefined concept in the DRG Vocabulary reflecting the DRG for a visit. cost cdm
274 273 drg_source_value No VARCHAR(3) The 3-digit DRG source code as it appears in the source data. cost cdm
275 274 payer_plan_period_id Yes INTEGER A identifier for each unique combination of payer, sponsor, plan, family code and time span. payer_plan_period cdm
276 275 person_id Yes INTEGER A foreign key identifier to the Person covered by the payer. The demographic details of that Person are stored in the PERSON table. payer_plan_period cdm
277 276 payer_plan_period_start_date Yes DATE The start date of the payer plan period. payer_plan_period cdm
278 277 payer_plan_period_end_date Yes DATE The end date of the payer plan period. payer_plan_period cdm
279 278 payer_concept_id No INTEGER A foreign key that refers to a Standard Payer concept identifiers in the Standardized Vocabularies payer_plan_period cdm
280 279 payer_source_value No VARCHAR(50) The source code for the payer as it appears in the source data. payer_plan_period cdm
281 280 payer_source_concept_id No INTEGER A foreign key to a payer concept that refers to the code used in the source. payer_plan_period cdm
282 281 plan_concept_id No INTEGER A foreign key that refers to a Standard plan that represents the health benefit plan in the Standardized Vocabularies payer_plan_period cdm
283 282 plan_source_value No VARCHAR(50) The source code for the Person's health benefit plan as it appears in the source data. payer_plan_period cdm
284 283 plan_source_concept_id No INTEGER A foreign key to a plan concept that refers to the code used in the source. payer_plan_period cdm
285 284 sponsor_concept_id No INTEGER A foreign key that refers to a Standard plan that represents the sponsor in the Standardized Vocabularies payer_plan_period cdm
286 285 sponsor_source_value No VARCHAR(50) The source code for the Person's sponsor of the health plan as it appears in the source data. payer_plan_period cdm
287 286 sponsor_source_concept_id* No INTEGER A foreign key to a sponsor concept that refers to the code used in the source. payer_plan_period cdm
288 287 family_source_value No VARCHAR(50) The source code for the Person's family as it appears in the source data. payer_plan_period cdm
289 288 stop_reason_concept_id No INTEGER A foreign key that refers to a Standard termination reason that represents the reason for the termination in the Standardized Vocabularies. payer_plan_period cdm
290 289 stop_reason_source_value No VARCHAR(50) The reason for stop-coverage of the record. payer_plan_period cdm
291 290 stop_reason_source_concept_id No INTEGER A foreign key to a stop-coverage concept that refers to the code used in the source. payer_plan_period cdm
292 291 care_site_id Yes INTEGER A unique identifier for each Care Site. care_site cdm
293 292 care_site_name No VARCHAR(255) The verbatim description or name of the Care Site as in data source care_site cdm
294 293 place_of_service_concept_id No INTEGER A foreign key that refers to a Place of Service Concept ID in the Standardized Vocabularies. care_site cdm
295 294 location_id No INTEGER A foreign key to the geographic Location in the LOCATION table, where the detailed address information is stored. care_site cdm
296 295 care_site_source_value No VARCHAR(50) The identifier for the Care Site in the source data, stored here for reference. care_site cdm
297 296 place_of_service_source_value No VARCHAR(50) The source code for the Place of Service as it appears in the source data, stored here for reference. care_site cdm
298 297 location_id Yes INTEGER A unique identifier for each geographic location. location cdm
299 298 address_1 No VARCHAR(50) The address field 1, typically used for the street address, as it appears in the source data. location cdm
300 299 address_2 No VARCHAR(50) The address field 2, typically used for additional detail such as buildings, suites, floors, as it appears in the source data. location cdm
301 300 city No VARCHAR(50) The city field as it appears in the source data. location cdm
302 301 state No VARCHAR(2) The state field as it appears in the source data. location cdm
303 302 zip No VARCHAR(9) The zip or postal code. location cdm
304 303 county No VARCHAR(20) The county. location cdm
305 304 location_source_value No VARCHAR(50) The verbatim information that is used to uniquely identify the location as it appears in the source data. location cdm
306 305 provider_id Yes INTEGER A unique identifier for each Provider. provider cdm
307 306 provider_name No VARCHAR(255) A description of the Provider. provider cdm
308 307 npi No VARCHAR(20) The National Provider Identifier (NPI) of the provider. provider cdm
309 308 dea No VARCHAR(20) The Drug Enforcement Administration (DEA) number of the provider. provider cdm
310 309 specialty_concept_id No INTEGER A foreign key to a Standard Specialty Concept ID in the Standardized Vocabularies. provider cdm
311 310 care_site_id No INTEGER A foreign key to the main Care Site where the provider is practicing. provider cdm
312 311 year_of_birth No INTEGER The year of birth of the Provider. provider cdm
313 312 gender_concept_id No INTEGER The gender of the Provider. provider cdm
314 313 provider_source_value No VARCHAR(50) The identifier used for the Provider in the source data, stored here for reference. provider cdm
315 314 specialty_source_value No VARCHAR(50) The source code for the Provider specialty as it appears in the source data, stored here for reference. provider cdm
316 315 specialty_source_concept_id No INTEGER A foreign key to a Concept that refers to the code used in the source. provider cdm
317 316 gender_source_value No VARCHAR(50) The gender code for the Provider as it appears in the source data, stored here for reference. provider cdm
318 317 gender_source_concept_id No INTEGER A foreign key to a Concept that refers to the code used in the source. provider cdm
319 318 cdm_source_name Yes VARCHAR(255) The full name of the source cdm_source cdm
320 319 cdm_source_abbreviation No VARCHAR(25) An abbreviation of the name cdm_source cdm
321 320 cdm_holder No VARCHAR(255) The name of the organization responsible for the development of the CDM instance cdm_source cdm
322 321 source_description No CLOB A description of the source data origin and purpose for collection. The description may contain a summary of the period of time that is expected to be covered by this dataset. cdm_source cdm
323 322 source_documentation_reference No VARCHAR(255) URL or other external reference to location of source documentation cdm_source cdm
324 323 cdm_etl_reference No VARCHAR(255) URL or other external reference to location of ETL specification documentation and ETL source code cdm_source cdm
325 324 source_release_date No DATE The date for which the source data are most current, such as the last day of data capture cdm_source cdm
326 325 cdm_release_date No DATE The date when the CDM was instantiated cdm_source cdm
327 326 cdm_version No VARCHAR(10) The version of CDM used cdm_source cdm
328 327 vocabulary_version No VARCHAR(20) The version of the vocabulary used cdm_source cdm
329 328 metadata_concept_id Yes INTEGER A foreign key that refers to a Standard Metadata Concept identifier in the Standardized Vocabularies. metadata cdm
330 329 metadata_type_concept_id Yes INTEGER A foreign key that refers to a Standard Type Concept identifier in the Standardized Vocabularies. metadata cdm
331 330 name Yes VARCHAR(250) The name of the Concept stored in metadata_concept_id or a description of the data being stored. metadata cdm
332 331 value_as_string No NVARCHAR The metadata value stored as a string. metadata cdm
333 332 value_as_concept_id No INTEGER A foreign key to a metadata value stored as a Concept ID. metadata cdm
334 333 metadata date No DATE The date associated with the metadata metadata cdm
335 334 metadata_datetime No DATETIME The date and time associated with the metadata metadata cdm
336 335 attribute_definition_id Yes INTEGER A unique identifier for each Attribute. attribute_definition cdm
337 336 attribute_name Yes VARCHAR(255) A short description of the Attribute. attribute_definition cdm
338 337 attribute_description No VARCHAR(MAX) A complete description of the Attribute definition attribute_definition cdm
339 338 attribute_type_concept_id Yes INTEGER Type defining what kind of Attribute Definition the record represents and how the syntax may be executed attribute_definition cdm
340 339 attribute_syntax No VARCHAR(MAX) Syntax or code to operationalize the Attribute definition attribute_definition cdm
341 340 cohort_definition_id Yes INTEGER A unique identifier for each Cohort. cohort_definition cdm
342 341 cohort_definition_name Yes VARCHAR(255) A short description of the Cohort. cohort_definition cdm
343 342 cohort_definition_description No VARCHAR(MAX) A complete description of the Cohort definition cohort_definition cdm
344 343 definition_type_concept_id Yes INTEGER Type defining what kind of Cohort Definition the record represents and how the syntax may be executed cohort_definition cdm
345 344 cohort_definition_syntax No VARCHAR(MAX) Syntax or code to operationalize the Cohort definition cohort_definition cdm
346 345 subject_concept_id Yes INTEGER A foreign key to the Concept to which defines the domain of subjects that are members of the cohort (e.g., Person, Provider, Visit). cohort_definition cdm
347 346 cohort_initiation_date No DATE A date to indicate when the Cohort was initiated in the COHORT table cohort_definition cdm
348 347 concept_id Yes INTEGER A unique identifier for each Concept across all domains. concept cdm
349 348 concept_name Yes VARCHAR(255) An unambiguous, meaningful and descriptive name for the Concept. concept cdm
350 349 domain_id Yes VARCHAR(20) A foreign key to the [DOMAIN](https://github.com/OHDSI/CommonDataModel/wiki/DOMAIN) table the Concept belongs to. concept cdm
351 350 vocabulary_id Yes VARCHAR(20) A foreign key to the [VOCABULARY](https://github.com/OHDSI/CommonDataModel/wiki/VOCABULARY) table indicating from which source the Concept has been adapted. concept cdm
352 351 concept_class_id Yes VARCHAR(20) The attribute or concept class of the Concept. Examples are 'Clinical Drug', 'Ingredient', 'Clinical Finding' etc. concept cdm
353 352 standard_concept No VARCHAR(1) This flag determines where a Concept is a Standard Concept, i.e. is used in the data, a Classification Concept, or a non-standard Source Concept. The allowables values are 'S' (Standard Concept) and 'C' (Classification Concept), otherwise the content is NULL. concept cdm
354 353 concept_code Yes VARCHAR(50) The concept code represents the identifier of the Concept in the source vocabulary, such as SNOMED-CT concept IDs, RxNorm RXCUIs etc. Note that concept codes are not unique across vocabularies. concept cdm
355 354 valid_start_date Yes DATE The date when the Concept was first recorded. The default value is 1-Jan-1970, meaning, the Concept has no (known) date of inception. concept cdm
356 355 valid_end_date Yes DATE The date when the Concept became invalid because it was deleted or superseded (updated) by a new concept. The default value is 31-Dec-2099, meaning, the Concept is valid until it becomes deprecated. concept cdm
357 356 invalid_reason No VARCHAR(1) Reason the Concept was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value. concept cdm
358 357 ancestor_concept_id Yes INTEGER A foreign key to the concept in the concept table for the higher-level concept that forms the ancestor in the relationship. concept_ancestor cdm
359 358 descendant_concept_id Yes INTEGER A foreign key to the concept in the concept table for the lower-level concept that forms the descendant in the relationship. concept_ancestor cdm
360 359 min_levels_of_separation Yes INTEGER The minimum separation in number of levels of hierarchy between ancestor and descendant concepts. This is an attribute that is used to simplify hierarchic analysis. concept_ancestor cdm
361 360 max_levels_of_separation Yes INTEGER The maximum separation in number of levels of hierarchy between ancestor and descendant concepts. This is an attribute that is used to simplify hierarchic analysis. concept_ancestor cdm
362 361 concept_class_id Yes VARCHAR(20) A unique key for each class. concept_class cdm
363 362 concept_class_name Yes VARCHAR(255) The name describing the Concept Class, e.g. "Clinical Finding", "Ingredient", etc. concept_class cdm
364 363 concept_class_concept_id Yes INTEGER A foreign key that refers to an identifier in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table for the unique Concept Class the record belongs to. concept_class cdm
365 364 concept_id_1 Yes INTEGER A foreign key to a Concept in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table associated with the relationship. Relationships are directional, and this field represents the source concept designation. concept_relationship cdm
366 365 concept_id_2 Yes INTEGER A foreign key to a Concept in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table associated with the relationship. Relationships are directional, and this field represents the destination concept designation. concept_relationship cdm
367 366 relationship_id Yes VARCHAR(20) A unique identifier to the type or nature of the Relationship as defined in the [RELATIONSHIP](https://github.com/OHDSI/CommonDataModel/wiki/RELATIONSHIP) table. concept_relationship cdm
368 367 valid_start_date Yes DATE The date when the instance of the Concept Relationship is first recorded. concept_relationship cdm
369 368 valid_end_date Yes DATE The date when the Concept Relationship became invalid because it was deleted or superseded (updated) by a new relationship. Default value is 31-Dec-2099. concept_relationship cdm
370 369 invalid_reason No VARCHAR(1) Reason the relationship was invalidated. Possible values are 'D' (deleted), 'U' (replaced with an update) or NULL when valid_end_date has the default value. concept_relationship cdm
371 370 concept_id Yes INTEGER A foreign key to the Concept in the CONCEPT table. concept_synonym cdm
372 371 concept_synonym_name Yes VARCHAR(1000) The alternative name for the Concept. concept_synonym cdm
373 372 language_concept_id Yes INTEGER A foreign key to a Concept representing the language. concept_synonym cdm
374 373 domain_id Yes VARCHAR(20) A unique key for each domain. domain cdm
375 374 domain_name Yes VARCHAR(255) The name describing the Domain, e.g. "Condition", "Procedure", "Measurement" etc. domain cdm
376 375 domain_concept_id Yes INTEGER A foreign key that refers to an identifier in the [CONCEPT](https://github.com/OHDSI/CommonDataModel/wiki/CONCEPT) table for the unique Domain Concept the Domain record belongs to. domain cdm
377 376 drug_concept_id Yes INTEGER A foreign key to the Concept in the CONCEPT table representing the identifier for Branded Drug or Clinical Drug Concept. drug_strength cdm
378 377 ingredient_concept_id Yes INTEGER A foreign key to the Concept in the CONCEPT table, representing the identifier for drug Ingredient Concept contained within the drug product. drug_strength cdm
379 378 amount_value No FLOAT The numeric value associated with the amount of active ingredient contained within the product. drug_strength cdm
380 379 amount_unit_concept_id No INTEGER A foreign key to the Concept in the CONCEPT table representing the identifier for the Unit for the absolute amount of active ingredient. drug_strength cdm
381 380 numerator_value No FLOAT The numeric value associated with the concentration of the active ingredient contained in the product drug_strength cdm
382 381 numerator_unit_concept_id No INTEGER A foreign key to the Concept in the CONCEPT table representing the identifier for the numerator Unit for the concentration of active ingredient. drug_strength cdm
383 382 denominator_value No FLOAT The amount of total liquid (or other divisible product, such as ointment, gel, spray, etc.). drug_strength cdm
384 383 denominator_unit_concept_id No INTEGER A foreign key to the Concept in the CONCEPT table representing the identifier for the denominator Unit for the concentration of active ingredient. drug_strength cdm
385 384 box_size No INTEGER The number of units of Clinical of Branded Drug, or Quantified Clinical or Branded Drug contained in a box as dispensed to the patient drug_strength cdm
386 385 valid_start_date Yes DATE The date when the Concept was first recorded. The default value is 1-Jan-1970. drug_strength cdm
387 386 valid_end_date Yes DATE The date when the concept became invalid because it was deleted or superseded (updated) by a new Concept. The default value is 31-Dec-2099. drug_strength cdm
388 387 invalid_reason No VARCHAR(1) Reason the concept was invalidated. Possible values are 'D' (deleted), 'U' (replaced with an update) or NULL when valid_end_date has the default value. drug_strength cdm
389 388 relationship_id Yes VARCHAR(20) The type of relationship captured by the relationship record. relationship cdm
390 389 relationship_name Yes VARCHAR(255) The text that describes the relationship type. relationship cdm
391 390 is_hierarchical Yes VARCHAR(1) Defines whether a relationship defines concepts into classes or hierarchies. Values are 1 for hierarchical relationship or 0 if not. relationship cdm
392 391 defines_ancestry Yes VARCHAR(1) Defines whether a hierarchical relationship contributes to the concept_ancestor table. These are subsets of the hierarchical relationships. Valid values are 1 or 0. relationship cdm
393 392 reverse_relationship_id Yes VARCHAR(20) The identifier for the relationship used to define the reverse relationship between two concepts. relationship cdm
394 393 relationship_concept_id Yes INTEGER A foreign key that refers to an identifier in the CONCEPT table for the unique relationship concept. relationship cdm
395 394 source_code Yes VARCHAR(50) The source code being translated into a Standard Concept. source_to_concept_map cdm
396 395 source_concept_id Yes INTEGER A foreign key to the Source Concept that is being translated into a Standard Concept. source_to_concept_map cdm
397 396 source_vocabulary_id Yes VARCHAR(20) A foreign key to the VOCABULARY table defining the vocabulary of the source code that is being translated to a Standard Concept. source_to_concept_map cdm
398 397 source_code_description No VARCHAR(255) An optional description for the source code. This is included as a convenience to compare the description of the source code to the name of the concept. source_to_concept_map cdm
399 398 target_concept_id Yes INTEGER A foreign key to the target Concept to which the source code is being mapped. source_to_concept_map cdm
400 399 target_vocabulary_id Yes VARCHAR(20) A foreign key to the VOCABULARY table defining the vocabulary of the target Concept. source_to_concept_map cdm
401 400 valid_start_date Yes DATE The date when the mapping instance was first recorded. source_to_concept_map cdm
402 401 valid_end_date Yes DATE The date when the mapping instance became invalid because it was deleted or superseded (updated) by a new relationship. Default value is 31-Dec-2099. source_to_concept_map cdm
403 402 invalid_reason No VARCHAR(1) Reason the mapping instance was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value. source_to_concept_map cdm
404 403 vocabulary_id Yes VARCHAR(20) A unique identifier for each Vocabulary, such as ICD9CM, SNOMED, Visit. vocabulary cdm
405 404 vocabulary_name Yes VARCHAR(255) The name describing the vocabulary, for example "International Classification of Diseases, Ninth Revision, Clinical Modification, Volume 1 and 2 (NCHS)" etc. vocabulary cdm
406 405 vocabulary_reference Yes VARCHAR(255) External reference to documentation or available download of the about the vocabulary. vocabulary cdm
407 406 vocabulary_version No VARCHAR(255) Version of the Vocabulary as indicated in the source. vocabulary cdm
408 407 vocabulary_concept_id Yes INTEGER A foreign key that refers to a standard concept identifier in the CONCEPT table for the Vocabulary the VOCABULARY record belongs to. vocabulary cdm

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,121 @@
cdmTableName,schema,isRequired,conceptPrefix,measurePersonCompleteness,measurePersonCompletenessThreshold,validation,tableDescription,userGuidance,etlConventions
PERSON,CDM,Yes,,No,,,"This table serves as the central identity management for of all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information.",All records in this table are independent Persons.,"All Persons in a database need one record in this table, unless they fail data quality requirements specified in the ETL. Persons with no Events should have a record nonetheless. If more than one data source contributes Events to the database, Persons must be reconciled across the sources to create one single record per Person. The content of the BIRTH_DATETIME must be equivalent to the content of BIRTH_DAY, BIRTH_MONTH and BIRTH_YEAR."
OBSERVATION_PERIOD,CDM,Yes,,Yes,0,,"This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.","For each Person, one or more OBSERVATION_PERIOD records may be present, but they will not overlap or be back to back to each other. Events may exist outside all of the time spans of the OBSERVATION_PERIOD records for a patient, however, absence of an Event outside these time spans cannot be construed as evidence of absence of an Event. Incidence or prevalence rates should only be calculated for the time of active OBSERVATION_PERIOD records. When constructing cohorts, outside Events can be used for inclusion criteria definition, but without any guarantee for the performance of these criteria. Also, OBSERVATION_PERIOD records can be as short as a single day, greatly disturbing the denominator of any rate calculation as part of cohort characterizations. To avoid that, apply minimal observation time as a requirement for any cohort definition.","Each Person needs to have at least one OBSERVATION_PERIOD record, which should be represent time intervals with a high capture rate of Clinical Events. Some source data have very similar concepts, such as enrolment periods in insurance claims data. In other source data such as most EHR systems these time spans need to be inferred under a set of assumptions. It is the discretion of the ETL developer to define these assumptions. In many ETL solutions the start date of the first occurrence or the first high quality occurrence of a Clinical Event (Condition, Drug, Procedure, Device, Measurement, Visit) is defined as the start of the OBSERVATION_PERIOD record, and the end date of the last occurrence of last high quality occurrence of a Clinical Event, or the end of the database period becomes the end of the OBSERVATOIN_PERIOD for each Person. If a Person only has a single Clinical Event the OBSERVATION_PERIOD record can be as short as one day. Depending on these definitions it is possible, that Clinical Events fall outside the time spans defined by OBSERVATION_PERIOD records. Family history or history of Clinical Events generally are not used to generate OBSERVATION_PERIOD records around the time they are referring to. Any two overlapping or adjacent OBSERVATION_PERIOD records have to be merged into one."
VISIT_OCCURRENCE,CDM,No,VISIT_,Yes,0,,"This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called ""Encounters"". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed. ","The configuration defining the Visit are described by Concepts in the Visit Domain, which form a hierarchical structure, but rolling up to generally familiar Visits adopted in most healthcare systems worldwide:
- Inpatient Visit: Person visiting hospital, at a Care Site, in bed, for duration of more than one day, with physicians and other Providers permanently available to deliver service around the clock
- Emergency Room Visit: Person visiting dedicated healthcare institution for treating emergencies, at a Care Site, within one day, with physicians and Providers permanently available to deliver service around the clock
- Emergency Room and Inpatient Visit: Person visiting ER follwed by a subsequent Inpatient Visit, where Emergency department is part of hospital, and transition from the ER to other hospital departments is undefined
- Non-hospital institution Visit: Person visiting dedicated institution for reasons of poor health, at a Care Site, long-term or permanently, with no physician but possibly other Providers permanently available to deliver service around the clock
- Outpatient Visit: Person visiting dedicated ambulatory healthcare institution, at a Care Site, within one day, without bed, with physicians or medical Providers delivering service during Visit
- Home Visit: Provider visiting Person, without a Care Site, within one day, delivering service
- Telehealth Visit: Patient engages with Provider through communication media
- Pharmacy Visit: Person visiting pharmacy for dispensing of Drug, at a Care Site, within one day
- Laboratory Visit: Patient visiting dedicated institution, at a Care Site, within one day, for the purpose of a Measurement.
- Ambulance Visit: Person using transportation service for the purpose of initiating one of the other Visits, without a Care Site, within one day, potentially with Providers accompanying the Visit and delivering service
- Case Management Visit: Person interacting with healthcare system, without a Care Site, within a day, with no Providers involved, for administrative purposes
The Visit duration, or 'length of stay', is defined as VISIT_END_DATE - VISIT_START_DATE. For all Visits this is <1 day, except Inpatient Visits and Non-hospital institution Visits. The CDM also contains the VISIT_DETAIL table where additional information about the Visit is stored, for example, transfers between units during an inpatient Visit.","Visits can be derived easily if the source data contain coding systems for Place of Service or Procedures, like CPT codes for well visits. In those cases, the codes can be looked up and mapped to a Standard Visit Concept. Otherwise, Visit Concepts have to be identified in the ETL process. This table will contain concepts in the Visit domain. These concepts are arranged in a hierarchical structure to facilitate cohort definitions by rolling up to generally familiar Visits adopted in most healthcare systems worldwide. Visits can be adjacent to each other, i.e. the end date of one can be identical with the start date of the other. As a consequence, more than one-day Visits or their descendants can be recorded for the same day. Multi-day visits must not overlap, i.e. share days other than start and end days. It is often the case that some logic should be written for how to define visits and how to assign Visit_Concept_Id. For example, in US claims outpatient visits that appear to occur within the time period of an inpatient visit can be rolled into one with the same Visit_Occurrence_Id. In EHR data inpatient visits that are within one day of each other may be strung together to create one visit. It will all depend on the source data and how encounter records should be translated to visit occurrences. Providers can be associated with a Visit through the PROVIDER_ID field, or indirectly through PROCEDURE_OCCURRENCE records linked both to the VISIT and PROVIDER tables."
CONDITION_OCCURRENCE,CDM,No,CONDITION_,Yes,0,,"This table contains records of Events of a Person suggesting the presence of a disease or medical condition stated as a diagnosis, a sign, or a symptom, which is either observed by a Provider or reported by the patient.","Conditions span a time interval from start to end, but are typically recorded as single snapshot records with no end date. The reason is twofold: (i) At the time of the recording the duration is not known and later not recorded, and (ii) the Persons typically cease interacting with the healthcare system when they feel better, which leads to incomplete capture of resolved Conditions. The CONDITION_ERA table addresses this issue. Conditions are defined by Concepts from the Condition domain, which form a complex hierarchy. As a result, the same Person with the same disease may have multiple Condition records, which belong to the same hierarchical family. Most Condition records are mapped from diagnostic codes, but recorded signs, symptoms and summary descriptions also contribute to this table. Rule out diagnosis should not be recorded in this table, but in reality their negating nature is not always captured in the source data, and other precautions must be taken when when identifying Persons who should suffer from the recorded Condition.","Source codes and source text fields mapped to Standard Concepts of the Condition Domain have to be recorded here. Family history and past diagnoses ('history of') are not recorded in this table. Instead, they are listed in the OBSERVATION table. Codes written in the process of establishing the diagnosis, such as 'question of' of and 'rule out', should not represented here. Instead, they should be recorded in the OBSERVATION table, if they are used for analyses. However, this information is not always available."
DRUG_EXPOSURE,CDM,No,DRUG_,Yes,0,,This table captures records about the exposure to a Drug ingested or otherwise introduced into the body. A Drug is a biochemical substance formulated in such a way that when administered to a Person it will exert a certain biochemical effect on the metabolism.,"Drugs include prescription and over-the-counter medicines, vaccines, and large-molecule biologic therapies. ","When the Drug Source Value of the code cannot be translated into Standard Drug Concept IDs, a Drug exposure entry is stored with only the corresponding SOURCE_CONCEPT_ID and DRUG_SOURCE_VALUE and a DRUG_CONCEPT_ID of 0. The Drug Concept with the most detailed content of information is preferred during the mapping process. These are indicated in the CONCEPT_CLASS_ID field of the Concept and are recorded in the following order of precedence: 'Branded Pack', 'Clinical Pack', 'Branded Drug', 'Clinical Drug', 'Branded Drug Component', 'Clinical Drug Component', 'Branded Drug Form', 'Clinical Drug Form', and only if no other information is available 'Ingredient'. Note: If only the drug class is known, the DRUG_CONCEPT_ID field should contain 0."
PROCEDURE_OCCURRENCE,CDM,No,PROCEDURE_,Yes,0,,"The PROCEDURE_OCCURRENCE table contains records of activities or processes ordered by, or carried out by, a healthcare provider on the patient to have a diagnostic or therapeutic purpose.",,"Procedures are expected to be carried out within one day and therefore have no end date. When dealing with duplicate records, the ETL must determine whether to sum them up into one record or keep them separate. Things to consider are:
- Same Procedure
- Same PROCEDURE_DATETIME
- Same Visit Occurrence or Visit Detail
- Same Provider
- Same Modifier for Procedures
- Same COST_ID"
DEVICE_EXPOSURE,CDM,No,DEVICE_,Yes,0,,"The Device domain captures information about a person's exposure to a foreign physical object or instrument which is used for diagnostic or therapeutic purposes through a mechanism beyond chemical action. Devices include implantable objects (e.g. pacemakers, stents, artificial joints), medical equipment and supplies (e.g. bandages, crutches, syringes), other instruments used in medical procedures (e.g. sutures, defibrillators) and material used in clinical care (e.g. adhesives, body material, dental material, surgical material).","The distinction between Devices or supplies and Procedures are sometimes blurry, but the former are physical objects while the latter are actions, often to apply a Device or supply.","When dealing with duplicate records, the ETL must determine whether to sum them up into one record or keep them separate. Things to consider are:
- Same Device/Procedure
- Same DEVICE_EXPOSURE_START_DATETIME
- Same Visit Occurrence or Visit Detail
- Same Provider
- Same Modifier for Procedures
- Same COST_ID"
MEASUREMENT,CDM,No,MEASUREMENT_,Yes,0,,"The MEASUREMENT table contains records of Measurement, i.e. structured values (numerical or categorical) obtained through systematic and standardized examination or testing of a Person or Person's sample. The MEASUREMENT table contains both orders and results of such Measurements as laboratory tests, vital signs, quantitative findings from pathology reports, etc. Measurements are stored as attribute value pairs, with the attribute as the Measurement Concept and the value representing the result. The value can be a Concept (stored in VALUE_AS_CONCEPT), or a numerical value (VALUE_AS_NUMBER) with a Unit (UNIT_CONCEPT_ID).","Measurements differ from Observations in that they require a standardized test or some other activity to generate a quantitative or qualitative result. For example, LOINC 1755-8 concept_id 3027035 'Albumin [Mass/time] in 24 hour Urine' is the lab test to measure a certain chemical in a urine sample. Even though each Measurement always have a result, the fields VALUE_AS_NUMBER and VALUE_AS_CONCEPT_ID are not mandatory. When the result is not known, the Measurement record represents just the fact that the corresponding Measurement was carried out, which in itself is already useful information for some use cases.","Even though each Measurement always have a result, the fields VALUE_AS_NUMBER and VALUE_AS_CONCEPT_ID are not mandatory. When the result is not known, the Measurement record represents just the fact that the corresponding Measurement was carried out, which in itself is already useful information for some use cases. For some Measurement Concepts, the result is included in the test. For example, ICD10 concept_id 45595451 'Presence of alcohol in blood, level not specified' indicates a Measurement and the result (present). In those situations, the CONCEPT_RELATIONSHIP table in addition to the 'Maps to' record contains a second record with the relationship_id set to 'Maps to value'. In this example, the 'Maps to' relationship directs to 4041715 'Blood ethanol measurement' as well as a 'Maps to value' record to 4181412 'Present'."
VISIT_DETAIL,CDM,No,VISIT_DETAIL_,Yes,0,,The VISIT_DETAIL table is an optional table used to represents details of each record in the parent visit_occurrence table. For every record in visit_occurrence table there may be 0 or more records in the visit_detail table with a 1:n relationship where n may be 0. The visit_detail table is structurally very similar to visit_occurrence table and belongs to the similar domain as the visit.,,
NOTE,CDM,No,,Yes,0,,The NOTE table captures unstructured information that was recorded by a provider about a patient in free text notes on a given date.,,"The NOTE table contains free text (in ASCII, or preferably in UTF8 format). The type of note_text is CLOB or varchar(MAX) depending on RDBMS. Mapping of clinical documents to Clinical Document Ontology (CDO) and standard terminology
HL7/LOINC CDO is a standard for consistent naming of documents to support a range of use cases: retrieval, organization, display, and exchange. It guides the creation of LOINC codes for clinical notes. CDO annotates each document with 5 dimensions:
Kind of Document: Characterizes the general structure of the document at a macro level (e.g. Anesthesia Consent)
Type of Service: Characterizes the kind of service or activity (e.g. evaluations, consultations, and summaries). The notion of time sequence, e.g., at the beginning (admission) at the end (discharge) is subsumed in this axis. Example: Discharge Teaching.
Setting: Setting is an extension of CMS's definitions (e.g. Inpatient, Outpatient)
Subject Matter Domain (SMD): Characterizes the subject matter domain of a note (e.g. Anesthesiology)
Role: Characterizes the training or professional level of the author of the document, but does not break down to specialty or subspecialty (e.g. Physician)
Each combination of these 5 dimensions rolls up to a unique LOINC code.
According to CDO requirements, only 2 of the 5 dimensions are required to properly annotate a document: Kind of Document and any one of the other 4 dimensions.
However, not all the permutations of the CDO dimensions will necessarily yield an existing LOINC code.2 HL7/LOINC workforce is committed to establish new LOINC codes for each new encountered combination of CDO dimensions.
The full document ontology as it exists in the Vocabulary is too extensive to list here, but it is possible to explore through the ATHENA tool starting with the 'LOINC Document Ontology - Type of Service and Kind of Document' by walking through the 'Is a'/'Subsumes' relationship hierarchies."
NOTE_NLP,CDM,No,,No,,,The NOTE_NLP table will encode all output of NLP on clinical notes. Each row represents a single extracted term from a note.,,
OBSERVATION,CDM,No,OBSERVATION_,Yes,0,,"The OBSERVATION table captures clinical facts about a Person obtained in the context of examination, questioning or a procedure. Any data that cannot be represented by any other domains, such as social and lifestyle facts, medical history, family history, etc. are recorded here.",,"Observations differ from Measurements in that they do not require a standardized test or some other activity to generate clinical fact. Typical observations are medical history, family history, the stated need for certain treatment, social circumstances, lifestyle choices, healthcare utilization patterns, etc. If the generation clinical facts requires a standardized testing such as lab testing or imaging and leads to a standardized result, the data item is recorded in the MEASUREMENT table. If the clinical fact observed determines a sign, symptom, diagnosis of a disease or other medical condition, it is recorded in the CONDITION_OCCURRENCE table. Observations can be stored as attribute value pairs, with the attribute as the Observation Concept and the value representing the clinical fact. This fact can be a Concept (stored in VALUE_AS_CONCEPT), a numerical value (VALUE_AS_NUMBER), a verbatim string (VALUE_AS_STRING), or a datetime (VALUE_AS_DATETIME). Even though Observations do not have an explicit result, the clinical fact can be stated separately from the type of Observation in the VALUE_AS_* fields. It is recommended for Observations that are suggestive statements of positive assertion should have a value of 'Yes' (concept_id=4188539), recorded, even though the null value is the equivalent. "
SPECIMEN,CDM,No,SPECIMEN_,Yes,0,,The specimen domain contains the records identifying biological samples from a person.,,"Anatomic site is coded at the most specific level of granularity possible, such that higher level classifications can be derived using the Standardized Vocabularies."
FACT_RELATIONSHIP,CDM,No,,No,,,"The FACT_RELATIONSHIP table contains records about the relationships between facts stored as records in any table of the CDM. Relationships can be defined between facts from the same domain, or different domains. Examples of Fact Relationships include: Person relationships (parent-child), care site relationships (hierarchical organizational structure of facilities within a health system), indication relationship (between drug exposures and associated conditions), usage relationships (of devices during the course of an associated procedure), or facts derived from one another (measurements derived from an associated specimen).",,"All relationships are directional, and each relationship is represented twice symmetrically within the FACT_RELATIONSHIP table. For example, two persons if person_id = 1 is the mother of person_id = 2 two records are in the FACT_RELATIONSHIP table (all strings in fact concept_id records in the Concept table:
- Person, 1, Person, 2, parent of
- Person, 2, Person, 1, child of"
LOCATION,CDM,No,,No,,,The LOCATION table represents a generic way to capture physical location or address information of Persons and Care Sites.,"For standardized geospatial visualization and analysis, addresses need to be, at the minimum be geocoded into latitude and longitude.","Each address or Location is unique and is present only once in the table. Locations do not contain names, such as the name of a hospital. In order to construct a full address that can be used in the postal service, the address information from the Location needs to be combined with information from the Care Site."
CARE_SITE,CDM,No,,No,,,"The CARE_SITE table contains a list of uniquely identified institutional (physical or organizational) units where healthcare delivery is practiced (offices, wards, hospitals, clinics, etc.).",,"Care site is a unique combination of location_id and place_of_service_source_value. Care site does not take into account the provider (human) information such a specialty. Many source data do not make a distinction between individual and institutional providers. The CARE_SITE table contains the institutional providers. If the source, instead of uniquely identifying individual Care Sites, only provides limited information such as Place of Service, generic or ""pooled"" Care Site records are listed in the CARE_SITE table. There can be hierarchical and business relationships between Care Sites. For example, wards can belong to clinics or departments, which can in turn belong to hospitals, which in turn can belong to hospital systems, which in turn can belong to HMOs.The relationships between Care Sites are defined in the FACT_RELATIONSHIP table."
PROVIDER,CDM,No,,No,,,"The PROVIDER table contains a list of uniquely identified healthcare providers. These are individuals providing hands-on healthcare to patients, such as physicians, nurses, midwives, physical therapists etc.","Many sources do not make a distinction between individual and institutional providers. The PROVIDER table contains the individual providers. If the source, instead of uniquely identifying individual providers, only provides limited information such as specialty, generic or 'pooled' Provider records are listed in the PROVIDER table.",
PAYER_PLAN_PERIOD,CDM,No,,Yes,0,,"The PAYER_PLAN_PERIOD table captures details of the period of time that a Person is continuously enrolled under a specific health Plan benefit structure from a given Payer. Each Person receiving healthcare is typically covered by a health benefit plan, which pays for (fully or partially), or directly provides, the care. These benefit plans are provided by payers, such as health insurances or state or government agencies. In each plan the details of the health benefits are defined for the Person or her family, and the health benefit Plan might change over time typically with increasing utilization (reaching certain cost thresholds such as deductibles), plan availability and purchasing choices of the Person. The unique combinations of Payer organizations, health benefit Plans and time periods in which they are valid for a Person are recorded in this table.","A Person can have multiple, overlapping, Payer_Plan_Periods in this table. For example, medical and drug coverage in the US can be represented by two Payer_Plan_Periods. The details of the benefit structure of the Plan is rarely known, the idea is just to identify that the Plans are different.",
COST,CDM,No,,No,,,"The COST table captures records containing the cost of any medical event recorded in one of the OMOP clinical event tables such as DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, VISIT_OCCURRENCE, VISIT_DETAIL, DEVICE_OCCURRENCE, OBSERVATION or MEASUREMENT.
Each record in the cost table account for the amount of money transacted for the clinical event. So, the COST table may be used to represent both receivables (charges) and payments (paid), each transaction type represented by its COST_CONCEPT_ID. The COST_TYPE_CONCEPT_ID field will use concepts in the Standardized Vocabularies to designate the source (provenance) of the cost data. A reference to the health plan information in the PAYER_PLAN_PERIOD table is stored in the record for information used for the adjudication system to determine the persons benefit for the clinical event.","When dealing with summary costs, the cost of the goods or services the provider provides is often not known directly, but derived from the hospital charges multiplied by an average cost-to-charge ratio.","One cost record is generated for each response by a payer. In a claims databases, the payment and payment terms reported by the payer for the goods or services billed will generate one cost record. If the source data has payment information for more than one payer (i.e. primary insurance and secondary insurance payment for one entity), then a cost record is created for each reporting payer. Therefore, it is possible for one procedure to have multiple cost records for each payer, but typically it contains one or no record per entity. Payer reimbursement cost records will be identified by using the PAYER_PLAN_ID field. Drug costs are composed of ingredient cost (the amount charged by the wholesale distributor or manufacturer), the dispensing fee (the amount charged by the pharmacy and the sales tax)."
DRUG_ERA,CDM,No,,Yes,0,,"A Drug Era is defined as a span of time when the Person is assumed to be exposed to a particular active ingredient. A Drug Era is not the same as a Drug Exposure: Exposures are individual records corresponding to the source when Drug was delivered to the Person, while successive periods of Drug Exposures are combined under certain rules to produce continuous Drug Eras.",,
DOSE_ERA,CDM,No,,Yes,0,,A Dose Era is defined as a span of time when the Person is assumed to be exposed to a constant dose of a specific active ingredient.,,"Dose Eras will be derived from records in the DRUG_EXPOSURE table and the Dose information from the DRUG_STRENGTH table using a standardized algorithm. Dose Form information is not taken into account. So, if the patient changes between different formulations, or different manufacturers with the same formulation, the Dose Era is still spanning the entire time of exposure to the Ingredient. The total dose of a DRUG_EXPOSURE record is calculated with the help of the DRUG_STRENGTH table containing the dosage information for each drug as following:
5 Tablets and other fixed amount formulations
Example: Acetaminophen (Paracetamol) 500 mg, 20 tablets.
DRUG_STRENGTH The denominator_unit is empty
DRUG_EXPOSURE The quantity refers to number of pieces, e.g. tablets
In the example: 20
Ingredient dose= quantity x amount_value [amount_unit_concept_id]
Acetaminophen dose = 20 x 500mg = 10,000mg
6 Puffs of an inhaler
Note: There is no difference to use case 1 besides that the DRUG_STRENGTH table may put {actuat} in the denominator unit. In this case the strength is provided in the numerator.
DRUG_STRENGTH The denominator_unit is {actuat}
DRUG_EXPOSURE The quantity refers to the number of pieces, e.g. puffs
Ingredient dose= quantity x numerator_value [numerator_unit_concept_id]
7 Quantified Drugs which are formulated as a concentration
Example: The Clinical Drug is Acetaminophen 250 mg/mL in a 5mL oral suspension. The Quantified Clinical Drug would have 1250 mg / 5 ml in the DRUG_STRENGTH table. Two suspensions are dispensed.
DRUG_STRENGTH The denominator_unit is either mg or mL. The denominator_value might be different from 1.
DRUG_EXPOSURE The quantity refers to a fraction or, multiple of the pack.
Example: 2
Ingredient dose= quantity x numerator_value [numerator_unit_concept_id]
Acetaminophen dose = 2 x 1250mg = 2500mg
8 Drugs with the total amount provided in quantity, e.g. chemotherapeutics
Example: 42799258 ""Benzyl Alcohol 0.1 ML/ML / Pramoxine hydrochloride 0.01 MG/MG Topical Gel"" dispensed in a 1.25oz pack.
DRUG_STRENGTH The denominator_unit is either mg or mL.
Example: Benzyl Alcohol in mL and Pramoxine hydrochloride in mg
DRUG_EXPOSURE The quantity refers to mL or g.
Example: 1.25 x 30 (conversion factor oz -> mL) = 37
Ingredient dose= quantity x numerator_value [numerator_unit_concept_id]
Benzyl Alcohol dose = 37 x 0.1mL = 3.7mL
Pramoxine hydrochloride dose = 37 x 0.01mg x 1000 = 370mg
Note: The analytical side should check the denominator in the DRUG_STRENGTH table. As mg is used for the second ingredient the factor 1000 will be applied to convert between g and mg.
9 Compounded drugs
Example: Ibuprofen 20%/Piroxicam 1% Cream, 30ml in 5ml tubes.
DRUG_STRENGTH We need entries for the ingredients of Ibuprofen and Piroxicam, probably with an amount_value of 1 and a unit of mg.
DRUG_EXPOSURE The quantity refers to the total amount of the compound. Use one record in the DRUG_EXPOSURE table for each compound.
Example: 20% Ibuprofen of 30ml = 6mL, 1% Piroxicam of 30ml = 0.3mL
Ingredient dose= Depends on the drugs involved: One of the use cases above.
Ibuprofen dose = 6 x 1mg x 1000 = 6000mg
Piroxicam dose = 0.3 x 1mg x 1000 = 300mg
Note: The analytical side determines that the denominator for both ingredients in the DRUG_STRENGTH table is mg and applies the factor 1000 to convert between mL/g and mg.
10 Drugs with the active ingredient released over time, e.g. patches
Example: Ethinyl Estradiol 0.000833 MG/HR / norelgestromin 0.00625 MG/HR Weekly Transdermal Patch
DRUG_STRENGTH The denominator units refer to hour.
Example: Ethinyl Estradiol 0.000833 mg/h / norelgestromin 0.00625 mg/h
DRUG_EXPOSURE The quantity refers to the number of pieces.
Example: 1 patch
Ingredient rate= numerator_value [numerator_unit_concept_id]
Ethinyl Estradiol rate = 0.000833 mg/h
norelgestromin rate 0.00625 mg/h
Note: This can be converted to a daily dosage by multiplying it with 24. (Assuming 1 patch at a time for at least 24 hours)"
CONDITION_ERA,CDM,No,,Yes,0,,"A Condition Era is defined as a span of time when the Person is assumed to have a given condition. Similar to Drug Eras, Condition Eras are chronological periods of Condition Occurrence. Combining individual Condition Occurrences into a single Condition Era serves two purposes:
It allows aggregation of chronic conditions that require frequent ongoing care, instead of treating each Condition Occurrence as an independent event.
It allows aggregation of multiple, closely timed doctor visits for the same Condition to avoid double-counting the Condition Occurrences.
For example, consider a Person who visits her Primary Care Physician (PCP) and who is referred to a specialist. At a later time, the Person visits the specialist, who confirms the PCP's original diagnosis and provides the appropriate treatment to resolve the condition. These two independent doctor visits should be aggregated into one Condition Era.",,"Each Condition Era corresponds to one or many Condition Occurrence records that form a continuous interval.
The condition_concept_id field contains Concepts that are identical to those of the CONDITION_OCCURRENCE table records that make up the Condition Era. In contrast to Drug Eras, Condition Eras are not aggregated to contain Conditions of different hierarchical layers.
The Condition Era Start Date is the start date of the first Condition Occurrence.
The Condition Era End Date is the end date of the last Condition Occurrence. Condition Eras are built with a Persistence Window of 30 days, meaning, if no occurrence of the same condition_concept_id happens within 30 days of any one occurrence, it will be considered the condition_era_end_date."
1 cdmTableName schema isRequired conceptPrefix measurePersonCompleteness measurePersonCompletenessThreshold validation tableDescription userGuidance etlConventions
2 PERSON CDM Yes No This table serves as the central identity management for of all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information. All records in this table are independent Persons. All Persons in a database need one record in this table, unless they fail data quality requirements specified in the ETL. Persons with no Events should have a record nonetheless. If more than one data source contributes Events to the database, Persons must be reconciled across the sources to create one single record per Person. The content of the BIRTH_DATETIME must be equivalent to the content of BIRTH_DAY, BIRTH_MONTH and BIRTH_YEAR.
3 OBSERVATION_PERIOD CDM Yes Yes 0 This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time. For each Person, one or more OBSERVATION_PERIOD records may be present, but they will not overlap or be back to back to each other. Events may exist outside all of the time spans of the OBSERVATION_PERIOD records for a patient, however, absence of an Event outside these time spans cannot be construed as evidence of absence of an Event. Incidence or prevalence rates should only be calculated for the time of active OBSERVATION_PERIOD records. When constructing cohorts, outside Events can be used for inclusion criteria definition, but without any guarantee for the performance of these criteria. Also, OBSERVATION_PERIOD records can be as short as a single day, greatly disturbing the denominator of any rate calculation as part of cohort characterizations. To avoid that, apply minimal observation time as a requirement for any cohort definition. Each Person needs to have at least one OBSERVATION_PERIOD record, which should be represent time intervals with a high capture rate of Clinical Events. Some source data have very similar concepts, such as enrolment periods in insurance claims data. In other source data such as most EHR systems these time spans need to be inferred under a set of assumptions. It is the discretion of the ETL developer to define these assumptions. In many ETL solutions the start date of the first occurrence or the first high quality occurrence of a Clinical Event (Condition, Drug, Procedure, Device, Measurement, Visit) is defined as the start of the OBSERVATION_PERIOD record, and the end date of the last occurrence of last high quality occurrence of a Clinical Event, or the end of the database period becomes the end of the OBSERVATOIN_PERIOD for each Person. If a Person only has a single Clinical Event the OBSERVATION_PERIOD record can be as short as one day. Depending on these definitions it is possible, that Clinical Events fall outside the time spans defined by OBSERVATION_PERIOD records. Family history or history of Clinical Events generally are not used to generate OBSERVATION_PERIOD records around the time they are referring to. Any two overlapping or adjacent OBSERVATION_PERIOD records have to be merged into one.
4 VISIT_OCCURRENCE CDM No VISIT_ Yes 0 This table contains Events where Persons engage with the healthcare system for a duration of time. They are often also called "Encounters". Visits are defined by a configuration of circumstances under which they occur, such as (i) whether the patient comes to a healthcare institution, the other way around, or the interaction is remote, (ii) whether and what kind of trained medical staff is delivering the service during the Visit, and (iii) whether the Visit is transient or for a longer period involving a stay in bed. The configuration defining the Visit are described by Concepts in the Visit Domain, which form a hierarchical structure, but rolling up to generally familiar Visits adopted in most healthcare systems worldwide: - Inpatient Visit: Person visiting hospital, at a Care Site, in bed, for duration of more than one day, with physicians and other Providers permanently available to deliver service around the clock - Emergency Room Visit: Person visiting dedicated healthcare institution for treating emergencies, at a Care Site, within one day, with physicians and Providers permanently available to deliver service around the clock - Emergency Room and Inpatient Visit: Person visiting ER follwed by a subsequent Inpatient Visit, where Emergency department is part of hospital, and transition from the ER to other hospital departments is undefined - Non-hospital institution Visit: Person visiting dedicated institution for reasons of poor health, at a Care Site, long-term or permanently, with no physician but possibly other Providers permanently available to deliver service around the clock - Outpatient Visit: Person visiting dedicated ambulatory healthcare institution, at a Care Site, within one day, without bed, with physicians or medical Providers delivering service during Visit - Home Visit: Provider visiting Person, without a Care Site, within one day, delivering service - Telehealth Visit: Patient engages with Provider through communication media - Pharmacy Visit: Person visiting pharmacy for dispensing of Drug, at a Care Site, within one day - Laboratory Visit: Patient visiting dedicated institution, at a Care Site, within one day, for the purpose of a Measurement. - Ambulance Visit: Person using transportation service for the purpose of initiating one of the other Visits, without a Care Site, within one day, potentially with Providers accompanying the Visit and delivering service - Case Management Visit: Person interacting with healthcare system, without a Care Site, within a day, with no Providers involved, for administrative purposes The Visit duration, or 'length of stay', is defined as VISIT_END_DATE - VISIT_START_DATE. For all Visits this is <1 day, except Inpatient Visits and Non-hospital institution Visits. The CDM also contains the VISIT_DETAIL table where additional information about the Visit is stored, for example, transfers between units during an inpatient Visit. Visits can be derived easily if the source data contain coding systems for Place of Service or Procedures, like CPT codes for well visits. In those cases, the codes can be looked up and mapped to a Standard Visit Concept. Otherwise, Visit Concepts have to be identified in the ETL process. This table will contain concepts in the Visit domain. These concepts are arranged in a hierarchical structure to facilitate cohort definitions by rolling up to generally familiar Visits adopted in most healthcare systems worldwide. Visits can be adjacent to each other, i.e. the end date of one can be identical with the start date of the other. As a consequence, more than one-day Visits or their descendants can be recorded for the same day. Multi-day visits must not overlap, i.e. share days other than start and end days. It is often the case that some logic should be written for how to define visits and how to assign Visit_Concept_Id. For example, in US claims outpatient visits that appear to occur within the time period of an inpatient visit can be rolled into one with the same Visit_Occurrence_Id. In EHR data inpatient visits that are within one day of each other may be strung together to create one visit. It will all depend on the source data and how encounter records should be translated to visit occurrences. Providers can be associated with a Visit through the PROVIDER_ID field, or indirectly through PROCEDURE_OCCURRENCE records linked both to the VISIT and PROVIDER tables.
5 CONDITION_OCCURRENCE CDM No CONDITION_ Yes 0 This table contains records of Events of a Person suggesting the presence of a disease or medical condition stated as a diagnosis, a sign, or a symptom, which is either observed by a Provider or reported by the patient. Conditions span a time interval from start to end, but are typically recorded as single snapshot records with no end date. The reason is twofold: (i) At the time of the recording the duration is not known and later not recorded, and (ii) the Persons typically cease interacting with the healthcare system when they feel better, which leads to incomplete capture of resolved Conditions. The CONDITION_ERA table addresses this issue. Conditions are defined by Concepts from the Condition domain, which form a complex hierarchy. As a result, the same Person with the same disease may have multiple Condition records, which belong to the same hierarchical family. Most Condition records are mapped from diagnostic codes, but recorded signs, symptoms and summary descriptions also contribute to this table. Rule out diagnosis should not be recorded in this table, but in reality their negating nature is not always captured in the source data, and other precautions must be taken when when identifying Persons who should suffer from the recorded Condition. Source codes and source text fields mapped to Standard Concepts of the Condition Domain have to be recorded here. Family history and past diagnoses ('history of') are not recorded in this table. Instead, they are listed in the OBSERVATION table. Codes written in the process of establishing the diagnosis, such as 'question of' of and 'rule out', should not represented here. Instead, they should be recorded in the OBSERVATION table, if they are used for analyses. However, this information is not always available.
6 DRUG_EXPOSURE CDM No DRUG_ Yes 0 This table captures records about the exposure to a Drug ingested or otherwise introduced into the body. A Drug is a biochemical substance formulated in such a way that when administered to a Person it will exert a certain biochemical effect on the metabolism. Drugs include prescription and over-the-counter medicines, vaccines, and large-molecule biologic therapies. When the Drug Source Value of the code cannot be translated into Standard Drug Concept IDs, a Drug exposure entry is stored with only the corresponding SOURCE_CONCEPT_ID and DRUG_SOURCE_VALUE and a DRUG_CONCEPT_ID of 0. The Drug Concept with the most detailed content of information is preferred during the mapping process. These are indicated in the CONCEPT_CLASS_ID field of the Concept and are recorded in the following order of precedence: 'Branded Pack', 'Clinical Pack', 'Branded Drug', 'Clinical Drug', 'Branded Drug Component', 'Clinical Drug Component', 'Branded Drug Form', 'Clinical Drug Form', and only if no other information is available 'Ingredient'. Note: If only the drug class is known, the DRUG_CONCEPT_ID field should contain 0.
7 PROCEDURE_OCCURRENCE CDM No PROCEDURE_ Yes 0 The PROCEDURE_OCCURRENCE table contains records of activities or processes ordered by, or carried out by, a healthcare provider on the patient to have a diagnostic or therapeutic purpose. Procedures are expected to be carried out within one day and therefore have no end date. When dealing with duplicate records, the ETL must determine whether to sum them up into one record or keep them separate. Things to consider are: - Same Procedure - Same PROCEDURE_DATETIME - Same Visit Occurrence or Visit Detail - Same Provider - Same Modifier for Procedures - Same COST_ID
8 DEVICE_EXPOSURE CDM No DEVICE_ Yes 0 The Device domain captures information about a person's exposure to a foreign physical object or instrument which is used for diagnostic or therapeutic purposes through a mechanism beyond chemical action. Devices include implantable objects (e.g. pacemakers, stents, artificial joints), medical equipment and supplies (e.g. bandages, crutches, syringes), other instruments used in medical procedures (e.g. sutures, defibrillators) and material used in clinical care (e.g. adhesives, body material, dental material, surgical material). The distinction between Devices or supplies and Procedures are sometimes blurry, but the former are physical objects while the latter are actions, often to apply a Device or supply. When dealing with duplicate records, the ETL must determine whether to sum them up into one record or keep them separate. Things to consider are: - Same Device/Procedure - Same DEVICE_EXPOSURE_START_DATETIME - Same Visit Occurrence or Visit Detail - Same Provider - Same Modifier for Procedures - Same COST_ID
9 MEASUREMENT CDM No MEASUREMENT_ Yes 0 The MEASUREMENT table contains records of Measurement, i.e. structured values (numerical or categorical) obtained through systematic and standardized examination or testing of a Person or Person's sample. The MEASUREMENT table contains both orders and results of such Measurements as laboratory tests, vital signs, quantitative findings from pathology reports, etc. Measurements are stored as attribute value pairs, with the attribute as the Measurement Concept and the value representing the result. The value can be a Concept (stored in VALUE_AS_CONCEPT), or a numerical value (VALUE_AS_NUMBER) with a Unit (UNIT_CONCEPT_ID). Measurements differ from Observations in that they require a standardized test or some other activity to generate a quantitative or qualitative result. For example, LOINC 1755-8 concept_id 3027035 'Albumin [Mass/time] in 24 hour Urine' is the lab test to measure a certain chemical in a urine sample. Even though each Measurement always have a result, the fields VALUE_AS_NUMBER and VALUE_AS_CONCEPT_ID are not mandatory. When the result is not known, the Measurement record represents just the fact that the corresponding Measurement was carried out, which in itself is already useful information for some use cases. Even though each Measurement always have a result, the fields VALUE_AS_NUMBER and VALUE_AS_CONCEPT_ID are not mandatory. When the result is not known, the Measurement record represents just the fact that the corresponding Measurement was carried out, which in itself is already useful information for some use cases. For some Measurement Concepts, the result is included in the test. For example, ICD10 concept_id 45595451 'Presence of alcohol in blood, level not specified' indicates a Measurement and the result (present). In those situations, the CONCEPT_RELATIONSHIP table in addition to the 'Maps to' record contains a second record with the relationship_id set to 'Maps to value'. In this example, the 'Maps to' relationship directs to 4041715 'Blood ethanol measurement' as well as a 'Maps to value' record to 4181412 'Present'.
10 VISIT_DETAIL CDM No VISIT_DETAIL_ Yes 0 The VISIT_DETAIL table is an optional table used to represents details of each record in the parent visit_occurrence table. For every record in visit_occurrence table there may be 0 or more records in the visit_detail table with a 1:n relationship where n may be 0. The visit_detail table is structurally very similar to visit_occurrence table and belongs to the similar domain as the visit.
11 NOTE CDM No Yes 0 The NOTE table captures unstructured information that was recorded by a provider about a patient in free text notes on a given date. The NOTE table contains free text (in ASCII, or preferably in UTF8 format). The type of note_text is CLOB or varchar(MAX) depending on RDBMS. Mapping of clinical documents to Clinical Document Ontology (CDO) and standard terminology HL7/LOINC CDO is a standard for consistent naming of documents to support a range of use cases: retrieval, organization, display, and exchange. It guides the creation of LOINC codes for clinical notes. CDO annotates each document with 5 dimensions: Kind of Document: Characterizes the general structure of the document at a macro level (e.g. Anesthesia Consent) Type of Service: Characterizes the kind of service or activity (e.g. evaluations, consultations, and summaries). The notion of time sequence, e.g., at the beginning (admission) at the end (discharge) is subsumed in this axis. Example: Discharge Teaching. Setting: Setting is an extension of CMS's definitions (e.g. Inpatient, Outpatient) Subject Matter Domain (SMD): Characterizes the subject matter domain of a note (e.g. Anesthesiology) Role: Characterizes the training or professional level of the author of the document, but does not break down to specialty or subspecialty (e.g. Physician) Each combination of these 5 dimensions rolls up to a unique LOINC code. According to CDO requirements, only 2 of the 5 dimensions are required to properly annotate a document: Kind of Document and any one of the other 4 dimensions. However, not all the permutations of the CDO dimensions will necessarily yield an existing LOINC code.2 HL7/LOINC workforce is committed to establish new LOINC codes for each new encountered combination of CDO dimensions. The full document ontology as it exists in the Vocabulary is too extensive to list here, but it is possible to explore through the ATHENA tool starting with the 'LOINC Document Ontology - Type of Service and Kind of Document' by walking through the 'Is a'/'Subsumes' relationship hierarchies.
12 NOTE_NLP CDM No No The NOTE_NLP table will encode all output of NLP on clinical notes. Each row represents a single extracted term from a note.
13 OBSERVATION CDM No OBSERVATION_ Yes 0 The OBSERVATION table captures clinical facts about a Person obtained in the context of examination, questioning or a procedure. Any data that cannot be represented by any other domains, such as social and lifestyle facts, medical history, family history, etc. are recorded here. Observations differ from Measurements in that they do not require a standardized test or some other activity to generate clinical fact. Typical observations are medical history, family history, the stated need for certain treatment, social circumstances, lifestyle choices, healthcare utilization patterns, etc. If the generation clinical facts requires a standardized testing such as lab testing or imaging and leads to a standardized result, the data item is recorded in the MEASUREMENT table. If the clinical fact observed determines a sign, symptom, diagnosis of a disease or other medical condition, it is recorded in the CONDITION_OCCURRENCE table. Observations can be stored as attribute value pairs, with the attribute as the Observation Concept and the value representing the clinical fact. This fact can be a Concept (stored in VALUE_AS_CONCEPT), a numerical value (VALUE_AS_NUMBER), a verbatim string (VALUE_AS_STRING), or a datetime (VALUE_AS_DATETIME). Even though Observations do not have an explicit result, the clinical fact can be stated separately from the type of Observation in the VALUE_AS_* fields. It is recommended for Observations that are suggestive statements of positive assertion should have a value of 'Yes' (concept_id=4188539), recorded, even though the null value is the equivalent.
14 SPECIMEN CDM No SPECIMEN_ Yes 0 The specimen domain contains the records identifying biological samples from a person. Anatomic site is coded at the most specific level of granularity possible, such that higher level classifications can be derived using the Standardized Vocabularies.
15 FACT_RELATIONSHIP CDM No No The FACT_RELATIONSHIP table contains records about the relationships between facts stored as records in any table of the CDM. Relationships can be defined between facts from the same domain, or different domains. Examples of Fact Relationships include: Person relationships (parent-child), care site relationships (hierarchical organizational structure of facilities within a health system), indication relationship (between drug exposures and associated conditions), usage relationships (of devices during the course of an associated procedure), or facts derived from one another (measurements derived from an associated specimen). All relationships are directional, and each relationship is represented twice symmetrically within the FACT_RELATIONSHIP table. For example, two persons if person_id = 1 is the mother of person_id = 2 two records are in the FACT_RELATIONSHIP table (all strings in fact concept_id records in the Concept table: - Person, 1, Person, 2, parent of - Person, 2, Person, 1, child of
16 LOCATION CDM No No The LOCATION table represents a generic way to capture physical location or address information of Persons and Care Sites. For standardized geospatial visualization and analysis, addresses need to be, at the minimum be geocoded into latitude and longitude. Each address or Location is unique and is present only once in the table. Locations do not contain names, such as the name of a hospital. In order to construct a full address that can be used in the postal service, the address information from the Location needs to be combined with information from the Care Site.
17 CARE_SITE CDM No No The CARE_SITE table contains a list of uniquely identified institutional (physical or organizational) units where healthcare delivery is practiced (offices, wards, hospitals, clinics, etc.). Care site is a unique combination of location_id and place_of_service_source_value. Care site does not take into account the provider (human) information such a specialty. Many source data do not make a distinction between individual and institutional providers. The CARE_SITE table contains the institutional providers. If the source, instead of uniquely identifying individual Care Sites, only provides limited information such as Place of Service, generic or "pooled" Care Site records are listed in the CARE_SITE table. There can be hierarchical and business relationships between Care Sites. For example, wards can belong to clinics or departments, which can in turn belong to hospitals, which in turn can belong to hospital systems, which in turn can belong to HMOs.The relationships between Care Sites are defined in the FACT_RELATIONSHIP table.
18 PROVIDER CDM No No The PROVIDER table contains a list of uniquely identified healthcare providers. These are individuals providing hands-on healthcare to patients, such as physicians, nurses, midwives, physical therapists etc. Many sources do not make a distinction between individual and institutional providers. The PROVIDER table contains the individual providers. If the source, instead of uniquely identifying individual providers, only provides limited information such as specialty, generic or 'pooled' Provider records are listed in the PROVIDER table.
19 PAYER_PLAN_PERIOD CDM No Yes 0 The PAYER_PLAN_PERIOD table captures details of the period of time that a Person is continuously enrolled under a specific health Plan benefit structure from a given Payer. Each Person receiving healthcare is typically covered by a health benefit plan, which pays for (fully or partially), or directly provides, the care. These benefit plans are provided by payers, such as health insurances or state or government agencies. In each plan the details of the health benefits are defined for the Person or her family, and the health benefit Plan might change over time typically with increasing utilization (reaching certain cost thresholds such as deductibles), plan availability and purchasing choices of the Person. The unique combinations of Payer organizations, health benefit Plans and time periods in which they are valid for a Person are recorded in this table. A Person can have multiple, overlapping, Payer_Plan_Periods in this table. For example, medical and drug coverage in the US can be represented by two Payer_Plan_Periods. The details of the benefit structure of the Plan is rarely known, the idea is just to identify that the Plans are different.
20 COST CDM No No The COST table captures records containing the cost of any medical event recorded in one of the OMOP clinical event tables such as DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, VISIT_OCCURRENCE, VISIT_DETAIL, DEVICE_OCCURRENCE, OBSERVATION or MEASUREMENT. Each record in the cost table account for the amount of money transacted for the clinical event. So, the COST table may be used to represent both receivables (charges) and payments (paid), each transaction type represented by its COST_CONCEPT_ID. The COST_TYPE_CONCEPT_ID field will use concepts in the Standardized Vocabularies to designate the source (provenance) of the cost data. A reference to the health plan information in the PAYER_PLAN_PERIOD table is stored in the record for information used for the adjudication system to determine the persons benefit for the clinical event. When dealing with summary costs, the cost of the goods or services the provider provides is often not known directly, but derived from the hospital charges multiplied by an average cost-to-charge ratio. One cost record is generated for each response by a payer. In a claims databases, the payment and payment terms reported by the payer for the goods or services billed will generate one cost record. If the source data has payment information for more than one payer (i.e. primary insurance and secondary insurance payment for one entity), then a cost record is created for each reporting payer. Therefore, it is possible for one procedure to have multiple cost records for each payer, but typically it contains one or no record per entity. Payer reimbursement cost records will be identified by using the PAYER_PLAN_ID field. Drug costs are composed of ingredient cost (the amount charged by the wholesale distributor or manufacturer), the dispensing fee (the amount charged by the pharmacy and the sales tax).
21 DRUG_ERA CDM No Yes 0 A Drug Era is defined as a span of time when the Person is assumed to be exposed to a particular active ingredient. A Drug Era is not the same as a Drug Exposure: Exposures are individual records corresponding to the source when Drug was delivered to the Person, while successive periods of Drug Exposures are combined under certain rules to produce continuous Drug Eras.
22 DOSE_ERA CDM No Yes 0 A Dose Era is defined as a span of time when the Person is assumed to be exposed to a constant dose of a specific active ingredient. Dose Eras will be derived from records in the DRUG_EXPOSURE table and the Dose information from the DRUG_STRENGTH table using a standardized algorithm. Dose Form information is not taken into account. So, if the patient changes between different formulations, or different manufacturers with the same formulation, the Dose Era is still spanning the entire time of exposure to the Ingredient. The total dose of a DRUG_EXPOSURE record is calculated with the help of the DRUG_STRENGTH table containing the dosage information for each drug as following: 5 Tablets and other fixed amount formulations Example: Acetaminophen (Paracetamol) 500 mg, 20 tablets. DRUG_STRENGTH The denominator_unit is empty DRUG_EXPOSURE The quantity refers to number of pieces, e.g. tablets In the example: 20 Ingredient dose= quantity x amount_value [amount_unit_concept_id] Acetaminophen dose = 20 x 500mg = 10,000mg 6 Puffs of an inhaler Note: There is no difference to use case 1 besides that the DRUG_STRENGTH table may put {actuat} in the denominator unit. In this case the strength is provided in the numerator. DRUG_STRENGTH The denominator_unit is {actuat} DRUG_EXPOSURE The quantity refers to the number of pieces, e.g. puffs Ingredient dose= quantity x numerator_value [numerator_unit_concept_id] 7 Quantified Drugs which are formulated as a concentration Example: The Clinical Drug is Acetaminophen 250 mg/mL in a 5mL oral suspension. The Quantified Clinical Drug would have 1250 mg / 5 ml in the DRUG_STRENGTH table. Two suspensions are dispensed. DRUG_STRENGTH The denominator_unit is either mg or mL. The denominator_value might be different from 1. DRUG_EXPOSURE The quantity refers to a fraction or, multiple of the pack. Example: 2 Ingredient dose= quantity x numerator_value [numerator_unit_concept_id] Acetaminophen dose = 2 x 1250mg = 2500mg 8 Drugs with the total amount provided in quantity, e.g. chemotherapeutics Example: 42799258 "Benzyl Alcohol 0.1 ML/ML / Pramoxine hydrochloride 0.01 MG/MG Topical Gel" dispensed in a 1.25oz pack. DRUG_STRENGTH The denominator_unit is either mg or mL. Example: Benzyl Alcohol in mL and Pramoxine hydrochloride in mg DRUG_EXPOSURE The quantity refers to mL or g. Example: 1.25 x 30 (conversion factor oz -> mL) = 37 Ingredient dose= quantity x numerator_value [numerator_unit_concept_id] Benzyl Alcohol dose = 37 x 0.1mL = 3.7mL Pramoxine hydrochloride dose = 37 x 0.01mg x 1000 = 370mg Note: The analytical side should check the denominator in the DRUG_STRENGTH table. As mg is used for the second ingredient the factor 1000 will be applied to convert between g and mg. 9 Compounded drugs Example: Ibuprofen 20%/Piroxicam 1% Cream, 30ml in 5ml tubes. DRUG_STRENGTH We need entries for the ingredients of Ibuprofen and Piroxicam, probably with an amount_value of 1 and a unit of mg. DRUG_EXPOSURE The quantity refers to the total amount of the compound. Use one record in the DRUG_EXPOSURE table for each compound. Example: 20% Ibuprofen of 30ml = 6mL, 1% Piroxicam of 30ml = 0.3mL Ingredient dose= Depends on the drugs involved: One of the use cases above. Ibuprofen dose = 6 x 1mg x 1000 = 6000mg Piroxicam dose = 0.3 x 1mg x 1000 = 300mg Note: The analytical side determines that the denominator for both ingredients in the DRUG_STRENGTH table is mg and applies the factor 1000 to convert between mL/g and mg. 10 Drugs with the active ingredient released over time, e.g. patches Example: Ethinyl Estradiol 0.000833 MG/HR / norelgestromin 0.00625 MG/HR Weekly Transdermal Patch DRUG_STRENGTH The denominator units refer to hour. Example: Ethinyl Estradiol 0.000833 mg/h / norelgestromin 0.00625 mg/h DRUG_EXPOSURE The quantity refers to the number of pieces. Example: 1 patch Ingredient rate= numerator_value [numerator_unit_concept_id] Ethinyl Estradiol rate = 0.000833 mg/h norelgestromin rate 0.00625 mg/h Note: This can be converted to a daily dosage by multiplying it with 24. (Assuming 1 patch at a time for at least 24 hours)
23 CONDITION_ERA CDM No Yes 0 A Condition Era is defined as a span of time when the Person is assumed to have a given condition. Similar to Drug Eras, Condition Eras are chronological periods of Condition Occurrence. Combining individual Condition Occurrences into a single Condition Era serves two purposes: It allows aggregation of chronic conditions that require frequent ongoing care, instead of treating each Condition Occurrence as an independent event. It allows aggregation of multiple, closely timed doctor visits for the same Condition to avoid double-counting the Condition Occurrences. For example, consider a Person who visits her Primary Care Physician (PCP) and who is referred to a specialist. At a later time, the Person visits the specialist, who confirms the PCP's original diagnosis and provides the appropriate treatment to resolve the condition. These two independent doctor visits should be aggregated into one Condition Era. Each Condition Era corresponds to one or many Condition Occurrence records that form a continuous interval. The condition_concept_id field contains Concepts that are identical to those of the CONDITION_OCCURRENCE table records that make up the Condition Era. In contrast to Drug Eras, Condition Eras are not aggregated to contain Conditions of different hierarchical layers. The Condition Era Start Date is the start date of the first Condition Occurrence. The Condition Era End Date is the end date of the last Condition Occurrence. Condition Eras are built with a Persistence Window of 30 days, meaning, if no occurrence of the same condition_concept_id happens within 30 days of any one occurrence, it will be considered the condition_era_end_date.