OMOP/inst/csv/OMOP_CDMv5.4_Field_Level.csv

127 KiB
Raw Permalink Blame History

1cdmTableNamecdmFieldNameisRequiredcdmDatatypeuserGuidanceetlConventionsisPrimaryKeyisForeignKeyfkTableNamefkFieldNamefkDomainfkClassunique DQ identifiers
2personperson_idYesintegerIt 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 if it is an integer, otherwise it can be an autogenerated number.YesNoNANANANANA
3persongender_concept_idYesintegerThis 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](https://ohdsi.github.io/CommonDataModel/cdm531.html#observation) table. [Accepted gender concepts](http://athena.ohdsi.org/search-terms/terms?domain=Gender&standardConcept=Standard&page=1&pageSize=15&query=). Please refer to the [THEMIS repository](https://ohdsi.github.io/Themis/tag_gender_concept_id.html) for detailed conventions on how to populate this field.NoYesCONCEPTCONCEPT_IDGenderNANA
4personyear_of_birthYesintegerCompute age using year_of_birth.For data sources with date of birth, the year should be extracted. If no year of birth is available all the person's data should be dropped from the CDM instance. For additional information on how to populate this field, please refer to the [THEMIS repository](https://ohdsi.github.io/Themis/tag_year_of_birth.html).NoNoNANANANANA
5personmonth_of_birthNointegerNAFor data sources that provide the precise date of birth, the month should be extracted and stored in this field.NoNoNANANANANA
6personday_of_birthNointegerNAFor data sources that provide the precise date of birth, the day should be extracted and stored in this field.NoNoNANANANANA
7personbirth_datetimeNodatetimeNAThis field is not required but highly encouraged. For data sources that provide the precise datetime of birth, that value should be stored in this field. For more information on how to populate this field, please refer to the [THEMIS repository](https://ohdsi.github.io/Themis/person.html).NoNoNANANANANA
8personrace_concept_idYesintegerThis 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. [Accepted Race Concepts](http://athena.ohdsi.org/search-terms/terms?domain=Race&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDRaceNANA
9personethnicity_concept_idYesintegerThis 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. [Accepted ethnicity concepts](http://athena.ohdsi.org/search-terms/terms?domain=Ethnicity&standardConcept=Standard&page=1&pageSize=15&query=)NoYesCONCEPTCONCEPT_IDEthnicityNANA
10personlocation_idNointegerThe location refers to the physical address of the person. This field should capture the last known location of the person.Put the location_id from the [LOCATION](https://ohdsi.github.io/CommonDataModel/cdm531.html#location) table here that represents the most granular location information for the person. For additional information on how to populate this field, please refer to the [THEMIS repository](https://ohdsi.github.io/Themis/populate_person_location_id.html).NoYesLOCATIONLOCATION_IDNANANA
11personprovider_idNointegerThe Provider refers to the last known primary care provider (General Practitioner).Put the provider_id from the [PROVIDER](https://ohdsi.github.io/CommonDataModel/cdm531.html#provider) table of the last known general practitioner of the person. If there are multiple providers, it is up to the ETL to decide which to put here.NoYesPROVIDERPROVIDER_IDNANANA
12personcare_site_idNointegerThe Care Site refers to where the Provider typically provides the primary care.NANoYesCARE_SITECARE_SITE_IDNANANA
13personperson_source_valueNovarchar(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.NoNoNANANANANA
14persongender_source_valueNovarchar(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 assigned sex at birth of the person as it appears in the source data.NoNoNANANANANA
15persongender_source_concept_idNointegerDue to the small number of options, this tends to be zero.If the source data codes asigned sex at birth in a non-standard vocabulary, store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
16personrace_source_valueNovarchar(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.NoNoNANANANANA
17personrace_source_concept_idNointegerDue 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.NoYesCONCEPTCONCEPT_IDNANANA
18personethnicity_source_valueNovarchar(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.NoNoNANANANANA
19personethnicity_source_concept_idNointegerDue 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.NoYesCONCEPTCONCEPT_IDNANANA
20observation_periodobservation_period_idYesintegerA 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.YesNoNANANANANA
21observation_periodperson_idYesintegerThe Person ID of the PERSON record for which the Observation Period is recorded.NANoYesPERSONPERSON_IDNANANA
22observation_periodobservation_period_start_dateYesdateUse 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](https://ohdsi.github.io/CommonDataModel/cdm531.html#payer_plan_period).NoNoNANANANANA
23observation_periodobservation_period_end_dateYesdateUse 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.NoNoNANANANANA
24observation_periodperiod_type_concept_idYesintegerThis 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
25visit_occurrencevisit_occurrence_idYesintegerUse 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.YesNoNANANANANA
26visit_occurrenceperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
27visit_occurrencevisit_concept_idYesintegerThis 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDVisitNANA
28visit_occurrencevisit_start_dateYesdateFor 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. If this information is not available the record should be dropped.NoNoNANANANANA
29visit_occurrencevisit_start_datetimeNodatetimeNAIf no time is given for the start date of a visit, set it to midnight (00:00:0000).NoNoNANANANANA
30visit_occurrencevisit_end_dateYesdateFor inpatient visits the end date is typically the discharge date. If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.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.NoNoNANANANANA
31visit_occurrencevisit_end_datetimeNodatetimeIf a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_datetime, then set the visit_end_datetime to the datetime of the data pull.If no time is given for the end date of a visit, set it to midnight (00:00:0000).NoNoNANANANANA
32visit_occurrencevisit_type_concept_idYesIntegerUse 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
33visit_occurrenceprovider_idNointegerThere 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](https://ohdsi.github.io/CommonDataModel/cdm531.html#visit_detail) table.NoYesPROVIDERPROVIDER_IDNANANA
34visit_occurrencecare_site_idNointegerThis field provides information about the Care Site where the Visit took place.There should only be one Care Site associated with a Visit.NoYesCARE_SITECARE_SITE_IDNANANA
35visit_occurrencevisit_source_valueNovarchar(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.NoNoNANANANANA
36visit_occurrencevisit_source_concept_idNointegerNAIf the visit source value is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
37visit_occurrenceadmitted_from_concept_idNointegerUse 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). If a person was admitted from home or was self-referred, set this to 0.NoYesCONCEPTCONCEPT_IDVisitNANA
38visit_occurrenceadmitted_from_source_valueNovarchar(50)NAThis 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.NoNoNANANANANA
39visit_occurrencedischarged_to_concept_idNointegerUse 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 transferred to another hospital or sent to a long-term care facility, for example. It is assumed that a person is discharged to home therefore there is not a standard concept id for "home". Use concept id = 0 when a person is discharged to home.If available, map the discharged_to_source_value to a standard concept in the visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). NoYesCONCEPTCONCEPT_IDVisitNANA
40visit_occurrencedischarged_to_source_valueNovarchar(50)NAThis 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.NoNoNANANANANA
41visit_occurrencepreceding_visit_occurrence_idNointegerUse this field to find the visit that occurred for the person prior to the given visit. There could be a few days or a few years in between.This field 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".NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
42visit_detailvisit_detail_idYesintegerUse 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 detail.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.YesNoNANANANANA
43visit_detailperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
44visit_detailvisit_detail_concept_idYesintegerThis field contains a concept id representing the kind of visit detail, 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDVisitNANA
45visit_detailvisit_detail_start_dateYesdateThis is the date of the start of the encounter. This may or may not be equal to the date of the Visit the Visit Detail is associated with.When populating VISIT_DETAIL_START_DATE, you should think about the patient experience to make decisions on how to define visits. Most likely this should be the date of the patient-provider interaction.NoNoNANANANANA
46visit_detailvisit_detail_start_datetimeNodatetimeNAIf no time is given for the start date of a visit, set it to midnight (00:00:0000).NoNoNANANANANA
47visit_detailvisit_detail_end_dateYesdateThis the end date of the patient-provider interaction. If a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_date, then set the visit_end_date to the date of the data pull.Visit Detail end dates are mandatory. If end dates are not provided in the source there are three ways in which to derive them:<br> - Outpatient Visit Detail: visit_detail_end_datetime = visit_detail_start_datetime - Emergency Room Visit Detail: visit_detail_end_datetime = visit_detail_start_datetime - Inpatient Visit Detail: 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 Visit Details: Particularly for claims data, if end dates are not provided assume the visit is for the duration of month that it occurs.<br> For Inpatient Visit Details ongoing at the date of ETL, put date of processing the data into visit_detai_end_datetime and visit_detail_type_concept_id with 32220 "Still patient" to identify the visit as incomplete. All other Visits Details: visit_detail_end_datetime = visit_detail_start_datetime.NoNoNANANANANA
48visit_detailvisit_detail_end_datetimeNodatetimeIf a Person is still an inpatient in the hospital at the time of the data extract and does not have a visit_end_datetime, then set the visit_end_datetime to the datetime of the data pull.If no time is given for the end date of a visit, set it to midnight (00:00:0000).NoNoNANANANANA
49visit_detailvisit_detail_type_concept_idYesintegerUse this field to understand the provenance of the visit detail record, or where the record comes from.Populate this field based on the provenance of the visit detail record, as in whether it came from an EHR record or billing claim. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
50visit_detailprovider_idNointegerThere will only be one provider per **visit** record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). This is a typical reason for leveraging the VISIT_DETAIL table as even though each VISIT_DETAIL record can only have one provider, there is no limit to the number of VISIT_DETAIL records that can be associated to a VISIT_OCCURRENCE record.The additional providers associated to a Visit can be stored in this table where each VISIT_DETAIL record represents a different provider.NoYesPROVIDERPROVIDER_IDNANANA
51visit_detailcare_site_idNointegerThis field provides information about the Care Site where the Visit Detail took place.There should only be one Care Site associated with a Visit Detail.NoYesCARE_SITECARE_SITE_IDNANANA
52visit_detailvisit_detail_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the kind of visit detail that took place (inpatient, outpatient, emergency, etc.)If there is information about the kind of visit detail 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_DETAIL_SOURCE_VALUE, such as IP -> ER-> OP. This should line up with the logic chosen to determine how visits are created.NoNoNANANANANA
53visit_detailvisit_detail_source_concept_idNoIntegerNAIf the VISIT_DETAIL_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
54visit_detailadmitted_from_concept_idNoIntegerUse 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). If a person was admitted from home or was self-referred, set this to 0.NoYesCONCEPTCONCEPT_IDVisitNANA
55visit_detailadmitted_from_source_valueNovarchar(50)NAThis 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.NoNoNANANANANA
56visit_detaildischarged_to_source_valueNovarchar(50)NAThis 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.NoNoNANANANANA
57visit_detaildischarged_to_concept_idNointegerUse 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 transferred to another hospital or sent to a long-term care facility, for example. It is assumed that a person is discharged to home therefore there is not a standard concept id for "home". Use concept id = 0 when a person is discharged to home.If available, map the DISCHARGE_TO_SOURCE_VALUE to a Standard Concept in the Visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDVisitNANA
58visit_detailpreceding_visit_detail_idNointegerUse this field to find the visit detail that occurred for the person prior to the given visit detail record. There could be a few days or a few years in between.The PRECEDING_VISIT_DETAIL_ID can be used to link a visit immediately preceding the current Visit Detail. Note this is not symmetrical, and there is no such thing as a "following_visit_id".NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
59visit_detailparent_visit_detail_idNointegerUse this field to find the visit detail that subsumes the given visit detail record. This is used in the case that a visit detail record needs to be nested beyond the VISIT_OCCURRENCE/VISIT_DETAIL relationship.If there are multiple nested levels to how Visits are represented in the source, the VISIT_DETAIL_PARENT_ID can be used to record this relationship.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
60visit_detailvisit_occurrence_idYesintegerUse this field to link the VISIT_DETAIL record to its VISIT_OCCURRENCE.Put the VISIT_OCCURRENCE_ID that subsumes the VISIT_DETAIL record here.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
61condition_occurrencecondition_occurrence_idYesintegerThe 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.YesNoNANANANANA
62condition_occurrenceperson_idYesintegerThe PERSON_ID of the PERSON for whom the condition is recorded.NANoYesPERSONPERSON_IDNANANA
63condition_occurrencecondition_concept_idYesintegerThe 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 conditionThe 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Condition&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDConditionNANA
64condition_occurrencecondition_start_dateYesdateUse this date to determine the start date of the conditionMost 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.NoNoNANANANANA
65condition_occurrencecondition_start_datetimeNodatetimeNAIf a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
66condition_occurrencecondition_end_dateNodateUse this date to determine the end date of the conditionMost 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.NoNoNANANANANA
67condition_occurrencecondition_end_datetimeNodatetimeNAIf a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
68condition_occurrencecondition_type_concept_idYesintegerThis 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
69condition_occurrencecondition_status_concept_idNointegerThis 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.Choose the Concept in the Condition Status domain that best represents the point during the visit when the diagnosis was given. These can include admitting diagnosis, principal diagnosis, and secondary diagnosis. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Condition+Status&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDCondition StatusNANA
70condition_occurrencestop_reasonNovarchar(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.NoNoNANANANANA
71condition_occurrenceprovider_idNointegerThe provider associated with condition record, e.g. the provider who made the diagnosis or the provider who recorded the symptom.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, for example the admitting vs attending physician on an EHR record.NoYesPROVIDERPROVIDER_IDNANANA
72condition_occurrencevisit_occurrence_idNointegerThe visit during which the condition occurred.Depending on the structure of the source data, this may have to be determined based on dates. If a CONDITION_START_DATE occurs within the start and end date of a Visit it is a valid ETL choice to choose the VISIT_OCCURRENCE_ID from the Visit that subsumes it, even if not explicitly stated in the data. While not required, an attempt should be made to locate the VISIT_OCCURRENCE_ID of the CONDITION_OCCURRENCE record.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
73condition_occurrencevisit_detail_idNointegerThe VISIT_DETAIL record during which the condition occurred. 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.Same rules apply as for the VISIT_OCCURRENCE_ID.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
74condition_occurrencecondition_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the condition that occurred. For example, this could be an ICD10 or Read code.This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference.NoNoNANANANANA
75condition_occurrencecondition_source_concept_idNointegerThis is the concept representing the condition source value and may not necessarily be standard. 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.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.NoYesCONCEPTCONCEPT_IDNANANA
76condition_occurrencecondition_status_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the condition status.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.NoNoNANANANANA
77drug_exposuredrug_exposure_idYesintegerThe unique key given to records of drug dispensings or administrations for a person. Refer to the ETL for how duplicate drugs during the same visit were handled.Each instance of a drug dispensing or administration present in the source data should be assigned this unique key. In some cases, a person can have multiple records of the same drug within the same visit. It is valid to keep these duplicates and assign them individual, unique, DRUG_EXPOSURE_IDs, though it is up to the ETL how they should be handled.YesNoNANANANANA
78drug_exposureperson_idYesintegerThe PERSON_ID of the PERSON for whom the drug dispensing or administration is recorded. This may be a system generated code.NANoYesPERSONPERSON_IDNANANA
79drug_exposuredrug_concept_idYesintegerThe 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 concept id which represents a drug product or molecule otherwise introduced to the body. The drug concepts can have a varying degree of information about drug strength and dose. This information is relevant in the context of quantity and administration information in the subsequent fields plus strength information from the DRUG_STRENGTH table, provided as part of the standard vocabulary download.The CONCEPT_ID that the DRUG_SOURCE_VALUE maps to. The concept id should be derived either from mapping from the source concept id or by picking the drug concept representing the most amount of detail you have. Records whose source values map to standard concepts with a domain of Drug should go in this table. 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: <20>Marketed Product<63>, <20>Branded Pack<63>, <20>Clinical Pack<63>, <20>Branded Drug<75>, <20>Clinical Drug<75>, <20>Branded Drug Component<6E>, <20>Clinical Drug Component<6E>, <20>Branded Drug Form<72>, <20>Clinical Drug Form<72>, and only if no other information is available <20>Ingredient<6E>. Note: If only the drug class is known, the DRUG_CONCEPT_ID field should contain 0. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Drug&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDDrugNANA
80drug_exposuredrug_exposure_start_dateYesdateUse this date to determine the start date of the drug record.Valid entries include a start date of a prescription, the date a prescription was filled, or the date on which a Drug administration was recorded. It is a valid ETL choice to use the date the drug was ordered as the DRUG_EXPOSURE_START_DATE.NoNoNANANANANA
81drug_exposuredrug_exposure_start_datetimeNodatetimeNAThis is not required, though it is in v6. If a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
82drug_exposuredrug_exposure_end_dateYesdateThe DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient.If this information is not explicitly available in the data, infer the end date using the following methods:<br><br> 1. Start first with duration or days supply using the calculation drug start date + days supply -1 day. 2. Use quantity divided by daily dose that you may obtain from the sig or a source field (or assumed daily dose of 1) for solid, indivisibile, drug products. If quantity represents ingredient amount, quantity divided by daily dose * concentration (from drug_strength) drug concept id tells you the dose form. 3. If it is an administration record, set drug end date equal to drug start date. If the record is a written prescription then set end date to start date + 29. If the record is a mail-order prescription set end date to start date + 89. The end date must be equal to or greater than the start date. Ibuprofen 20mg/mL oral solution concept tells us this is oral solution. Calculate duration as quantity (200 example) * daily dose (5mL) /concentration (20mg/mL) 200*5/20 = 50 days. [Examples by dose form](https://ohdsi.github.io/CommonDataModel/drug_dose.html)<br><br>For detailed conventions for how to populate this field, please see the [THEMIS repository](https://ohdsi.github.io/Themis/tag_drug_exposure.html).NoNoNANANANANA
83drug_exposuredrug_exposure_end_datetimeNodatetimeNAThis is not required, though it is in v6. If a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
84drug_exposureverbatim_end_dateNodateThis is the end date of the drug exposure as it appears in the source data, if it is givenPut the end date or discontinuation date as it appears from the source data or leave blank if unavailable.NoNoNANANANANA
85drug_exposuredrug_type_concept_idYesintegerYou can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, etc.Choose the drug_type_concept_id that best represents the provenance of the record, for example whether it came from a record of a prescription written or physician administered drug. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
86drug_exposurestop_reasonNovarchar(20)The reason a person stopped a medication as it is represented in the source. Reasons include regimen completed, changed, removed, etc. This field will be retired in v6.0.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.NoNoNANANANANA
87drug_exposurerefillsNointegerThis is only filled in when the record is coming from a prescription written this field is meant to represent intended refills at time of the prescription.NANoNoNANANANANA
88drug_exposurequantityNofloatNATo find the dose form of a drug the RELATIONSHIP table can be used where the relationship_id is 'Has dose form'. If liquid, quantity stands for the total amount dispensed or ordered of ingredient in the units given by the drug_strength table. If the unit from the source data does not align with the unit in the DRUG_STRENGTH table the quantity should be converted to the correct unit given in DRUG_STRENGTH. For clinical drugs with fixed dose forms (tablets etc.) the quantity is the number of units/tablets/capsules prescribed or dispensed (can be partial, but then only 1/2 or 1/3, not 0.01). Clinical drugs with divisible dose forms (injections) the quantity is the amount of ingredient the patient got. For example, if the injection is 2mg/mL but the patient got 80mL then quantity is reported as 160. Quantified clinical drugs with divisible dose forms (prefilled syringes), the quantity is the amount of ingredient similar to clinical drugs. Please see [how to calculate drug dose](https://ohdsi.github.io/CommonDataModel/drug_dose.html) for more information. NoNoNANANANANA
89drug_exposuredays_supplyNointegerNAThe number of days of supply of the medication as recorded in the original prescription or dispensing record. Days supply can differ from actual drug duration (i.e. prescribed days supply vs actual exposure).","The field should be left empty if the source data does not contain a verbatim days_supply, and should not be calculated from other fields.<br><br>Negative values are not allowed. If the source has negative days supply the record should be dropped as it is unknown if the patient actually took the drug. Several actions are possible: 1) record is not trustworthy and we remove the record entirely. 2) we trust the record and leave days_supply empty or 3) record needs to be combined with other record (e.g. reversal of prescription). High values (>365 days) should be investigated. If considered an error in the source data (e.g. typo), the value needs to be excluded to prevent creation of unrealistic long eras.NoNoNANANANANA
90drug_exposuresigNovarchar(MAX)This is the verbatim instruction for the drug as written by the provider.Put the written out instructions for the drug as it is verbatim in the source, if available.NoNoNANANANANA
91drug_exposureroute_concept_idNointegerNAThe standard CONCEPT_ID that the ROUTE_SOURCE_VALUE maps to in the route domain.NoYesCONCEPTCONCEPT_IDRouteNANA
92drug_exposurelot_numberNovarchar(50)NANANoNoNANANANANA
93drug_exposureprovider_idNointegerThe Provider associated with drug record, e.g. the provider who wrote the prescription or the provider who administered the drug.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, for example the ordering vs administering physician on an EHR record.NoYesPROVIDERPROVIDER_IDNANANA
94drug_exposurevisit_occurrence_idNointegerThe Visit during which the drug was prescribed, administered or dispensed.To populate this field drug exposures must be explicitly initiated in the visit.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
95drug_exposurevisit_detail_idNointegerThe VISIT_DETAIL record during which the drug exposure occurred. For example, if the person was in the ICU at the time of the drug administration the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.Same rules apply as for the VISIT_OCCURRENCE_ID.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
96drug_exposuredrug_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the drug exposure that occurred. For example, this could be an NDC or Gemscript code.This code is mapped to a Standard Drug Concept in the Standardized Vocabularies and the original code is stored here for reference.NoNoNANANANANA
97drug_exposuredrug_source_concept_idNointegerThis is the concept representing the drug source value and may not necessarily be standard. 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 Drug necessary for a given analytic use case. Consider using DRUG_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.If the DRUG_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
98drug_exposureroute_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the drug route.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 drug was given to a patient. This source value is mapped to a standard concept which is stored in the ROUTE_CONCEPT_ID field.NoNoNANANANANA
99drug_exposuredose_unit_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the dose unit of the drug given.This information may be called something different in the source data but the field is meant to contain a value indicating the unit of dosage of drug given to the patient. **This is an older column and will be deprecated in an upcoming version.**NoNoNANANANANA
100procedure_occurrenceprocedure_occurrence_idYesintegerThe unique key given to a procedure record for a person. Refer to the ETL for how duplicate procedures during the same visit were handled.Each instance of a procedure occurrence in the source data should be assigned this unique key. In some cases, a person can have multiple records of the same procedure within the same visit. It is valid to keep these duplicates and assign them individual, unique, PROCEDURE_OCCURRENCE_IDs, though it is up to the ETL how they should be handled.YesNoNANANANANA
101procedure_occurrenceperson_idYesintegerThe PERSON_ID of the PERSON for whom the procedure is recorded. This may be a system generated code.NANoYesPERSONPERSON_IDNANANA
102procedure_occurrenceprocedure_concept_idYesintegerThe PROCEDURE_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 procedureThe CONCEPT_ID that the PROCEDURE_SOURCE_VALUE maps to. Only records whose source values map to standard concepts with a domain of "Procedure" should go in this table. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Procedure&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDProcedureNANA
103procedure_occurrenceprocedure_dateYesdateUse this date to determine the date the procedure started.This is meant to be the **start date** of the procedure. It will be renamed in a future version to **PROCEDURE_START_DATE**.NoNoNANANANANA
104procedure_occurrenceprocedure_datetimeNodatetimeNAIf the procedure has a start time in the native date, use this field to house that information. This will be renamed in a future version to **PROCEDURE_START_DATETIME**.NoNoNANANANANA
105procedure_occurrenceprocedure_end_dateNodateUse this field to house the date that the procedure ended.This is meant to be the end date of the procedure. It is not required and for most cases will be the same as the PROCEDURE_START_DATE.NoNoNANANANANA
106procedure_occurrenceprocedure_end_datetimeNodatetimeUse this field to house the datetime that the procedure ended.This is meant to house the end datetime of the procedure and will most often be used in conjunction with the procedure_start_datetime to determine the length of the procedure.NoNoNANANANANA
107procedure_occurrenceprocedure_type_concept_idYesintegerThis field can be used to determine the provenance of the Procedure record, as in whether the procedure was from an EHR system, insurance claim, registry, or other sources.Choose the PROCEDURE_TYPE_CONCEPT_ID that best represents the provenance of the record, for example whether it came from an EHR record or billing claim. If a procedure is recorded as an EHR encounter, the PROCEDURE_TYPE_CONCEPT would be 'EHR encounter record'. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
108procedure_occurrencemodifier_concept_idNointegerThe modifiers are intended to give additional information about the procedure but as of now the vocabulary is under review.It is up to the ETL to choose how to map modifiers if they exist in source data. These concepts are typically distinguished by 'Modifier' concept classes (e.g., 'CPT4 Modifier' as part of the 'CPT4' vocabulary). If there is more than one modifier on a record, one should be chosen that pertains to the procedure rather than provider. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?conceptClass=CPT4+Modifier&conceptClass=HCPCS+Modifier&vocabulary=CPT4&vocabulary=HCPCS&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDNANANA
109procedure_occurrencequantityNointegerIf 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 onceNoNoNANANANANA
110procedure_occurrenceprovider_idNointegerThe provider associated with the procedure record, e.g. the provider who performed the Procedure.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, for example the admitting vs attending physician on an EHR record.NoYesPROVIDERPROVIDER_IDNANANA
111procedure_occurrencevisit_occurrence_idNointegerThe visit during which the procedure occurred.Depending on the structure of the source data, this may have to be determined based on dates. If a PROCEDURE_DATE occurs within the start and end date of a Visit it is a valid ETL choice to choose the VISIT_OCCURRENCE_ID from the Visit that subsumes it, even if not explicitly stated in the data. While not required, an attempt should be made to locate the VISIT_OCCURRENCE_ID of the PROCEDURE_OCCURRENCE record.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
112procedure_occurrencevisit_detail_idNointegerThe VISIT_DETAIL record during which the Procedure occurred. For example, if the Person was in the ICU at the time of the Procedure the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.Same rules apply as for the VISIT_OCCURRENCE_ID.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
113procedure_occurrenceprocedure_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the procedure that occurred. For example, this could be an CPT4 or OPCS4 code.Use this value to look up the source concept id and then map the source concept id to a standard concept id.NoNoNANANANANA
114procedure_occurrenceprocedure_source_concept_idNointegerThis is the concept representing the procedure source value and may not necessarily be standard. 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 Procedure necessary for a given analytic use case. Consider using PROCEDURE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.If the PROCEDURE_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
115procedure_occurrencemodifier_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the modifier code for the procedure that occurred.The value stored here is mapped to a MODIFIER_CONCEPT_ID.NoNoNANANANANA
116device_exposuredevice_exposure_idYesintegerThe unique key given to records a person's exposure to a foreign physical object or instrument.Each instance of an exposure to a foreign object or device present in the source data should be assigned this unique key.YesNoNANANANANA
117device_exposureperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
118device_exposuredevice_concept_idYesintegerThe DEVICE_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 concept id which represents a foreign object or instrument the person was exposed to.The CONCEPT_ID that the DEVICE_SOURCE_VALUE maps to.NoYesCONCEPTCONCEPT_IDDeviceNANA
119device_exposuredevice_exposure_start_dateYesdateUse this date to determine the start date of the device record.Valid entries include a start date of a procedure to implant a device, the date of a prescription for a device, or the date of device administration.NoNoNANANANANA
120device_exposuredevice_exposure_start_datetimeNodatetimeNAThis is not required, though it is in v6. If a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
121device_exposuredevice_exposure_end_dateNodateThe DEVICE_EXPOSURE_END_DATE denotes the day the device exposure ended for the patient, if given.Put the end date or discontinuation date as it appears from the source data or leave blank if unavailable.NoNoNANANANANA
122device_exposuredevice_exposure_end_datetimeNodatetimeNAIf a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
123device_exposuredevice_type_concept_idYesintegerYou can use the TYPE_CONCEPT_ID to denote the provenance of the record, as in whether the record is from administrative claims or EHR.Choose the drug_type_concept_id that best represents the provenance of the record, for example whether it came from a record of a prescription written or physician administered drug. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
124device_exposureunique_device_idNovarchar(255)This is the Unique Device Identification (UDI-DI) number for devices regulated by the FDA, if given.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.NoNoNANANANANA
125device_exposureproduction_idNovarchar(255)This is the Production Identifier (UDI-PI) portion of the Unique Device Identification.NANoNoNANANANANA
126device_exposurequantityNointegerNAIf there is a record of device exposure in the source but no quantity value, then set to 1.NoNoNANANANANA
127device_exposureprovider_idNointegerThe Provider associated with device record, e.g. the provider who wrote the prescription or the provider who implanted the device.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.NoYesPROVIDERPROVIDER_IDNANANA
128device_exposurevisit_occurrence_idNointegerThe Visit during which the device was prescribed or given.To populate this field device exposures must be explicitly initiated in the visit.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
129device_exposurevisit_detail_idNointegerThe Visit Detail during which the device was prescribed or given.To populate this field device exposures must be explicitly initiated in the visit detail record.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
130device_exposuredevice_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the device exposure that occurred. For example, this could be an NDC or Gemscript code.This code is mapped to a Standard Device Concept in the Standardized Vocabularies and the original code is stored here for reference.NoNoNANANANANA
131device_exposuredevice_source_concept_idNointegerThis is the concept representing the device source value and may not necessarily be standard. 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 Device necessary for a given analytic use case. Consider using DEVICE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.If the DEVICE_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
132device_exposureunit_concept_idNointegerUNIT_SOURCE_VALUES should be mapped to a Standard Concept in the Unit domain that best represents the unit as given in the source data.There is no standardization requirement for units associated with DEVICE_CONCEPT_IDs, however, it is the responsibility of the ETL to choose the most plausible unit. If the source unit is NULL (applicable to cases when there's no numerical value or when it doesn't require a unit), keep unit_concept_id NULL as well. If there's no mapping of a source unit, populate unit_concept_id with 0.NoYesCONCEPTCONCEPT_IDUnitNANA
133device_exposureunit_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the unit of the Device. For example, blood transfusions are considered devices and can be given in mL quantities.This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference. Using the blood transfusion example, blood transfusion is represented by the DEVICE_CONCEPT_ID and the unit (mL) would be housed in the UNIT_SOURCE_VALUE and mapped to a standard concept in the unit domain.NoNoNANANANANA
134device_exposureunit_source_concept_idNointegerThis is the concept representing the UNIT_SOURCE_VALUE and may not necessarily be standard. 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 Unit necessary for a given analytic use case. Consider using UNIT_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.If the UNIT_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
135measurementmeasurement_idYesintegerThe unique key given to a Measurement record for a Person. Refer to the ETL for how duplicate Measurements during the same Visit were handled.Each instance of a measurement present in the source data should be assigned this unique key. In some cases, a person can have multiple records of the same measurement within the same visit. It is valid to keep these duplicates and assign them individual, unique, MEASUREMENT_IDs, though it is up to the ETL how they should be handled.YesNoNANANANANA
136measurementperson_idYesintegerThe PERSON_ID of the Person for whom the Measurement is recorded. This may be a system generated code.NANoYesPERSONPERSON_IDNANANA
137measurementmeasurement_concept_idYesintegerThe MEASUREMENT_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 measurement.The CONCEPT_ID that the MEASUREMENT_SOURCE_VALUE maps to. Only records whose source values map to concepts with a domain of <20>Measurement<6E> should go in this table.NoYesCONCEPTCONCEPT_IDMeasurementNANA
138measurementmeasurement_dateYesdateUse this date to determine the date of the measurement.If there are multiple dates in the source data associated with a record such as order_date, draw_date, and result_date, choose the one that is closest to the date the sample was drawn from the patient.NoNoNANANANANA
139measurementmeasurement_datetimeNodatetimeNAThis is not required, though it is in v6. If a source does not specify datetime the convention is to set the time to midnight (00:00:0000)NoNoNANANANANA
140measurementmeasurement_timeNovarchar(10)NAThis is present for backwards compatibility and will be deprecated in an upcoming version.NoNoNANANANANA
141measurementmeasurement_type_concept_idYesintegerThis field can be used to determine the provenance of the Measurement record, as in whether the measurement was from an EHR system, insurance claim, registry, or other sources.Choose the MEASUREMENT_TYPE_CONCEPT_ID that best represents the provenance of the record, for example whether it came from an EHR record or billing claim. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
142measurementoperator_concept_idNointegerThe meaning of Concept [4172703](https://athena.ohdsi.org/search-terms/terms/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 =.Operators are <, <=, =, >=, > and these concepts belong to the 'Meas Value Operator' domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Meas+Value+Operator&standardConcept=Standard&page=1&pageSize=15&query=). Leave it NULL if there's an exact numeric value given (instead of putting '=') or there's no numeric value at all.NoYesCONCEPTCONCEPT_IDNANANA
143measurementvalue_as_numberNofloatThis is the numerical value of the Result of the Measurement, if available. Note that measurements such as blood pressures will be split into their component parts i.e. one record for systolic, one record for diastolic.[Convention for negative values](https://ohdsi.github.io/Themis/negative_value_as_number.html)NoNoNANANANANA
144measurementvalue_as_concept_idNointegerIf the raw data gives a categorial result for measurements those values are captured and mapped to standard concepts in the 'Meas Value' domain.If there is no categorial result in the source data, set VALUE_AS_CONCEPT_ID to NULL, if there is a categorial result in a source data but without mapping, set VALUE_AS_CONCEPT_ID to 0, else map to a CONCEPT_ID.NoYesCONCEPTCONCEPT_IDNANANA
145measurementunit_concept_idNointegerAt present, there isn't a prescribed unit for individual measurements, such as Hemoglobin A1C, meaning it's not obligatory to express these measurements as a percentage. UNIT_SOURCE_VALUES should be linked to a Standard Concept within the Unit domain that most accurately reflects the unit provided in the source data.If the source data does not include units, set UNIT_CONCEPT_ID to NULL. If units are provided but not mapped, set UNIT_CONCEPT_ID to 0. Otherwise, map the units to a CONCEPT_ID. Remember that units are case-sensitive in vocabulary.NoYesCONCEPTCONCEPT_IDUnitNANA
146measurementrange_lowNofloatRanges have the same unit as the VALUE_AS_NUMBER. These ranges are provided by the source and should remain NULL if not given.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. This should be set to NULL if not provided.NoNoNANANANANA
147measurementrange_highNofloatRanges have the same unit as the VALUE_AS_NUMBER. These ranges are provided by the source and should remain NULL if not given.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. This should be set to NULL if not provided.NoNoNANANANANA
148measurementprovider_idNointegerThe provider associated with measurement record, e.g. the provider who ordered the test or the provider who recorded the result.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. For example the admitting vs attending physician on an EHR record.NoYesPROVIDERPROVIDER_IDNANANA
149measurementvisit_occurrence_idNointegerThe visit during which the Measurement occurred.Depending on the structure of the source data, this may have to be determined based on dates. If a MEASUREMENT_DATE occurs within the start and end date of a Visit it is a valid ETL choice to choose the VISIT_OCCURRENCE_ID from the visit that subsumes it, even if not explicitly stated in the data. While not required, an attempt should be made to locate the VISIT_OCCURRENCE_ID of the measurement record. If a measurement is related to a visit explicitly in the source data, it is possible that the result date of the Measurement falls outside of the bounds of the Visit dates.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
150measurementvisit_detail_idNointegerThe VISIT_DETAIL record during which the Measurement occurred. For example, if the Person was in the ICU at the time the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.Same rules apply as for the VISIT_OCCURRENCE_ID.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
151measurementmeasurement_source_valueNovarchar(50)This field contains the exact value from the source data that represents the measurement that occurred.This value corresponds to a standardized CONCEPT_ID found in MEASUREMENT_CONCEPT_ID and in the 'Measurement' domain within the Standardized Vocabularies. The original code is retained here for reference purposes.NoNoNANANANANA
152measurementmeasurement_source_concept_idNointegerThis is the concept representing the MEASUREMENT_SOURCE_VALUE and may not necessarily be standard. 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 Measurement necessary for a given analytic use case. Consider using MEASUREMENT_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.If the MEASUREMENT_SOURCE_VALUE is coded in the source data using a vocabulary supported by OMOP Standardized Vocabularies, insert the CONCEPT_ID representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
153measurementunit_source_valueNovarchar(50)This field contains the exact value from the source data that represents the unit of measurement used.This value corresponds to a standardized CONCEPT_ID found in UNIT_CONCEPT_ID and in the 'Unit' domain within the Standardized Vocabularies. The original code is retained here for reference purposes.NoNoNANANANANA
154measurementunit_source_concept_idNointeger"This is the concept representing the UNIT_SOURCE_VALUE and may not necessarily be standard. 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 Measurement necessary for a given analytic use case. Consider using UNIT_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network."If the UNIT_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
155measurementvalue_source_valueNovarchar(50)This field houses the verbatim result value of the Measurement from the source data .If both a continuous and categorical result are given in the source data such that both VALUE_AS_NUMBER and VALUE_AS_CONCEPT_ID are both included, store the verbatim value that was mapped to VALUE_AS_CONCEPT_ID here.NoNoNANANANANA
156measurementmeasurement_event_idNointegerIf the Measurement record is related to another record in the database, this field is the primary key of the linked record.Put the primary key of the linked record, if applicable, here.NoNoNANANANANA
157measurementmeas_event_field_concept_idNointegerIf the Measurement record is related to another record in the database, this field is the CONCEPT_ID that identifies which table the primary key of the linked record came from.Put the CONCEPT_ID that identifies which table and field the MEASUREMENT_EVENT_ID came from.NoYesCONCEPTCONCEPT_IDNANANA
158observationobservation_idYesintegerThe unique key given to an Observation record for a Person. Refer to the ETL for how duplicate Observations during the same Visit were handled.Each instance of an observation present in the source data should be assigned this unique key.YesNoNANANANANA
159observationperson_idYesintegerThe PERSON_ID of the Person for whom the Observation is recorded. This may be a system generated code.NANoYesPERSONPERSON_IDNANANA
160observationobservation_concept_idYesintegerThe OBSERVATION_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies.The CONCEPT_ID that the OBSERVATION_SOURCE_CONCEPT_ID maps to. There is no specified domain that the Concepts in this table must adhere to. The only rule is that records with Concepts in the Condition, Procedure, Drug, Measurement, or Device domains MUST go to the corresponding table.NoYesCONCEPTCONCEPT_IDNANANA
161observationobservation_dateYesdateThe date of when the Observation was obtained. Depending on what the Observation represents this could be the date of a lab test, the date of a survey, or the date a patient's family history was taken.For some observations the ETL may need to make a choice as to which date to choose.NoNoNANANANANA
162observationobservation_datetimeNodatetimeNAIf no time is given set to midnight (00:00:00).NoNoNANANANANA
163observationobservation_type_concept_idYesintegerThis field can be used to determine the provenance of the Observation record, as in whether the measurement was from an EHR system, insurance claim, registry, or other sources.Choose the OBSERVATION_TYPE_CONCEPT_ID that best represents the provenance of the record, for example whether it came from an EHR record or billing claim. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
164observationvalue_as_numberNofloatThis is the numerical value of the Result of the Observation, if applicable and available. It is not expected that all Observations will have numeric results, rather, this field is here to house values should they exist.NANoNoNANANANANA
165observationvalue_as_stringNovarchar(60)This is the categorical value of the Result of the Observation, if applicable and available.NANoNoNANANANANA
166observationvalue_as_concept_idNoIntegerIt is possible that some records destined for the Observation table have two clinical ideas represented in one source code. This is common with ICD10 codes that describe a family history of some Condition, for example. In OMOP the Vocabulary breaks these two clinical ideas into two codes; one becomes the OBSERVATION_CONCEPT_ID and the other becomes the VALUE_AS_CONCEPT_ID. It is important when using the Observation table to keep this possibility in mind and to examine the VALUE_AS_CONCEPT_ID field for relevant information.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, ICD10 [Z82.4](https://athena.ohdsi.org/search-terms/terms/45581076) 'Family history of ischaemic heart disease and other diseases of the circulatory system' has a 'Maps to' relationship to [4167217](https://athena.ohdsi.org/search-terms/terms/4167217) 'Family history of clinical finding' as well as a 'Maps to value' record to [134057](https://athena.ohdsi.org/search-terms/terms/134057) 'Disorder of cardiovascular system'. If there's no categorial result in a source_data, set value_as_concept_id to NULL, if there is a categorial result in a source_data but without mapping, set value_as_concept_id to 0.NoYesCONCEPTCONCEPT_IDNANANA
167observationqualifier_concept_idNointegerThis field contains all attributes specifying the clinical fact further, such as as degrees, severities, drug-drug interaction alerts etc.Use your best judgement as to what Concepts to use here and if they are necessary to accurately represent the clinical record. There is no restriction on the domain of these Concepts, they just need to be Standard.NoYesCONCEPTCONCEPT_IDNANANA
168observationunit_concept_idNointegerThere is currently no recommended unit for individual observation concepts. UNIT_SOURCE_VALUES should be mapped to a Standard Concept in the Unit domain that best represents the unit as given in the source data.There is no standardization requirement for units associated with OBSERVATION_CONCEPT_IDs, however, it is the responsibility of the ETL to choose the most plausible unit. If the source unit is NULL (applicable to cases when there's no numerical value or when it doesn't require a unit), keep unit_concept_id NULL as well. If there's no mapping of a source unit, populate unit_concept_id with 0.NoYesCONCEPTCONCEPT_IDUnitNANA
169observationprovider_idNointegerThe provider associated with the observation record, e.g. the provider who ordered the test or the provider who recorded the result.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. For example the admitting vs attending physician on an EHR record.NoYesPROVIDERPROVIDER_IDNANANA
170observationvisit_occurrence_idNointegerThe visit during which the Observation occurred.Depending on the structure of the source data, this may have to be determined based on dates. If an OBSERVATION_DATE occurs within the start and end date of a Visit it is a valid ETL choice to choose the VISIT_OCCURRENCE_ID from the visit that subsumes it, even if not explicitly stated in the data. While not required, an attempt should be made to locate the VISIT_OCCURRENCE_ID of the observation record. If an observation is related to a visit explicitly in the source data, it is possible that the result date of the Observation falls outside of the bounds of the Visit dates.NoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
171observationvisit_detail_idNointegerThe VISIT_DETAIL record during which the Observation occurred. For example, if the Person was in the ICU at the time the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.Same rules apply as for the VISIT_OCCURRENCE_ID.NoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
172observationobservation_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the Observation that occurred. For example, this could be an ICD10 or Read code.This code is mapped to a Standard Concept in the Standardized Vocabularies and the original code is stored here for reference.NoNoNANANANANA
173observationobservation_source_concept_idNointegerThis is the concept representing the OBSERVATION_SOURCE_VALUE and may not necessarily be standard. 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 Observation necessary for a given analytic use case. Consider using OBSERVATION_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.If the OBSERVATION_SOURCE_VALUE is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here.NoYesCONCEPTCONCEPT_IDNANANA
174observationunit_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the unit of the Observation that occurred.This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference.NoNoNANANANANA
175observationqualifier_source_valueNovarchar(50)This field houses the verbatim value from the source data representing the qualifier of the Observation that occurred.This code is mapped to a Standard Condition Concept in the Standardized Vocabularies and the original code is stored here for reference.NoNoNANANANANA
176observationvalue_source_valueNovarchar(50)This field houses the verbatim result value of the Observation from the source data. Do not get confused with the Observation_source_value which captures source value of the observation mapped to observation_concept_id. This field is the observation result value from the source.If the observation_source_value was a question, for example, or an observation that requires a result then this field is the answer/ result from the source data. Store the verbatim value that represents the result of the observation_source_value.NoNoNANANANANA
177observationobservation_event_idNointegerIf the Observation record is related to another record in the database, this field is the primary key of the linked record.Put the primary key of the linked record, if applicable, here. See the [ETL Conventions for the OBSERVATION](https://ohdsi.github.io/CommonDataModel/cdm60.html#observation) table for more details.NoNoNANANANANA
178observationobs_event_field_concept_idNointegerIf the Observation record is related to another record in the database, this field is the CONCEPT_ID that identifies which table the primary key of the linked record came from.Put the CONCEPT_ID that identifies which table and field the OBSERVATION_EVENT_ID came from.NoYesCONCEPTCONCEPT_IDNANANA
179deathperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
180deathdeath_dateYesdateThe date the person was deceased.If the precise date include 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. For additional conventions related to this field, please refer to the [THEMIS repository](https://ohdsi.github.io/Themis/tag_death_date.html). NoNoNANANANANA
181deathdeath_datetimeNodatetimeNAIf you have date and time of death, populate death_datetime, otherwise leave NULLNoNoNANANANANA
182deathdeath_type_concept_idNointegerThis is the provenance of the death record, i.e., where it came from. It is possible that an administrative claims database would source death information from a government file so do not assume the Death Type is the same as the Visit Type, etc.Use the type concept that reflects the source of the death record. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
183deathcause_concept_idNointegerThis is the Standard Concept representing the Person's cause of death, if available.There is no specified domain for this concept, just choose the Standard Concept Id that best represents the person's cause of death.NoYesCONCEPTCONCEPT_IDNANANA
184deathcause_source_valueNovarchar(50)NAIf available, put the source code representing the cause of death here.NoNoNANANANANA
185deathcause_source_concept_idNointegerNAIf the cause of death was coded using a Vocabulary present in the OMOP Vocabularies (not necessarily a standard concept) put the CONCEPT_ID representing the cause of death here.NoYesCONCEPTCONCEPT_IDNANANA
186notenote_idYesintegerA unique identifier for each note.NAYesNoNANANANANA
187noteperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
188notenote_dateYesdateThe date the note was recorded.NANoNoNANANANANA
189notenote_datetimeNodatetimeNAIf time is not given set the time to midnight.NoNoNANANANANA
190notenote_type_concept_idYesintegerThe provenance of the note. Most likely this will be EHR.Put the source system of the note, as in EHR record. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?standardConcept=Standard&domain=Type+Concept&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
191notenote_class_concept_idYesintegerA Standard Concept Id representing the HL7 LOINC Document Type Vocabulary classification of the note.Map the note classification to a Standard Concept. For more information see the ETL Conventions in the description of the NOTE table. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?standardConcept=Standard&conceptClass=Doc+Kind&conceptClass=Doc+Role&conceptClass=Doc+Setting&conceptClass=Doc+Subject+Matter&conceptClass=Doc+Type+of+Service&domain=Meas+Value&page=1&pageSize=15&query=). This Concept can alternatively be represented by concepts with the relationship 'Kind of (LOINC)' to [706391](https://athena.ohdsi.org/search-terms/terms/706391) (Note).NoYesCONCEPTCONCEPT_IDNANANA
192notenote_titleNovarchar(250)The title of the note.NANoNoNANANANANA
193notenote_textYesvarchar(MAX)The content of the note.NANoNoNANANANANA
194noteencoding_concept_idYesintegerThis is the Concept representing the character encoding type.Put the Concept Id that represents the encoding character type here. Currently the only option is UTF-8 ([32678](https://athena.ohdsi.org/search-terms/terms/32678)). It the note is encoded in any other type, like ASCII then put 0.NoYesCONCEPTCONCEPT_IDNANANA
195notelanguage_concept_idYesintegerThe language of the note.Use Concepts that are descendants of the concept [4182347](https://athena.ohdsi.org/search-terms/terms/4182347) (World Languages).NoYesCONCEPTCONCEPT_IDNANANA
196noteprovider_idNointegerThe Provider who wrote the note.The ETL may need to make a determination on which provider to put here.NoYesPROVIDERPROVIDER_IDNANANA
197notevisit_occurrence_idNointegerThe Visit during which the note was written.NANoYesVISIT_OCCURRENCEVISIT_OCCURRENCE_IDNANANA
198notevisit_detail_idNointegerThe Visit Detail during which the note was written.NANoYesVISIT_DETAILVISIT_DETAIL_IDNANANA
199notenote_source_valueNovarchar(50)NAThe source value mapped to the NOTE_CLASS_CONCEPT_ID.NoNoNANANANANA
200notenote_event_idNointegerIf the Note record is related to another record in the database, this field is the primary key of the linked record.Put the primary key of the linked record, if applicable, here.NoNoNANANANANA
201notenote_event_field_concept_idNointegerIf the Note record is related to another record in the database, this field is the CONCEPT_ID that identifies which table the primary key of the linked record came from.Put the CONCEPT_ID that identifies which table and field the NOTE_EVENT_ID came from.NoYesCONCEPTCONCEPT_IDNANANA
202note_nlpnote_nlp_idYesintegerA unique identifier for the NLP record.NAYesNoNANANANANA
203note_nlpnote_idYesintegerThis is the NOTE_ID for the NOTE record the NLP record is associated to.NANoNoNANANANANA
204note_nlpsection_concept_idNointegerNAThe SECTION_CONCEPT_ID should be used to represent the note section contained in the NOTE_NLP record. These concepts can be found as parts of document panels and are based on the type of note written, i.e. a discharge summary. These panels can be found as concepts with the relationship 'Subsumes' to CONCEPT_ID [45875957](https://athena.ohdsi.org/search-terms/terms/45875957).NoYesCONCEPTCONCEPT_IDNANANA
205note_nlpsnippetNovarchar(250)A small window of text surrounding the termNANoNoNANANANANA
206note_nlp"offset"Novarchar(50)Character offset of the extracted term in the input noteNANoNoNANANANANA
207note_nlplexical_variantYesvarchar(250)Raw text extracted from the NLP tool.NANoNoNANANANANA
208note_nlpnote_nlp_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
209note_nlpnote_nlp_source_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
210note_nlpnlp_systemNovarchar(250)NAName and version of the NLP system that extracted the term. Useful for data provenance.NoNoNANANANANA
211note_nlpnlp_dateYesdateThe date of the note processing.NANoNoNANANANANA
212note_nlpnlp_datetimeNodatetimeThe date and time of the note processing.NANoNoNANANANANA
213note_nlpterm_existsNovarchar(1)NATerm_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. NoNoNANANANANA
214note_nlpterm_temporalNovarchar(50)NATerm_temporal is to indicate if a condition is present or just in the past. The following would be past:<br><br> - History = true - Concept_date = anything before the time of the reportNoNoNANANANANA
215note_nlpterm_modifiersNovarchar(2000)NAFor the modifiers that are there, they would have to have these values:<br><br> - 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.NoNoNANANANANA
216specimenspecimen_idYesintegerUnique identifier for each specimen.NAYesNoNANANANANA
217specimenperson_idYesintegerThe person from whom the specimen is collected.NANoYesPERSONPERSON_IDNANANA
218specimenspecimen_concept_idYesintegerNAThe standard CONCEPT_ID that the SPECIMEN_SOURCE_VALUE maps to in the specimen domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Specimen&standardConcept=Standard&page=1&pageSize=15&query=)NoYesCONCEPTCONCEPT_IDNANANA
219specimenspecimen_type_concept_idYesintegerNAPut the source of the specimen record, as in an EHR system. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?standardConcept=Standard&domain=Type+Concept&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
220specimenspecimen_dateYesdateThe date the specimen was collected.NANoNoNANANANANA
221specimenspecimen_datetimeNodatetimeNANANoNoNANANANANA
222specimenquantityNofloatThe amount of specimen collected from the person.NANoNoNANANANANA
223specimenunit_concept_idNointegerThe unit for the quantity of the specimen.Map the UNIT_SOURCE_VALUE to a Standard Concept in the Unit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Unit&standardConcept=Standard&page=1&pageSize=15&query=). If the source unit is NULL (applicable to cases when there's no numerical value or when it doesn't require a unit), keep unit_concept_id NULL as well. If there's no mapping of a source unit, populate unit_concept_id with 0.NoYesCONCEPTCONCEPT_IDNANANA
224specimenanatomic_site_concept_idNointegerThis is the site on the body where the specimen is from.Map the ANATOMIC_SITE_SOURCE_VALUE to a Standard Concept in the Spec Anatomic Site domain. This should be coded at the lowest level of granularity [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?standardConcept=Standard&domain=Spec+Anatomic+Site&conceptClass=Body+Structure&page=4&pageSize=15&query=)NoYesCONCEPTCONCEPT_IDNANANA
225specimendisease_status_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
226specimenspecimen_source_idNovarchar(50)This is the identifier for the specimen from the source system.NANoNoNANANANANA
227specimenspecimen_source_valueNovarchar(50)NANANoNoNANANANANA
228specimenunit_source_valueNovarchar(50)NAThis unit for the quantity of the specimen, as represented in the source.NoNoNANANANANA
229specimenanatomic_site_source_valueNovarchar(50)NAThis is the site on the body where the specimen was taken from, as represented in the source.NoNoNANANANANA
230specimendisease_status_source_valueNovarchar(50)NANANoNoNANANANANA
231fact_relationshipdomain_concept_id_1YesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
232fact_relationshipfact_id_1YesintegerNANANoNoNANANANANA
233fact_relationshipdomain_concept_id_2YesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
234fact_relationshipfact_id_2YesintegerNANANoNoNANANANANA
235fact_relationshiprelationship_concept_idYesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
236locationlocation_idYesintegerThe unique key given to a unique Location.Each instance of a Location in the source data should be assigned this unique key.YesNoNANANANANA
237locationaddress_1Novarchar(50)This is the first line of the address.NANoNoNANANANANA
238locationaddress_2Novarchar(50)This is the second line of the addressNANoNoNANANANANA
239locationcityNovarchar(50)NANANoNoNANANANANA
240locationstateNovarchar(2)NANANoNoNANANANANA
241locationzipNovarchar(9)NAZip 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.NoNoNANANANANA
242locationcountyNovarchar(20)NANANoNoNANANANANA
243locationlocation_source_valueNovarchar(50)NAPut the verbatim value for the location here, as it shows up in the source.NoNoNANANANANA
244locationcountry_concept_idNointegerThe Concept Id representing the country. Values should conform to the [Geography](https://athena.ohdsi.org/search-terms/terms?domain=Geography&standardConcept=Standard&page=1&pageSize=15&query=&boosts) domain.NANoYesCONCEPTCONCEPT_IDNANANA
245locationcountry_source_valueNovarchar(80)The name of the country.NANoNoNANANANANA
246locationlatitudeNofloatNAMust be between -90 and 90.NoNoNANANANANA
247locationlongitudeNofloatNAMust be between -180 and 180.NoNoNANANANANA
248care_sitecare_site_idYesintegerNAAssign an ID to each combination of a location and nature of the site - the latter could be the Place of Service, name or another characteristic in your source data.YesNoNANANANANA
249care_sitecare_site_nameNovarchar(255)The name of the care_site as it appears in the source dataNANoNoNANANANANA
250care_siteplace_of_service_concept_idNointegerThis 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. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=2&pageSize=15&query=). For information about how to populate this field please see the [THEMIS Conventions](https://ohdsi.github.io/Themis/tag_place_of_service.html).NoYesCONCEPTCONCEPT_IDNANANA
251care_sitelocation_idNointegerThe location_id from the LOCATION table representing the physical location of the care_site.NANoYesLOCATIONLOCATION_IDNANANA
252care_sitecare_site_source_valueNovarchar(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.NANoNoNANANANANA
253care_siteplace_of_service_source_valueNovarchar(50)NAPut the place of service of the care_site as it appears in the source data.NoNoNANANANANA
254providerprovider_idYesintegerIt 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.YesNoNANANANANA
255providerprovider_nameNovarchar(255)This field contains information that describes a healthcare provider.This field is not required for identifying the Provider's actual identity. Instead, its purpose is to uniquely and/or anonymously identify providers of care across the database.NoNoNANANANANA
256providernpiNovarchar(20)This is the National Provider Number issued to health care providers in the US by the Centers for Medicare and Medicaid Services (CMS).NANoNoNANANANANA
257providerdeaNovarchar(20)This is the identifier issued by the DEA, a US federal agency, that allows a provider to write prescriptions for controlled substances.NANoNoNANANANANA
258providerspecialty_concept_idNointegerThis 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. [Accepted Concepts](http://athena.ohdsi.org/search-terms/terms?domain=Provider&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDNANANA
259providercare_site_idNointegerThis 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.NoYesCARE_SITECARE_SITE_IDNANANA
260provideryear_of_birthNointegerNANANoNoNANANANANA
261providergender_concept_idNointegerThis 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. [Accepted Concepts](http://athena.ohdsi.org/search-terms/terms?domain=Gender&standardConcept=Standard&page=1&pageSize=15&query=).NoYesCONCEPTCONCEPT_IDGenderNANA
262providerprovider_source_valueNovarchar(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.NoNoNANANANANA
263providerspecialty_source_valueNovarchar(50)This refers to the specific type of healthcare provider or field of expertise listed in the source data, encompassing physician specialties like internal medicine, emergency medicine, etc., as well as allied health professionals such as nurses, midwives, and pharmacists. It covers medical specialties like surgery, internal medicine, and radiology, while other services like prosthetics, acupuncture, and physical therapy fall under the domain of "Service."The type of provider and their specialty should be entered as they appear in the source data. The decision to use either the coded value or the text description is left to the discretion of the ETL-er.NoNoNANANANANA
264providerspecialty_source_concept_idNointegerThis is often zero as many sites use proprietary codes to store physician speciality.If the source data codes provider specialty in an OMOP supported vocabulary store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
265providergender_source_valueNovarchar(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.NoNoNANANANANA
266providergender_source_concept_idNointegerThis is often zero as many sites use proprietary codes to store provider gender.If the source data codes provider gender in an OMOP supported vocabulary store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
267payer_plan_periodpayer_plan_period_idYesintegerA unique identifier for each unique combination of a Person, Payer, Plan, and Period of time.NAYesNoNANANANANA
268payer_plan_periodperson_idYesintegerThe Person covered by the Plan.A single Person can have multiple, overlapping, PAYER_PLAN_PERIOD recordsNoYesPERSONPERSON_IDNANANA
269payer_plan_periodpayer_plan_period_start_dateYesdateStart date of Plan coverage.NANoNoNANANANANA
270payer_plan_periodpayer_plan_period_end_dateYesdateEnd date of Plan coverage.NANoNoNANANANANA
271payer_plan_periodpayer_concept_idNointegerThis field represents the organization who reimburses the provider which administers care to the Person.Map the payer directly to a standard CONCEPT_ID with the domain_id of 'Payer' ([Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Payer&standardConcept=Standard&page=1&pageSize=15&query=)). This vocabulary is not exhaustive so if there is a value missing, please see the [custom concepts](https://ohdsi.github.io/CommonDataModel/customConcepts.html) page.NoYesCONCEPTCONCEPT_IDNANANA
272payer_plan_periodpayer_source_valueNovarchar(50)This is the Payer as it appears in the source data.NANoNoNANANANANA
273payer_plan_periodpayer_source_concept_idNointegerNAIf the source data codes the Payer in an OMOP supported vocabulary store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
274payer_plan_periodplan_concept_idNointegerThis field represents the specific health benefit Plan the Person is enrolled in.Map the Plan directly to a standard CONCEPT_ID in the 'Plan' vocabulary ([Accepted Concepts](http://athena.ohdsi.org/search-terms/terms?domain=Plan&standardConcept=Standard&page=1&pageSize=15&query=)). This vocabulary is not exhaustive so if there is a value missing, please see the [custom concepts](https://ohdsi.github.io/CommonDataModel/customConcepts.html) page.NoYesCONCEPTCONCEPT_IDNANANA
275payer_plan_periodplan_source_valueNovarchar(50)This is the health benefit Plan of the Person as it appears in the source data.NANoNoNANANANANA
276payer_plan_periodplan_source_concept_idNointegerNAIf the source data codes the Plan in an OMOP supported vocabulary store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
277payer_plan_periodsponsor_concept_idNointegerThis 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 with the domain_id of 'Sponsor' ([Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Sponsor&standardConcept=Standard&page=1&pageSize=15&query=)). This vocabulary is not exhaustive so if there is a value missing, please see the [custom concepts](https://ohdsi.github.io/CommonDataModel/customConcepts.html) page.NoYesCONCEPTCONCEPT_IDNANANA
278payer_plan_periodsponsor_source_valueNovarchar(50)The Plan sponsor as it appears in the source data.NANoNoNANANANANA
279payer_plan_periodsponsor_source_concept_idNointegerNAIf the source data codes the sponsor in an OMOP supported vocabulary store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
280payer_plan_periodfamily_source_valueNovarchar(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.NoNoNANANANANA
281payer_plan_periodstop_reason_concept_idNointegerThis field represents the reason the Person left the Plan, if known.Map the stop reason directly to a standard CONCEPT_ID with a domain of 'Plan Stop Reason' ([Accepted Concepts](http://athena.ohdsi.org/search-terms/terms?domain=Plan+Stop+Reason&standardConcept=Standard&page=1&pageSize=15&query=)). If one does not exist visit the [Custom Concepts](https://ohdsi.github.io/CommonDataModel/customConcepts.html) pate for more information.NoYesCONCEPTCONCEPT_IDNANANA
282payer_plan_periodstop_reason_source_valueNovarchar(50)The Plan stop reason as it appears in the source data.NANoNoNANANANANA
283payer_plan_periodstop_reason_source_concept_idNointegerNAIf the source data codes the stop reason in an OMOP supported vocabulary store the concept_id here.NoYesCONCEPTCONCEPT_IDNANANA
284costcost_idYesintegerNANAYesNoNANANANANA
285costcost_event_idYesintegerNANANoNoNANANANANA
286costcost_domain_idYesvarchar(20)NANANoYesDOMAINDOMAIN_IDNANANA
287costcost_type_concept_idYesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
288costcurrency_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
289costtotal_chargeNofloatNANANoNoNANANANANA
290costtotal_costNofloatNANANoNoNANANANANA
291costtotal_paidNofloatNANANoNoNANANANANA
292costpaid_by_payerNofloatNANANoNoNANANANANA
293costpaid_by_patientNofloatNANANoNoNANANANANA
294costpaid_patient_copayNofloatNANANoNoNANANANANA
295costpaid_patient_coinsuranceNofloatNANANoNoNANANANANA
296costpaid_patient_deductibleNofloatNANANoNoNANANANANA
297costpaid_by_primaryNofloatNANANoNoNANANANANA
298costpaid_ingredient_costNofloatNANANoNoNANANANANA
299costpaid_dispensing_feeNofloatNANANoNoNANANANANA
300costpayer_plan_period_idNointegerNANANoNoNANANANANA
301costamount_allowedNofloatNANANoNoNANANANANA
302costrevenue_code_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
303costrevenue_code_source_valueNovarchar(50)Revenue codes are a method to charge for a class of procedures and conditions in the U.S. hospital system.NANoNoNANANANANA
304costdrg_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
305costdrg_source_valueNovarchar(3)Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups.NANoNoNANANANANA
306drug_eradrug_era_idYesintegerNANAYesNoNANANANANA
307drug_eraperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
308drug_eradrug_concept_idYesintegerThe drug_concept_id should conform to the concept class 'ingredient' as the drug_era is an era of time where a person is exposed to a particular drug ingredient.NANoYesCONCEPTCONCEPT_IDDrugIngredientNA
309drug_eradrug_era_start_dateYesdateNAThe Drug Era Start Date is the start date of the first Drug Exposure for a given ingredient, with at least 31 days since the previous exposure.NoNoNANANANANA
310drug_eradrug_era_end_dateYesdateNAThe 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.NoNoNANANANANA
311drug_eradrug_exposure_countNointegerThe count of grouped DRUG_EXPOSURE records that were included in the DRUG_ERA rowNANoNoNANANANANA
312drug_eragap_daysNointegerNAThe 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.NoNoNANANANANA
313dose_eradose_era_idYesintegerNANAYesNoNANANANANA
314dose_eraperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
315dose_eradrug_concept_idYesintegerThe Concept Id representing the specific drug ingredient.NANoYesCONCEPTCONCEPT_IDDrugIngredientNA
316dose_eraunit_concept_idYesintegerThe Concept Id representing the unit of the specific drug ingredient.NANoYesCONCEPTCONCEPT_IDUnitNANA
317dose_eradose_valueYesfloatThe numeric value of the dosage of the drug_ingredient.NANoNoNANANANANA
318dose_eradose_era_start_dateYesdateThe date the Person started on the specific dosage, with at least 31 days since any prior exposure.NANoNoNANANANANA
319dose_eradose_era_end_dateYesdateNAThe date the Person was no longer exposed to the dosage of the specific drug ingredient. An era is ended if there are 31 days or more between dosage records.NoNoNANANANANA
320condition_eracondition_era_idYesintegerNANAYesNoNANANANANA
321condition_eraperson_idYesintegerNANANoYesPERSONPERSON_IDNANANA
322condition_eracondition_concept_idYesintegerThe Concept Id representing the Condition.NANoYesCONCEPTCONCEPT_IDConditionNANA
323condition_eracondition_era_start_dateYesdateThe 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 with at least 31 days since any prior record of the same Condition.NANoNoNANANANANA
324condition_eracondition_era_end_dateYesdateThe 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.NANoNoNANANANANA
325condition_eracondition_occurrence_countNointegerThe number of individual Condition Occurrences used to construct the condition era.NANoNoNANANANANA
326episodeepisode_idYesintegerA unique identifier for each Episode.NAYesNoNANANANANA
327episodeperson_idYesintegerThe PERSON_ID of the PERSON for whom the episode is recorded.NANoYesPERSONPERSON_IDNANANA
328episodeepisode_concept_idYesintegerThe EPISODE_CONCEPT_ID represents the kind abstraction related to the disease phase, outcome or treatment.Choose a concept in the Episode domain that best represents the ongoing disease phase, outcome, or treatment. Please see [article] for cancers and [article] for non-cancers describing how these are defined. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Episode&page=1&pageSize=15&query=)NoYesCONCEPTCONCEPT_IDEpisodeNANA
329episodeepisode_start_dateYesdateThe date when the Episode beings.Please see [article] for how to define an Episode start date.NoNoNANANANANA
330episodeepisode_start_datetimeNodatetimeThe date and time when the Episode begins.NANoNoNANANANANA
331episodeepisode_end_dateNodateThe date when the instance of the Episode is considered to have ended.Please see [article] for how to define an Episode end date.NoNoNANANANANA
332episodeepisode_end_datetimeNodatetimeThe date when the instance of the Episode is considered to have ended.NANoNoNANANANANA
333episodeepisode_parent_idNointegerUse this field to find the Episode that subsumes the given Episode record. This is used in the case that an Episode are nested into each other.If there are multiple nested levels to how Episodes are represented, the EPISODE_PARENT_ID can be used to record this relationship.NoNoNANANANANA
334episodeepisode_numberNointegerFor sequences of episodes, this is used to indicate the order the episodes occurred. For example, lines of treatment could be indicated here.Please see [article] for the details of how to count episodes.NoNoNANANANANA
335episodeepisode_object_concept_idYesintegerA Standard Concept representing the disease phase, outcome, or other abstraction of which the episode consists. For example, if the EPISODE_CONCEPT_ID is [treatment regimen](https://athena.ohdsi.org/search-terms/terms/32531) then the EPISODE_OBJECT_CONCEPT_ID should contain the chemotherapy regimen concept, like [Afatinib monotherapy](https://athena.ohdsi.org/search-terms/terms/35804392).Episode entries from the 'Disease Episode' concept class should have an episode_object_concept_id that comes from the Condition domain. Episode entries from the 'Treatment Episode' concept class should have an episode_object_concept_id that scome from the 'Procedure' domain or 'Regimen' concept class.NoYesCONCEPTCONCEPT_IDProcedure, RegimenNANA
336episodeepisode_type_concept_idYesintegerThis field can be used to determine the provenance of the Episode record, as in whether the episode was from an EHR system, insurance claim, registry, or other sources.Choose the EPISODE_TYPE_CONCEPT_ID that best represents the provenance of the record. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). A more detailed explanation of each Type Concept can be found on the [vocabulary wiki](https://github.com/OHDSI/Vocabulary-v5.0/wiki/Vocab.-TYPE_CONCEPT).NoYesCONCEPTCONCEPT_IDType ConceptNANA
337episodeepisode_source_valueNovarchar(50)The source code for the Episode 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.NANoNoNANANANANA
338episodeepisode_source_concept_idNointegerA foreign key to a Episode Concept that refers to the code used in the source.Given that the Episodes are user-defined it is unlikely that there will be a Source Concept available. If that is the case then set this field to zero.NoYesCONCEPTCONCEPT_IDNANANA
339episode_eventepisode_idYesintegerUse this field to link the EPISODE_EVENT record to its EPISODE.Put the EPISODE_ID that subsumes the EPISODE_EVENT record here.NoYesEPISODEEPISODE_IDNANANA
340episode_eventevent_idYesintegerThis field is the primary key of the linked record in the database. For example, if the Episode Event is a Condition Occurrence, then the CONDITION_OCCURRENCE_ID of the linked record goes in this field.Put the primary key of the linked record here.NoNoNANANANANA
341episode_eventepisode_event_field_concept_idYesintegerThis field is the CONCEPT_ID that identifies which table the primary key of the linked record came from.Put the CONCEPT_ID that identifies which table and field the EVENT_ID came from. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?vocabulary=CDM&conceptClass=Field&page=1&pageSize=15&query=)NoYesCONCEPTCONCEPT_IDMetadataNANA
342metadatametadata_idYesintegerThe unique key given to a Metadata record.Attribute value is auto-generatedYesNoNANANANANA
343metadatametadata_concept_idYesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
344metadatametadata_type_concept_idYesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
345metadatanameYesvarchar(250)NANANoNoNANANANANA
346metadatavalue_as_stringNovarchar(250)NANANoNoNANANANANA
347metadatavalue_as_concept_idNointegerNANANoYesCONCEPTCONCEPT_IDNANANA
348metadatavalue_as_numberNofloatThis is the numerical value of the result of the Metadata, if applicable and available. It is not expected that all Metadata will have numeric results, rather, this field is here to house values should they exist.NANoNoNANANANANA
349metadatametadata_dateNodateNANANoNoNANANANANA
350metadatametadata_datetimeNodatetimeNANANoNoNANANANANA
351cdm_sourcecdm_source_nameYesvarchar(255)The name of the CDM instance.NANoNoNANANANANA
352cdm_sourcecdm_source_abbreviationYesvarchar(25)The abbreviation of the CDM instance.NANoNoNANANANANA
353cdm_sourcecdm_holderYesvarchar(255)The holder of the CDM instance.NANoNoNANANANANA
354cdm_sourcesource_descriptionNovarchar(MAX)The description of the CDM instance.NANoNoNANANANANA
355cdm_sourcesource_documentation_referenceNovarchar(255)NANANoNoNANANANANA
356cdm_sourcecdm_etl_referenceNovarchar(255)NAVersion of the ETL script used. e.g. link to the Git releaseNoNoNANANANANA
357cdm_sourcesource_release_dateYesdateThe date the data was extracted from the source system. In some systems that is the same as the date the ETL was run. Typically the latest even date in the source is on the source_release_date.NANoNoNANANANANA
358cdm_sourcecdm_release_dateYesdateThe date the ETL script was completed. Typically this is after the source_release_date.NANoNoNANANANANA
359cdm_sourcecdm_versionNovarchar(10)Version of the OMOP CDM used as string. e.g. v5.4NANoNoNANANANANA
360cdm_sourcecdm_version_concept_idYesintegerThe Concept Id representing the version of the CDM.You can find all concepts that represent the CDM versions using the query: `SELECT * FROM CONCEPT WHERE VOCABULARY_ID = 'CDM' AND CONCEPT_CLASS = 'CDM'`NoYesCONCEPTCONCEPT_IDNANANA
361cdm_sourcevocabulary_versionYesvarchar(20)Version of the OMOP standardised vocabularies loadedYou can find the version of your Vocabulary using the query: `SELECT vocabulary_version from vocabulary where vocabulary_id = 'None'`NoNoNANANANANA
362conceptconcept_idYesintegerA unique identifier for each Concept across all domains.NAYesNoNANANANANA
363conceptconcept_nameYesvarchar(255)An unambiguous, meaningful and descriptive name for the Concept.NANoNoNANANANANA
364conceptdomain_idYesvarchar(20)A foreign key to the [DOMAIN](https://ohdsi.github.io/CommonDataModel/cdm531.html#domain) table the Concept belongs to.NANoYesDOMAINDOMAIN_IDNANANA
365conceptvocabulary_idYesvarchar(20)A foreign key to the [VOCABULARY](https://ohdsi.github.io/CommonDataModel/cdm531.html#vocabulary) table indicating from which source the Concept has been adapted.NANoYesVOCABULARYVOCABULARY_IDNANANA
366conceptconcept_class_idYesvarchar(20)The attribute or concept class of the Concept. Examples are 'Clinical Drug', 'Ingredient', 'Clinical Finding' etc.NANoYesCONCEPT_CLASSCONCEPT_CLASS_IDNANANA
367conceptstandard_conceptNovarchar(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 allowable values are 'S' (Standard Concept) and 'C' (Classification Concept), otherwise the content is NULL.NANoNoNANANANANA
368conceptconcept_codeYesvarchar(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.NANoNoNANANANANA
369conceptvalid_start_dateYesdateThe date when the Concept was first recorded. The default value is 1-Jan-1970, meaning, the Concept has no (known) date of inception.NANoNoNANANANANA
370conceptvalid_end_dateYesdateThe 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.NANoNoNANANANANA
371conceptinvalid_reasonNovarchar(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.NANoNoNANANANANA
372vocabularyvocabulary_idYesvarchar(20)A unique identifier for each Vocabulary, such as ICD9CM, SNOMED, Visit.NAYesNoNANANANANA
373vocabularyvocabulary_nameYesvarchar(255)The name describing the vocabulary, for example, International Classification of Diseases, Ninth Revision, Clinical Modification, Volume 1 and 2 (NCHS) etc.NANoNoNANANANANA
374vocabularyvocabulary_referenceNovarchar(255)External reference to documentation or available download of the about the vocabulary.NANoNoNANANANANA
375vocabularyvocabulary_versionNovarchar(255)Version of the Vocabulary as indicated in the source.NANoNoNANANANANA
376vocabularyvocabulary_concept_idYesintegerA Concept that represents the Vocabulary the VOCABULARY record belongs to.NANoYesCONCEPTCONCEPT_IDNANANA
377domaindomain_idYesvarchar(20)A unique key for each domain.NAYesNoNANANANANA
378domaindomain_nameYesvarchar(255)The name describing the Domain, e.g. Condition, Procedure, Measurement etc.NANoNoNANANANANA
379domaindomain_concept_idYesintegerA Concept representing the Domain Concept the DOMAIN record belongs to.NANoYesCONCEPTCONCEPT_IDNANANA
380concept_classconcept_class_idYesvarchar(20)A unique key for each class.NAYesNoNANANANANA
381concept_classconcept_class_nameYesvarchar(255)The name describing the Concept Class, e.g. Clinical Finding, Ingredient, etc.NANoNoNANANANANA
382concept_classconcept_class_concept_idYesintegerA Concept that represents the Concept Class.NANoYesCONCEPTCONCEPT_IDNANANA
383concept_relationshipconcept_id_1YesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
384concept_relationshipconcept_id_2YesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
385concept_relationshiprelationship_idYesvarchar(20)The relationship between CONCEPT_ID_1 and CONCEPT_ID_2. Please see the [Vocabulary Conventions](https://ohdsi.github.io/CommonDataModel/dataModelConventions.html#concept_relationships). for more information.NANoYesRELATIONSHIPRELATIONSHIP_IDNANANA
386concept_relationshipvalid_start_dateYesdateThe date when the relationship is first recorded.NANoNoNANANANANA
387concept_relationshipvalid_end_dateYesdateThe date when the relationship is invalidated.NANoNoNANANANANA
388concept_relationshipinvalid_reasonNovarchar(1)Reason the relationship was invalidated. Possible values are 'D' (deleted), 'U' (updated) or NULL.NANoNoNANANANANA
389relationshiprelationship_idYesvarchar(20)The type of relationship captured by the relationship record.NAYesNoNANANANANA
390relationshiprelationship_nameYesvarchar(255)NANANoNoNANANANANA
391relationshipis_hierarchicalYesvarchar(1)Defines whether a relationship defines concepts into classes or hierarchies. Values are 1 for hierarchical relationship or 0 if not.NANoNoNANANANANA
392relationshipdefines_ancestryYesvarchar(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.NANoNoNANANANANA
393relationshipreverse_relationship_idYesvarchar(20)The identifier for the relationship used to define the reverse relationship between two concepts.NANoNoNANANANANA
394relationshiprelationship_concept_idYesintegerA foreign key that refers to an identifier in the [CONCEPT](https://ohdsi.github.io/CommonDataModel/cdm531.html#concept) table for the unique relationship concept.NANoYesCONCEPTCONCEPT_IDNANANA
395concept_synonymconcept_idYesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
396concept_synonymconcept_synonym_nameYesvarchar(1000)NANANoNoNANANANANA
397concept_synonymlanguage_concept_idYesintegerNANANoYesCONCEPTCONCEPT_IDNANANA
398concept_ancestorancestor_concept_idYesintegerThe Concept Id for the higher-level concept that forms the ancestor in the relationship.NANoYesCONCEPTCONCEPT_IDNANANA
399concept_ancestordescendant_concept_idYesintegerThe Concept Id for the lower-level concept that forms the descendant in the relationship.NANoYesCONCEPTCONCEPT_IDNANANA
400concept_ancestormin_levels_of_separationYesintegerThe minimum separation in number of levels of hierarchy between ancestor and descendant concepts. This is an attribute that is used to simplify hierarchic analysis.NANoNoNANANANANA
401concept_ancestormax_levels_of_separationYesintegerThe maximum separation in number of levels of hierarchy between ancestor and descendant concepts. This is an attribute that is used to simplify hierarchic analysis.NANoNoNANANANANA
402source_to_concept_mapsource_codeYesvarchar(50)The source code being translated into a Standard Concept.NANoNoNANANANANA
403source_to_concept_mapsource_concept_idYesintegerA foreign key to the Source Concept that is being translated into a Standard Concept.This is either 0 or should be a number above 2 billion, which are the Concepts reserved for site-specific codes and mappings.NoYesCONCEPTCONCEPT_IDNANANA
404source_to_concept_mapsource_vocabulary_idYesvarchar(20)A foreign key to the VOCABULARY table defining the vocabulary of the source code that is being translated to a Standard Concept.NANoNoNANANANANA
405source_to_concept_mapsource_code_descriptionNovarchar(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.NANoNoNANANANANA
406source_to_concept_maptarget_concept_idYesintegerThe target Concept to which the source code is being mapped.NANoYesCONCEPTCONCEPT_IDNANANA
407source_to_concept_maptarget_vocabulary_idYesvarchar(20)The Vocabulary of the target Concept.NANoYesVOCABULARYVOCABULARY_IDNANANA
408source_to_concept_mapvalid_start_dateYesdateThe date when the mapping instance was first recorded.NANoNoNANANANANA
409source_to_concept_mapvalid_end_dateYesdateThe date when the mapping instance became invalid because it was deleted or superseded (updated) by a new relationship. Default value is 31-Dec-2099.NANoNoNANANANANA
410source_to_concept_mapinvalid_reasonNovarchar(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.NANoNoNANANANANA
411drug_strengthdrug_concept_idYesintegerThe Concept representing the Branded Drug or Clinical Drug Product.NANoYesCONCEPTCONCEPT_IDNANANA
412drug_strengthingredient_concept_idYesintegerThe Concept representing the active ingredient contained within the drug product.Combination Drugs will have more than one record in this table, one for each active Ingredient.NoYesCONCEPTCONCEPT_IDNANANA
413drug_strengthamount_valueNofloatThe numeric value or the amount of active ingredient contained within the drug product.NANoNoNANANANANA
414drug_strengthamount_unit_concept_idNointegerThe Concept representing the Unit of measure for the amount of active ingredient contained within the drug product.NANoYesCONCEPTCONCEPT_IDNANANA
415drug_strengthnumerator_valueNofloatThe concentration of the active ingredient contained within the drug product.NANoNoNANANANANA
416drug_strengthnumerator_unit_concept_idNointegerThe Concept representing the Unit of measure for the concentration of active ingredient.NANoYesCONCEPTCONCEPT_IDNANANA
417drug_strengthdenominator_valueNofloatThe amount of total liquid (or other divisible product, such as ointment, gel, spray, etc.).NANoNoNANANANANA
418drug_strengthdenominator_unit_concept_idNointegerThe Concept representing the denominator unit for the concentration of active ingredient.NANoYesCONCEPTCONCEPT_IDNANANA
419drug_strengthbox_sizeNointegerThe number of units of Clinical Branded Drug or Quantified Clinical or Branded Drug contained in a box as dispensed to the patient.NANoNoNANANANANA
420drug_strengthvalid_start_dateYesdateThe date when the Concept was first recorded. The default value is 1-Jan-1970.NANoNoNANANANANA
421drug_strengthvalid_end_dateYesdateThe date when then Concept became invalid.NANoNoNANANANANA
422drug_strengthinvalid_reasonNovarchar(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.NANoNoNANANANANA
423cohortcohort_definition_idYesintegerNANANoNoNANANANANA
424cohortsubject_idYesintegerNANANoNoNANANANANA
425cohortcohort_start_dateYesdateNANANoNoNANANANANA
426cohortcohort_end_dateYesdateNANANoNoNANANANANA
427cohort_definitioncohort_definition_idYesintegerThis is the identifier given to the cohort, usually by the ATLAS applicationNANoNoNANANANANA
428cohort_definitioncohort_definition_nameYesvarchar(255)A short description of the cohortNANoNoNANANANANA
429cohort_definitioncohort_definition_descriptionNovarchar(MAX)A complete description of the cohort.NANoNoNANANANANA
430cohort_definitiondefinition_type_concept_idYesintegerType defining what kind of Cohort Definition the record represents and how the syntax may be executed.NANoYesCONCEPTCONCEPT_IDNANANA
431cohort_definitioncohort_definition_syntaxNovarchar(MAX)Syntax or code to operationalize the Cohort Definition.NANoNoNANANANANA
432cohort_definitionsubject_concept_idYesintegerThis field contains a Concept that represents the domain of the subjects that are members of the cohort (e.g., Person, Provider, Visit).NANoYesCONCEPTCONCEPT_IDNANANA
433cohort_definitioncohort_initiation_dateNodateA date to indicate when the Cohort was initiated in the COHORT table.NANoNoNANANANANA