mz-health/OMOP
mz-health
/
OMOP
mirror of https://github.com/OHDSI/CommonDataModel.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update OMOP_CDMv5.4_Field_Level.csv 

Addresses #386
This commit is contained in:
Lisa Schilling 2021-08-18 10:07:58 -06:00 committed by GitHub
parent 0f1d9333dd
commit 26018caea2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 121 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

242
inst/csv/OMOP_CDMv5.4_Field_Level.csv
View File

@ -27,12 +27,12 @@ VISIT_OCCURRENCE,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,,,
VISIT_OCCURRENCE,visit_concept_id,Yes,integer,"This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain.","Populate this field based on the kind of visit that took place for the person. For example this could be ""Inpatient Visit"", ""Outpatient Visit"", ""Ambulatory Visit"", etc. This table will contain standard concepts in the Visit domain. These concepts are arranged in a hierarchical structure to facilitate cohort definitions by rolling up to generally familiar Visits adopted in most healthcare systems worldwide. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).",No,Yes,CONCEPT,CONCEPT_ID,Visit,,
VISIT_OCCURRENCE,visit_start_date,Yes,date,"For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same.","When populating VISIT_START_DATE, you should think about the patient experience to make decisions on how to define visits. In the case of an inpatient visit this should be the date the patient was admitted to the hospital or institution. In all other cases this should be the date of the patient-provider interaction.",No,No,,,,,
VISIT_OCCURRENCE,visit_start_datetime,No,datetime,,"If no time is given for the start date of a visit, set it to midnight (00:00:0000).",No,No,,,,,
VISIT_OCCURRENCE,visit_end_date,Yes,date,For inpatient visits the end date is typically the discharge date.,"Visit end dates are mandatory. If end dates are not provided in the source there are three ways in which to derive them:
- Outpatient Visit: visit_end_datetime = visit_start_datetime
- Emergency Room Visit: visit_end_datetime = visit_start_datetime
- Inpatient Visit: Usually there is information about discharge. If not, you should be able to derive the end date from the sudden decline of activity or from the absence of inpatient procedures/drugs.
- Non-hospital institution Visits: Particularly for claims data, if end dates are not provided assume the visit is for the duration of month that it occurs.
For Inpatient Visits ongoing at the date of ETL, put date of processing the data into visit_end_datetime and visit_type_concept_id with 32220 ""Still patient"" to identify the visit as incomplete.
VISIT_OCCURRENCE,visit_end_date,Yes,date,For inpatient visits the end date is typically the discharge date.,"Visit end dates are mandatory. If end dates are not provided in the source there are three ways in which to derive them:
- Outpatient Visit: visit_end_datetime = visit_start_datetime
- Emergency Room Visit: visit_end_datetime = visit_start_datetime
- Inpatient Visit: Usually there is information about discharge. If not, you should be able to derive the end date from the sudden decline of activity or from the absence of inpatient procedures/drugs.
- Non-hospital institution Visits: Particularly for claims data, if end dates are not provided assume the visit is for the duration of month that it occurs.
For Inpatient Visits ongoing at the date of ETL, put date of processing the data into visit_end_datetime and visit_type_concept_id with 32220 ""Still patient"" to identify the visit as incomplete.
- All other Visits: visit_end_datetime = visit_start_datetime. If this is a one-day visit the end date should match the start date.",No,No,,,,,
VISIT_OCCURRENCE,visit_end_datetime,No,datetime,,"If no time is given for the end date of a visit, set it to midnight (00:00:0000).",No,No,,,,,
VISIT_OCCURRENCE,visit_type_concept_id,Yes,Integer,"Use this field to understand the provenance of the visit record, or where the record comes from.","Populate this field based on the provenance of the visit record, as in whether it came from an EHR record or billing claim. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=).",No,Yes,CONCEPT,CONCEPT_ID,Type Concept,,
@ -50,12 +50,12 @@ VISIT_DETAIL,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,,,
VISIT_DETAIL,visit_detail_concept_id,Yes,integer,"This 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=).",No,Yes,CONCEPT,CONCEPT_ID,Visit,,
VISIT_DETAIL,visit_detail_start_date,Yes,date,This 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.",No,No,,,,,
VISIT_DETAIL,visit_detail_start_datetime,No,datetime,,"If no time is given for the start date of a visit, set it to midnight (00:00:0000).",No,No,,,,,
VISIT_DETAIL,visit_detail_end_date,Yes,date,This the end date of the patient-provider interaction.,"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.
VISIT_DETAIL,visit_detail_end_date,Yes,date,This the end date of the patient-provider interaction.,"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. ",No,No,,,,,
VISIT_DETAIL,visit_detail_end_datetime,No,datetime,,"If no time is given for the end date of a visit, set it to midnight (00:00:0000).",No,No,,,,,
VISIT_DETAIL,visit_detail_type_concept_id,Yes,integer,"Use 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=).",No,Yes,CONCEPT,CONCEPT_ID,Type Concept,,
@ -63,8 +63,8 @@ VISIT_DETAIL,provider_id,No,integer,"There will only be one provider per **visi
VISIT_DETAIL,care_site_id,No,integer,This 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.,No,Yes,CARE_SITE,CARE_SITE_ID,,,
VISIT_DETAIL,visit_detail_source_value,No,varchar(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.",No,No,,,,,
VISIT_DETAIL,visit_detail_source_concept_id,No,Integer,,If 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.,No,Yes,CONCEPT,CONCEPT_ID,,,
VISIT_DETAIL,admitting_source_value,No,Varchar(50),,"This information may be called something different in the source data but the field is meant to contain a value indicating where a person was admitted from. Typically this applies only to visits that have a length of stay, like inpatient visits or long-term care visits.",No,No,,,,,
VISIT_DETAIL,admitting_source_concept_id,No,Integer,"Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.","If available, map the admitted_from_source_value to a standard concept in the visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).",No,Yes,CONCEPT,CONCEPT_ID,Visit,,
VISIT_DETAIL,admitted_from_value,No,Varchar(50),,"This information may be called something different in the source data but the field is meant to contain a value indicating where a person was admitted from. Typically this applies only to visits that have a length of stay, like inpatient visits or long-term care visits.",No,No,,,,,
VISIT_DETAIL,admitted_from_concept_id,No,Integer,"Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example.","If available, map the admitted_from_source_value to a standard concept in the visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).",No,Yes,CONCEPT,CONCEPT_ID,Visit,,
VISIT_DETAIL,discharge_to_source_value,No,Varchar(50),,"This information may be called something different in the source data but the field is meant to contain a value indicating where a person was discharged to after a visit, as in they went home or were moved to long-term care. Typically this applies only to visits that have a length of stay of a day or more.",No,No,,,,,
VISIT_DETAIL,discharge_to_concept_id,No,integer,"Use this field to determine where the patient was discharged to after a visit detail record. This concept is part of the visit domain and can indicate if a patient was discharged to home or sent to a long-term care facility, for example.","If available, map the DISCHARGE_TO_SOURCE_VALUE to a Standard Concept in the Visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=).",No,Yes,CONCEPT,CONCEPT_ID,Visit,,
VISIT_DETAIL,preceding_visit_detail_id,No,integer,Use 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"".",No,Yes,VISIT_DETAIL,VISIT_DETAIL_ID,,,
@ -97,8 +97,8 @@ DRUG_EXPOSURE,verbatim_end_date,No,date,"This is the end date of the drug exposu
DRUG_EXPOSURE,drug_type_concept_id,Yes,integer,"You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, 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=).",No,Yes,CONCEPT,CONCEPT_ID,Type Concept,,
DRUG_EXPOSURE,stop_reason,No,varchar(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.,No,No,,,,,
DRUG_EXPOSURE,refills,No,integer,This 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.,,No,No,,,,,
DRUG_EXPOSURE,quantity,No,float,,"To 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.
DRUG_EXPOSURE,quantity,No,float,,"To 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.
",No,No,,,,,
DRUG_EXPOSURE,days_supply,No,integer,,Days supply of the drug. This should be the verbatim days_supply as given on the prescription. If the drug is physician administered use duration end date if given or set to 1 as default if duration is not available.,No,No,,,,,
DRUG_EXPOSURE,sig,No,varchar(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.",No,No,,,,,
@ -196,7 +196,7 @@ NOTE,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,,,
NOTE,note_date,Yes,date,The date the note was recorded.,,No,No,,,,,
NOTE,note_datetime,No,datetime,,If time is not given set the time to midnight.,No,No,,,,,
NOTE,note_type_concept_id,Yes,integer,The 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=).",No,Yes,CONCEPT,CONCEPT_ID,Type Concept,,
NOTE,note_class_concept_id,Yes,integer,"A Standard Concept Id representing the HL7 LOINC
NOTE,note_class_concept_id,Yes,integer,"A 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).,No,Yes,CONCEPT,CONCEPT_ID,,,
NOTE,note_title,No,varchar(250),The title of the note.,,No,No,,,,,
NOTE,note_text,Yes,varchar(MAX),The content of the note.,,No,No,,,,,
@ -217,22 +217,22 @@ NOTE_NLP,note_nlp_source_concept_id,No,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
NOTE_NLP,nlp_system,No,varchar(250),,Name and version of the NLP system that extracted the term. Useful for data provenance.,No,No,,,,,
NOTE_NLP,nlp_date,Yes,date,The date of the note processing.,,No,No,,,,,
NOTE_NLP,nlp_datetime,No,datetime,The date and time of the note processing.,,No,No,,,,,
NOTE_NLP,term_exists,No,varchar(1),,"Term_exists is defined as a flag that indicates if the patient actually has or had the condition. Any of the following modifiers would make Term_exists false:
Negation = true
Subject = [anything other than the patient]
Conditional = true/li>
Rule_out = true
Uncertain = very low certainty or any lower certainties
A complete lack of modifiers would make Term_exists true.
NOTE_NLP,term_exists,No,varchar(1),,"Term_exists is defined as a flag that indicates if the patient actually has or had the condition. Any of the following modifiers would make Term_exists false:
Negation = true
Subject = [anything other than the patient]
Conditional = true/li>
Rule_out = true
Uncertain = very low certainty or any lower certainties
A complete lack of modifiers would make Term_exists true.
",No,No,,,,,
NOTE_NLP,term_temporal,No,varchar(50),,"Term_temporal is to indicate if a condition is present or just in the past. The following would be past:<br><br>
- History = true
NOTE_NLP,term_temporal,No,varchar(50),,"Term_temporal is to indicate if a condition is present or just in the past. The following would be past:<br><br>
- History = true
- Concept_date = anything before the time of the report",No,No,,,,,
NOTE_NLP,term_modifiers,No,varchar(2000),,"For the modifiers that are there, they would have to have these values:<br><br>
- Negation = false
- Subject = patient
- Conditional = false
- Rule_out = false
NOTE_NLP,term_modifiers,No,varchar(2000),,"For 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. ",No,No,,,,,
SPECIMEN,specimen_id,Yes,integer,Unique identifier for each specimen.,,Yes,No,,,,,
SPECIMEN,person_id,Yes,integer,The person from whom the specimen is collected.,,No,Yes,PERSON,PERSON_ID,,,
@ -328,9 +328,9 @@ DRUG_ERA,drug_era_id,Yes,integer,,,Yes,No,,,,,
DRUG_ERA,person_id,Yes,integer,,,No,Yes,PERSON,PERSON_ID,,,
DRUG_ERA,drug_concept_id,Yes,integer,The Concept Id representing the specific drug ingredient.,,No,Yes,CONCEPT,CONCEPT_ID,Drug,Ingredient,
DRUG_ERA,drug_era_start_date,Yes,datetime,,"The Drug Era Start Date is the start date of the first Drug Exposure for a given ingredient, with at least 31 days since the previous exposure. ",No,No,,,,,
DRUG_ERA,drug_era_end_date,Yes,datetime,,"The Drug Era End Date is the end date of the last Drug Exposure. The End Date of each Drug Exposure is either taken from the field drug_exposure_end_date or, as it is typically not available, inferred using the following rules:
For pharmacy prescription data, the date when the drug was dispensed plus the number of days of supply are used to extrapolate the End Date for the Drug Exposure. Depending on the country-specific healthcare system, this supply information is either explicitly provided in the day_supply field or inferred from package size or similar information.
For Procedure Drugs, usually the drug is administered on a single date (i.e., the administration date).
DRUG_ERA,drug_era_end_date,Yes,datetime,,"The Drug Era End Date is the end date of the last Drug Exposure. The End Date of each Drug Exposure is either taken from the field drug_exposure_end_date or, as it is typically not available, inferred using the following rules:
For pharmacy prescription data, the date when the drug was dispensed plus the number of days of supply are used to extrapolate the End Date for the Drug Exposure. Depending on the country-specific healthcare system, this supply information is either explicitly provided in the day_supply field or inferred from package size or similar information.
For Procedure Drugs, usually the drug is administered on a single date (i.e., the administration date).
A standard Persistence Window of 30 days (gap, slack) is permitted between two subsequent such extrapolated DRUG_EXPOSURE records to be considered to be merged into a single Drug Era.",No,No,,,,,
DRUG_ERA,drug_exposure_count,No,integer,,,No,No,,,,,
DRUG_ERA,gap_days,No,integer,,"The Gap Days determine how many total drug-free days are observed between all Drug Exposure events that contribute to a DRUG_ERA record. It is assumed that the drugs are ""not stockpiled"" by the patient, i.e. that if a new drug prescription or refill is observed (a new DRUG_EXPOSURE record is written), the remaining supply from the previous events is abandoned. The difference between Persistence Window and Gap Days is that the former is the maximum drug-free time allowed between two subsequent DRUG_EXPOSURE records, while the latter is the sum of actual drug-free days for the given Drug Era under the above assumption of non-stockpiling.",No,No,,,,,
@ -344,20 +344,20 @@ DOSE_ERA,dose_era_end_date,Yes,datetime,,The date the Person was no longer expos
CONDITION_ERA,condition_era_id,Yes,integer,,,Yes,No,,,,,
CONDITION_ERA,person_id,Yes,integer,,,No,No,PERSON,PERSON_ID,,,
CONDITION_ERA,condition_concept_id,Yes,integer,The Concept Id representing the Condition.,,No,Yes,CONCEPT,CONCEPT_ID,Condition,,
CONDITION_ERA,condition_era_start_date,Yes,datetime,"The start date for the Condition Era
constructed from the individual
instances of Condition Occurrences.
It is the start date of the very first
chronologically recorded instance of
CONDITION_ERA,condition_era_start_date,Yes,datetime,"The start date for the Condition Era
constructed from the individual
instances of Condition Occurrences.
It is the start date of the very first
chronologically recorded instance of
the condition with at least 31 days since any prior record of the same Condition. ",,No,No,,,,,
CONDITION_ERA,condition_era_end_date,Yes,datetime,"The end date for the Condition Era
constructed from the individual
instances of Condition Occurrences.
It is the end date of the final
continuously recorded instance of the
CONDITION_ERA,condition_era_end_date,Yes,datetime,"The end date for the Condition Era
constructed from the individual
instances of Condition Occurrences.
It is the end date of the final
continuously recorded instance of the
Condition.",,No,No,,,,,
CONDITION_ERA,condition_occurrence_count,No,integer,"The number of individual Condition
Occurrences used to construct the
CONDITION_ERA,condition_occurrence_count,No,integer,"The number of individual Condition
Occurrences used to construct the
condition era.",,No,No,,,,,
METADATA,metadata_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
METADATA,metadata_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
@ -380,57 +380,57 @@ CDM_SOURCE,vocabulary_version,Yes,varchar(20),,,No,No,,,,,
CONCEPT,concept_id,Yes,integer,A unique identifier for each Concept across all domains.,,Yes,No,,,,,
CONCEPT,concept_name,Yes,varchar(255),"An unambiguous, meaningful and descriptive name for the Concept.",,No,No,,,,,
CONCEPT,domain_id,Yes,varchar(20),A foreign key to the [DOMAIN](https://ohdsi.github.io/CommonDataModel/cdm531.html#domain) table the Concept belongs to.,,No,Yes,DOMAIN,DOMAIN_ID,,,
CONCEPT,vocabulary_id,Yes,varchar(20),"A foreign key to the [VOCABULARY](https://ohdsi.github.io/CommonDataModel/cdm531.html#vocabulary)
table indicating from which source the
CONCEPT,vocabulary_id,Yes,varchar(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.",,No,Yes,VOCABULARY,VOCABULARY_ID,,,
CONCEPT,concept_class_id,Yes,varchar(20),"The attribute or concept class of the
Concept. Examples are 'Clinical Drug',
CONCEPT,concept_class_id,Yes,varchar(20),"The attribute or concept class of the
Concept. Examples are 'Clinical Drug',
'Ingredient', 'Clinical Finding' etc.",,No,Yes,CONCEPT_CLASS,CONCEPT_CLASS_ID,,,
CONCEPT,standard_concept,No,varchar(1),"This flag determines where a Concept is
a Standard Concept, i.e. is used in the
data, a Classification Concept, or a
non-standard Source Concept. The
allowable values are 'S' (Standard
Concept) and 'C' (Classification
CONCEPT,standard_concept,No,varchar(1),"This flag determines where a Concept is
a Standard Concept, i.e. is used in the
data, a Classification Concept, or a
non-standard Source Concept. The
allowable values are 'S' (Standard
Concept) and 'C' (Classification
Concept), otherwise the content is NULL.",,No,No,,,,,
CONCEPT,concept_code,Yes,varchar(50),"The concept code represents the identifier
of the Concept in the source vocabulary,
such as SNOMED-CT concept IDs,
RxNorm RXCUIs etc. Note that concept
CONCEPT,concept_code,Yes,varchar(50),"The concept code represents the identifier
of the Concept in the source vocabulary,
such as SNOMED-CT concept IDs,
RxNorm RXCUIs etc. Note that concept
codes are not unique across vocabularies.",,No,No,,,,,
CONCEPT,valid_start_date,Yes,date,"The date when the Concept was first
recorded. The default value is
1-Jan-1970, meaning, the Concept has no
CONCEPT,valid_start_date,Yes,date,"The date when the Concept was first
recorded. The default value is
1-Jan-1970, meaning, the Concept has no
(known) date of inception.",,No,No,,,,,
CONCEPT,valid_end_date,Yes,date,"The date when the Concept became
invalid because it was deleted or
superseded (updated) by a new concept.
The default value is 31-Dec-2099,
meaning, the Concept is valid until it
CONCEPT,valid_end_date,Yes,date,"The date when the Concept became
invalid because it was deleted or
superseded (updated) by a new concept.
The default value is 31-Dec-2099,
meaning, the Concept is valid until it
becomes deprecated.",,No,No,,,,,
CONCEPT,invalid_reason,No,varchar(1),"Reason the Concept was invalidated.
Possible values are D (deleted), U
(replaced with an update) or NULL when
CONCEPT,invalid_reason,No,varchar(1),"Reason the Concept was invalidated.
Possible values are D (deleted), U
(replaced with an update) or NULL when
valid_end_date has the default value.",,No,No,,,,,
VOCABULARY,vocabulary_id,Yes,varchar(20),"A unique identifier for each Vocabulary, such
VOCABULARY,vocabulary_id,Yes,varchar(20),"A unique identifier for each Vocabulary, such
as ICD9CM, SNOMED, Visit.",,Yes,No,,,,,
VOCABULARY,vocabulary_name,Yes,varchar(255),"The name describing the vocabulary, for
example, International Classification of
Diseases, Ninth Revision, Clinical
VOCABULARY,vocabulary_name,Yes,varchar(255),"The name describing the vocabulary, for
example, International Classification of
Diseases, Ninth Revision, Clinical
Modification, Volume 1 and 2 (NCHS) etc.",,No,No,,,,,
VOCABULARY,vocabulary_reference,Yes,varchar(255),"External reference to documentation or
available download of the about the
VOCABULARY,vocabulary_reference,Yes,varchar(255),"External reference to documentation or
available download of the about the
vocabulary.",,No,No,,,,,
VOCABULARY,vocabulary_version,No,varchar(255),"Version of the Vocabulary as indicated in
VOCABULARY,vocabulary_version,No,varchar(255),"Version of the Vocabulary as indicated in
the source.",,No,No,,,,,
VOCABULARY,vocabulary_concept_id,Yes,integer,A Concept that represents the Vocabulary the VOCABULARY record belongs to.,,No,Yes,CONCEPT,CONCEPT_ID,,,
DOMAIN,domain_id,Yes,varchar(20),A unique key for each domain.,,Yes,No,,,,,
DOMAIN,domain_name,Yes,varchar(255),"The name describing the Domain, e.g.
Condition, Procedure, Measurement
DOMAIN,domain_name,Yes,varchar(255),"The name describing the Domain, e.g.
Condition, Procedure, Measurement
etc.",,No,No,,,,,
DOMAIN,domain_concept_id,Yes,integer,A Concept representing the Domain Concept the DOMAIN record belongs to.,,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_CLASS,concept_class_id,Yes,varchar(20),A unique key for each class.,,Yes,No,,,,,
CONCEPT_CLASS,concept_class_name,Yes,varchar(255),"The name describing the Concept Class, e.g.
CONCEPT_CLASS,concept_class_name,Yes,varchar(255),"The name describing the Concept Class, e.g.
Clinical Finding, Ingredient, etc.",,No,No,,,,,
CONCEPT_CLASS,concept_class_concept_id,Yes,integer,A Concept that represents the Concept Class.,,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_RELATIONSHIP,concept_id_1,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
@ -439,63 +439,63 @@ CONCEPT_RELATIONSHIP,relationship_id,Yes,varchar(20),The relationship between CO
CONCEPT_RELATIONSHIP,valid_start_date,Yes,date,The date when the relationship is first recorded.,,No,No,,,,,
CONCEPT_RELATIONSHIP,valid_end_date,Yes,date,The date when the relationship is invalidated.,,No,No,,,,,
CONCEPT_RELATIONSHIP,invalid_reason,No,varchar(1),"Reason the relationship was invalidated. Possible values are 'D' (deleted), 'U' (updated) or NULL. ",,No,No,,,,,
RELATIONSHIP,relationship_id,Yes,varchar(20),"The type of relationship captured by the
RELATIONSHIP,relationship_id,Yes,varchar(20),"The type of relationship captured by the
relationship record.",,Yes,No,,,,,
RELATIONSHIP,relationship_name,Yes,varchar(255),,,No,No,,,,,
RELATIONSHIP,is_hierarchical,Yes,varchar(1),"Defines whether a relationship defines
concepts into classes or hierarchies. Values
RELATIONSHIP,is_hierarchical,Yes,varchar(1),"Defines whether a relationship defines
concepts into classes or hierarchies. Values
are 1 for hierarchical relationship or 0 if not.",,No,No,,,,,
RELATIONSHIP,defines_ancestry,Yes,varchar(1),"Defines whether a hierarchical relationship
contributes to the concept_ancestor table.
These are subsets of the hierarchical
RELATIONSHIP,defines_ancestry,Yes,varchar(1),"Defines whether a hierarchical relationship
contributes to the concept_ancestor table.
These are subsets of the hierarchical
relationships. Valid values are 1 or 0.",,No,No,,,,,
RELATIONSHIP,reverse_relationship_id,Yes,varchar(20),"The identifier for the relationship used to
define the reverse relationship between two
RELATIONSHIP,reverse_relationship_id,Yes,varchar(20),"The identifier for the relationship used to
define the reverse relationship between two
concepts.",,No,No,,,,,
RELATIONSHIP,relationship_concept_id,Yes,integer,"A foreign key that refers to an identifier in
the [CONCEPT](https://ohdsi.github.io/CommonDataModel/cdm531.html#concept) table for the unique
RELATIONSHIP,relationship_concept_id,Yes,integer,"A foreign key that refers to an identifier in
the [CONCEPT](https://ohdsi.github.io/CommonDataModel/cdm531.html#concept) table for the unique
relationship concept.",,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_SYNONYM,concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_SYNONYM,concept_synonym_name,Yes,varchar(1000),,,No,No,,,,,
CONCEPT_SYNONYM,language_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_ANCESTOR,ancestor_concept_id,Yes,integer,"The Concept Id for the higher-level concept
CONCEPT_ANCESTOR,ancestor_concept_id,Yes,integer,"The Concept Id for the higher-level concept
that forms the ancestor in the relationship.",,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_ANCESTOR,descendant_concept_id,Yes,integer,"The Concept Id for the lower-level concept
that forms the descendant in the
CONCEPT_ANCESTOR,descendant_concept_id,Yes,integer,"The Concept Id for the lower-level concept
that forms the descendant in the
relationship.",,No,Yes,CONCEPT,CONCEPT_ID,,,
CONCEPT_ANCESTOR,min_levels_of_separation,Yes,integer,"The minimum separation in number of
levels of hierarchy between ancestor and
descendant concepts. This is an attribute
CONCEPT_ANCESTOR,min_levels_of_separation,Yes,integer,"The minimum separation in number of
levels of hierarchy between ancestor and
descendant concepts. This is an attribute
that is used to simplify hierarchic analysis.",,No,No,,,,,
CONCEPT_ANCESTOR,max_levels_of_separation,Yes,integer,"The maximum separation in number of
levels of hierarchy between ancestor and
descendant concepts. This is an attribute
CONCEPT_ANCESTOR,max_levels_of_separation,Yes,integer,"The maximum separation in number of
levels of hierarchy between ancestor and
descendant concepts. This is an attribute
that is used to simplify hierarchic analysis.",,No,No,,,,,
SOURCE_TO_CONCEPT_MAP,source_code,Yes,varchar(50),"The source code being translated
SOURCE_TO_CONCEPT_MAP,source_code,Yes,varchar(50),"The source code being translated
into a Standard Concept.",,No,No,,,,,
SOURCE_TO_CONCEPT_MAP,source_concept_id,Yes,integer,"A foreign key to the Source
Concept that is being translated
SOURCE_TO_CONCEPT_MAP,source_concept_id,Yes,integer,"A 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. ",No,Yes,CONCEPT,CONCEPT_ID,,,
SOURCE_TO_CONCEPT_MAP,source_vocabulary_id,Yes,varchar(20),"A foreign key to the
VOCABULARY table defining the
vocabulary of the source code that
is being translated to a Standard
SOURCE_TO_CONCEPT_MAP,source_vocabulary_id,Yes,varchar(20),"A foreign key to the
VOCABULARY table defining the
vocabulary of the source code that
is being translated to a Standard
Concept.",,No,No,,,,,
SOURCE_TO_CONCEPT_MAP,source_code_description,No,varchar(255),"An optional description for the
source code. This is included as a
convenience to compare the
description of the source code to
SOURCE_TO_CONCEPT_MAP,source_code_description,No,varchar(255),"An optional description for the
source code. This is included as a
convenience to compare the
description of the source code to
the name of the concept.",,No,No,,,,,
SOURCE_TO_CONCEPT_MAP,target_concept_id,Yes,integer,"The target Concept
to which the source code is being
SOURCE_TO_CONCEPT_MAP,target_concept_id,Yes,integer,"The target Concept
to which the source code is being
mapped.",,No,Yes,CONCEPT,CONCEPT_ID,,,
SOURCE_TO_CONCEPT_MAP,target_vocabulary_id,Yes,varchar(20),The Vocabulary of the target Concept.,,No,Yes,VOCABULARY,VOCABULARY_ID,,,
SOURCE_TO_CONCEPT_MAP,valid_start_date,Yes,date,"The date when the mapping
SOURCE_TO_CONCEPT_MAP,valid_start_date,Yes,date,"The date when the mapping
instance was first recorded.",,No,No,,,,,
SOURCE_TO_CONCEPT_MAP,valid_end_date,Yes,date,"The date when the mapping
instance became invalid because it
was deleted or superseded
(updated) by a new relationship.
SOURCE_TO_CONCEPT_MAP,valid_end_date,Yes,date,"The date when the mapping
instance became invalid because it
was deleted or superseded
(updated) by a new relationship.
Default value is 31-Dec-2099.",,No,No,,,,,
SOURCE_TO_CONCEPT_MAP,invalid_reason,No,varchar(1),"Reason the mapping instance was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value.",,No,No,,,,,
DRUG_STRENGTH,drug_concept_id,Yes,integer,The Concept representing the Branded Drug or Clinical Drug Product.,,No,Yes,CONCEPT,CONCEPT_ID,,,
@ -507,8 +507,8 @@ DRUG_STRENGTH,numerator_unit_concept_id,No,integer,The Concept representing the
DRUG_STRENGTH,denominator_value,No,float,"The amount of total liquid (or other divisible product, such as ointment, gel, spray, etc.).",,No,No,,,,,
DRUG_STRENGTH,denominator_unit_concept_id,No,integer,The Concept representing the denominator unit for the concentration of active ingredient.,,No,Yes,CONCEPT,CONCEPT_ID,,,
DRUG_STRENGTH,box_size,No,integer,The number of units of Clinical Branded Drug or Quantified Clinical or Branded Drug contained in a box as dispensed to the patient.,,No,No,,,,,
DRUG_STRENGTH,valid_start_date,Yes,date,"The date when the Concept was first
recorded. The default value is
DRUG_STRENGTH,valid_start_date,Yes,date,"The date when the Concept was first
recorded. The default value is
1-Jan-1970.",,No,No,,,,,
DRUG_STRENGTH,valid_end_date,Yes,date,The date when then Concept became invalid.,,No,No,,,,,
DRUG_STRENGTH,invalid_reason,No,varchar(1),"Reason the concept was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value.",,No,No,,,,,
@ -523,4 +523,4 @@ ATTRIBUTE_DEFINITION,attribute_definition_id,Yes,integer,,,No,No,,,,,
ATTRIBUTE_DEFINITION,attribute_name,Yes,varchar(255),,,No,No,,,,,
ATTRIBUTE_DEFINITION,attribute_description,No,varchar(MAX),,,No,No,,,,,
ATTRIBUTE_DEFINITION,attribute_type_concept_id,Yes,integer,,,No,Yes,CONCEPT,CONCEPT_ID,,,
ATTRIBUTE_DEFINITION,attribute_syntax,No,varchar(MAX),,,No,No,,,,,
ATTRIBUTE_DEFINITION,attribute_syntax,No,varchar(MAX),,,No,No,,,,,

1 cdmTableName cdmFieldName isRequired cdmDatatype userGuidance etlConventions isPrimaryKey isForeignKey fkTableName fkFieldName fkDomain fkClass unique DQ identifiers
27 VISIT_OCCURRENCE visit_concept_id Yes integer This field contains a concept id representing the kind of visit, like inpatient or outpatient. All concepts in this field should be standard and belong to the Visit domain. Populate this field based on the kind of visit that took place for the person. For example this could be "Inpatient Visit", "Outpatient Visit", "Ambulatory Visit", etc. This table will contain standard concepts in the Visit domain. These concepts are arranged in a hierarchical structure to facilitate cohort definitions by rolling up to generally familiar Visits adopted in most healthcare systems worldwide. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Visit
28 VISIT_OCCURRENCE visit_start_date Yes date For inpatient visits, the start date is typically the admission date. For outpatient visits the start date and end date will be the same. When populating VISIT_START_DATE, you should think about the patient experience to make decisions on how to define visits. In the case of an inpatient visit this should be the date the patient was admitted to the hospital or institution. In all other cases this should be the date of the patient-provider interaction. No No
29 VISIT_OCCURRENCE visit_start_datetime No datetime If no time is given for the start date of a visit, set it to midnight (00:00:0000). No No
30 VISIT_OCCURRENCE visit_end_date Yes date For inpatient visits the end date is typically the discharge date. Visit end dates are mandatory. If end dates are not provided in the source there are three ways in which to derive them: - Outpatient Visit: visit_end_datetime = visit_start_datetime - Emergency Room Visit: visit_end_datetime = visit_start_datetime - Inpatient Visit: Usually there is information about discharge. If not, you should be able to derive the end date from the sudden decline of activity or from the absence of inpatient procedures/drugs. - Non-hospital institution Visits: Particularly for claims data, if end dates are not provided assume the visit is for the duration of month that it occurs. For Inpatient Visits ongoing at the date of ETL, put date of processing the data into visit_end_datetime and visit_type_concept_id with 32220 "Still patient" to identify the visit as incomplete. - All other Visits: visit_end_datetime = visit_start_datetime. If this is a one-day visit the end date should match the start date. No No
31 VISIT_OCCURRENCE visit_end_datetime No datetime If no time is given for the end date of a visit, set it to midnight (00:00:0000). No No
32 VISIT_OCCURRENCE visit_type_concept_id Yes Integer Use this field to understand the provenance of the visit record, or where the record comes from. Populate this field based on the provenance of the visit record, as in whether it came from an EHR record or billing claim. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Type Concept
33 VISIT_OCCURRENCE provider_id No integer There will only be one provider per visit record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). If there are multiple providers associated with a visit in the source, this can be reflected in the event tables (CONDITION_OCCURRENCE, PROCEDURE_OCCURRENCE, etc.) or in the VISIT_DETAIL table. If there are multiple providers associated with a visit, you will need to choose which one to put here. The additional providers can be stored in the [VISIT_DETAIL](https://ohdsi.github.io/CommonDataModel/cdm531.html#visit_detail) table. No Yes PROVIDER PROVIDER_ID
34 VISIT_OCCURRENCE care_site_id No integer This field provides information about the Care Site where the Visit took place. There should only be one Care Site associated with a Visit. No Yes CARE_SITE CARE_SITE_ID
35 VISIT_OCCURRENCE visit_source_value No varchar(50) This field houses the verbatim value from the source data representing the kind of visit that took place (inpatient, outpatient, emergency, etc.) If there is information about the kind of visit in the source data that value should be stored here. If a visit is an amalgamation of visits from the source then use a hierarchy to choose the visit source value, such as IP -> ER-> OP. This should line up with the logic chosen to determine how visits are created. No No
36 VISIT_OCCURRENCE visit_source_concept_id No integer If the visit source value is coded in the source data using an OMOP supported vocabulary put the concept id representing the source value here. No Yes CONCEPT CONCEPT_ID
37 VISIT_OCCURRENCE admitting_source_concept_id No integer Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example. If available, map the admitted_from_source_value to a standard concept in the visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Visit
38 VISIT_OCCURRENCE admitting_source_value No varchar(50) This information may be called something different in the source data but the field is meant to contain a value indicating where a person was admitted from. Typically this applies only to visits that have a length of stay, like inpatient visits or long-term care visits. No No
50 VISIT_DETAIL provider_id No integer There will only be one provider per **visit** record and the ETL document should clearly state how they were chosen (attending, admitting, etc.). 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. No Yes PROVIDER PROVIDER_ID
51 VISIT_DETAIL care_site_id No integer This 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. No Yes CARE_SITE CARE_SITE_ID
52 VISIT_DETAIL visit_detail_source_value No varchar(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. No No
53 VISIT_DETAIL visit_detail_source_concept_id No Integer If 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. No Yes CONCEPT CONCEPT_ID
54 VISIT_DETAIL admitting_source_value admitted_from_value No Varchar(50) This information may be called something different in the source data but the field is meant to contain a value indicating where a person was admitted from. Typically this applies only to visits that have a length of stay, like inpatient visits or long-term care visits. No No
55 VISIT_DETAIL admitting_source_concept_id admitted_from_concept_id No Integer Use this field to determine where the patient was admitted from. This concept is part of the visit domain and can indicate if a patient was admitted to the hospital from a long-term care facility, for example. If available, map the admitted_from_source_value to a standard concept in the visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Visit
56 VISIT_DETAIL discharge_to_source_value No Varchar(50) This information may be called something different in the source data but the field is meant to contain a value indicating where a person was discharged to after a visit, as in they went home or were moved to long-term care. Typically this applies only to visits that have a length of stay of a day or more. No No
57 VISIT_DETAIL discharge_to_concept_id No integer Use this field to determine where the patient was discharged to after a visit detail record. This concept is part of the visit domain and can indicate if a patient was discharged to home or sent to a long-term care facility, for example. If available, map the DISCHARGE_TO_SOURCE_VALUE to a Standard Concept in the Visit domain. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Visit&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Visit
58 VISIT_DETAIL preceding_visit_detail_id No integer Use 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". No Yes VISIT_DETAIL VISIT_DETAIL_ID
59 VISIT_DETAIL visit_detail_parent_id No integer Use 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. No Yes VISIT_DETAIL VISIT_DETAIL_ID
60 VISIT_DETAIL visit_occurrence_id Yes integer Use this field to link the VISIT_DETAIL record to its VISIT_OCCURRENCE. Put the VISIT_OCCURRENCE_ID that subsumes the VISIT_DETAIL record here. No Yes VISIT_OCCURRENCE VISIT_OCCURRENCE_ID
61 CONDITION_OCCURRENCE condition_occurrence_id Yes integer The unique key given to a condition record for a person. Refer to the ETL for how duplicate conditions during the same visit were handled. Each instance of a condition present in the source data should be assigned this unique key. In some cases, a person can have multiple records of the same condition within the same visit. It is valid to keep these duplicates and assign them individual, unique, CONDITION_OCCURRENCE_IDs, though it is up to the ETL how they should be handled. Yes No
63 CONDITION_OCCURRENCE condition_concept_id Yes integer The CONDITION_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source value which represents a condition The CONCEPT_ID that the CONDITION_SOURCE_VALUE maps to. Only records whose source values map to concepts with a domain of "Condition" should go in this table. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Condition&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Condition
64 CONDITION_OCCURRENCE condition_start_date Yes date Use this date to determine the start date of the condition Most often data sources do not have the idea of a start date for a condition. Rather, if a source only has one date associated with a condition record it is acceptable to use that date for both the CONDITION_START_DATE and the CONDITION_END_DATE. No No
65 CONDITION_OCCURRENCE condition_start_datetime No datetime If a source does not specify datetime the convention is to set the time to midnight (00:00:0000) No No
66 CONDITION_OCCURRENCE condition_end_date No date Use this date to determine the end date of the condition Most often data sources do not have the idea of a start date for a condition. Rather, if a source only has one date associated with a condition record it is acceptable to use that date for both the CONDITION_START_DATE and the CONDITION_END_DATE. No No
67 CONDITION_OCCURRENCE condition_end_datetime No datetime If a source does not specify datetime the convention is to set the time to midnight (00:00:0000) No No
68 CONDITION_OCCURRENCE condition_type_concept_id Yes integer This field can be used to determine the provenance of the Condition record, as in whether the condition was from an EHR system, insurance claim, registry, or other sources. Choose the CONDITION_TYPE_CONCEPT_ID that best represents the provenance of the record. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?domain=Type+Concept&standardConcept=Standard&page=1&pageSize=15&query=). No Yes CONCEPT CONCEPT_ID Type Concept
69 CONDITION_OCCURRENCE condition_status_concept_id No integer This concept represents the point during the visit the diagnosis was given (admitting diagnosis, final diagnosis), whether the diagnosis was determined due to laboratory findings, if the diagnosis was exclusionary, or if it was a preliminary diagnosis, among others. 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=). No Yes CONCEPT CONCEPT_ID Condition Status
70 CONDITION_OCCURRENCE stop_reason No varchar(20) The Stop Reason indicates why a Condition is no longer valid with respect to the purpose within the source data. Note that a Stop Reason does not necessarily imply that the condition is no longer occurring. This information is often not populated in source data and it is a valid etl choice to leave it blank if the information does not exist. No No
97 DRUG_EXPOSURE drug_source_concept_id No integer This 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. No Yes CONCEPT CONCEPT_ID
98 DRUG_EXPOSURE route_source_value No varchar(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. No No
99 DRUG_EXPOSURE dose_unit_source_value No varchar(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. No No
100 PROCEDURE_OCCURRENCE procedure_occurrence_id Yes integer The 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. Yes No
101 PROCEDURE_OCCURRENCE person_id Yes integer The PERSON_ID of the PERSON for whom the procedure is recorded. This may be a system generated code. No Yes PERSON PERSON_ID
102 PROCEDURE_OCCURRENCE procedure_concept_id Yes integer The 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 procedure The 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=). No Yes CONCEPT CONCEPT_ID Procedure
103 PROCEDURE_OCCURRENCE procedure_date Yes date Use this date to determine the date the procedure occurred. If a procedure lasts more than a day, then it should be recorded as a separate record for each day the procedure occurred, this logic is in lieu of the procedure_end_date, which will be added in a future version of the CDM. No No
104 PROCEDURE_OCCURRENCE procedure_datetime No datetime This 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) No No
196 NOTE_NLP section_concept_id No integer The 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). No Yes CONCEPT CONCEPT_ID
197 NOTE_NLP snippet No varchar(250) A small window of text surrounding the term No No
198 NOTE_NLP offset No varchar(50) Character offset of the extracted term in the input note No No
199 NOTE_NLP lexical_variant Yes varchar(250) Raw text extracted from the NLP tool. No No
200 NOTE_NLP note_nlp_concept_id No integer No Yes CONCEPT CONCEPT_ID
201 NOTE_NLP note_nlp_source_concept_id No integer No Yes CONCEPT CONCEPT_ID
202 NOTE_NLP nlp_system No varchar(250) Name and version of the NLP system that extracted the term. Useful for data provenance. No No
217 SPECIMEN disease_status_concept_id No integer No Yes CONCEPT CONCEPT_ID
218 SPECIMEN specimen_source_id No varchar(50) This is the identifier for the specimen from the source system. No No
219 SPECIMEN specimen_source_value No varchar(50) No No
220 SPECIMEN unit_source_value No varchar(50) This unit for the quantity of the specimen, as represented in the source. No No
221 SPECIMEN anatomic_site_source_value No varchar(50) This is the site on the body where the specimen was taken from, as represented in the source. No No
222 SPECIMEN disease_status_source_value No varchar(50) No No
223 FACT_RELATIONSHIP domain_concept_id_1 Yes integer No Yes CONCEPT CONCEPT_ID
224 FACT_RELATIONSHIP fact_id_1 Yes integer No No
225 FACT_RELATIONSHIP domain_concept_id_2 Yes integer No Yes CONCEPT CONCEPT_ID
226 FACT_RELATIONSHIP fact_id_2 Yes integer No No
227 FACT_RELATIONSHIP relationship_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
228 LOCATION location_id Yes integer The unique key given to a unique Location. Each instance of a Location in the source data should be assigned this unique key. Yes No
229 LOCATION address_1 No varchar(50) This is the first line of the address. No No
230 LOCATION address_2 No varchar(50) This is the second line of the address No No
231 LOCATION city No varchar(50) No No
232 LOCATION state No varchar(2) No No
233 LOCATION zip No varchar(9) Zip codes are handled as strings of up to 9 characters length. For US addresses, these represent either a 3-digit abbreviated Zip code as provided by many sources for patient protection reasons, the full 5-digit Zip or the 9-digit (ZIP + 4) codes. Unless for specific reasons analytical methods should expect and utilize only the first 3 digits. For international addresses, different rules apply. No No
234 LOCATION county No varchar(20) No No
235 LOCATION location_source_value No varchar(50) Put the verbatim value for the location here, as it shows up in the source. No No
236 LOCATION country_concept_id No integer The 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.
237 LOCATION country_source_value No varchar(80) The name of the country.
238 LOCATION latitude No float Must be between -90 and 90.
328 CDM_SOURCE source_description No varchar(MAX) The description of the CDM instance. No No
329 CDM_SOURCE source_documentation_reference No varchar(255) No No
330 CDM_SOURCE cdm_etl_reference No varchar(255) Put the link to the CDM version used. No No
331 CDM_SOURCE source_release_date Yes date The release date of the source data. No No
332 CDM_SOURCE cdm_release_date Yes date The release data of the CDM instance. No No
333 CDM_SOURCE cdm_version No varchar(10) No No
334 CDM_SOURCE cdm_version_concept_id Yes integer The Concept Id representing the version of the CDM.
335 CDM_SOURCE vocabulary_version Yes varchar(20) No No
336 CONCEPT concept_id Yes integer A unique identifier for each Concept across all domains. Yes No
344 CONCEPT valid_end_date Yes date The date when the Concept became invalid because it was deleted or superseded (updated) by a new concept. The default value is 31-Dec-2099, meaning, the Concept is valid until it becomes deprecated. No No
345 CONCEPT invalid_reason No varchar(1) Reason the Concept was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value. No No
346 VOCABULARY vocabulary_id Yes varchar(20) A unique identifier for each Vocabulary, such as ICD9CM, SNOMED, Visit. Yes No
347 VOCABULARY vocabulary_name Yes varchar(255) The name describing the vocabulary, for example, International Classification of Diseases, Ninth Revision, Clinical Modification, Volume 1 and 2 (NCHS) etc. No No
348 VOCABULARY vocabulary_reference Yes varchar(255) External reference to documentation or available download of the about the vocabulary. No No
349 VOCABULARY vocabulary_version No varchar(255) Version of the Vocabulary as indicated in the source. No No
350 VOCABULARY vocabulary_concept_id Yes integer A Concept that represents the Vocabulary the VOCABULARY record belongs to. No Yes CONCEPT CONCEPT_ID
351 DOMAIN domain_id Yes varchar(20) A unique key for each domain. Yes No
352 DOMAIN domain_name Yes varchar(255) The name describing the Domain, e.g. Condition, Procedure, Measurement etc. No No
353 DOMAIN domain_concept_id Yes integer A Concept representing the Domain Concept the DOMAIN record belongs to. No Yes CONCEPT CONCEPT_ID
354 CONCEPT_CLASS concept_class_id Yes varchar(20) A unique key for each class. Yes No
355 CONCEPT_CLASS concept_class_name Yes varchar(255) The name describing the Concept Class, e.g. Clinical Finding, Ingredient, etc. No No
356 CONCEPT_CLASS concept_class_concept_id Yes integer A Concept that represents the Concept Class. No Yes CONCEPT CONCEPT_ID
357 CONCEPT_RELATIONSHIP concept_id_1 Yes integer No Yes CONCEPT CONCEPT_ID
358 CONCEPT_RELATIONSHIP concept_id_2 Yes integer No Yes CONCEPT CONCEPT_ID
359 CONCEPT_RELATIONSHIP relationship_id Yes varchar(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. No Yes RELATIONSHIP RELATIONSHIP_ID
360 CONCEPT_RELATIONSHIP valid_start_date Yes date The date when the relationship is first recorded. No No
361 CONCEPT_RELATIONSHIP valid_end_date Yes date The date when the relationship is invalidated. No No
362 CONCEPT_RELATIONSHIP invalid_reason No varchar(1) Reason the relationship was invalidated. Possible values are 'D' (deleted), 'U' (updated) or NULL. No No
363 RELATIONSHIP relationship_id Yes varchar(20) The type of relationship captured by the relationship record. Yes No
380 SOURCE_TO_CONCEPT_MAP target_concept_id Yes integer The target Concept to which the source code is being mapped. No Yes CONCEPT CONCEPT_ID
381 SOURCE_TO_CONCEPT_MAP target_vocabulary_id Yes varchar(20) The Vocabulary of the target Concept. No Yes VOCABULARY VOCABULARY_ID
382 SOURCE_TO_CONCEPT_MAP valid_start_date Yes date The date when the mapping instance was first recorded. No No
383 SOURCE_TO_CONCEPT_MAP valid_end_date Yes date The date when the mapping instance became invalid because it was deleted or superseded (updated) by a new relationship. Default value is 31-Dec-2099. No No
384 SOURCE_TO_CONCEPT_MAP invalid_reason No varchar(1) Reason the mapping instance was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value. No No
385 DRUG_STRENGTH drug_concept_id Yes integer The Concept representing the Branded Drug or Clinical Drug Product. No Yes CONCEPT CONCEPT_ID
386 DRUG_STRENGTH ingredient_concept_id Yes integer The 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. No Yes CONCEPT CONCEPT_ID
387 DRUG_STRENGTH amount_value No float The numeric value or the amount of active ingredient contained within the drug product. No No
388 DRUG_STRENGTH amount_unit_concept_id No integer The Concept representing the Unit of measure for the amount of active ingredient contained within the drug product. No Yes CONCEPT CONCEPT_ID
389 DRUG_STRENGTH numerator_value No float The concentration of the active ingredient contained within the drug product. No No
390 DRUG_STRENGTH numerator_unit_concept_id No integer The Concept representing the Unit of measure for the concentration of active ingredient. No Yes CONCEPT CONCEPT_ID
391 DRUG_STRENGTH denominator_value No float The amount of total liquid (or other divisible product, such as ointment, gel, spray, etc.). No No
392 DRUG_STRENGTH denominator_unit_concept_id No integer The Concept representing the denominator unit for the concentration of active ingredient. No Yes CONCEPT CONCEPT_ID
393 DRUG_STRENGTH box_size No integer The number of units of Clinical Branded Drug or Quantified Clinical or Branded Drug contained in a box as dispensed to the patient. No No
394 DRUG_STRENGTH valid_start_date Yes date The date when the Concept was first recorded. The default value is 1-Jan-1970. No No
395 DRUG_STRENGTH valid_end_date Yes date The date when then Concept became invalid. No No
396 DRUG_STRENGTH invalid_reason No varchar(1) Reason the concept was invalidated. Possible values are D (deleted), U (replaced with an update) or NULL when valid_end_date has the default value. No No
397 COHORT_DEFINITION cohort_definition_id Yes integer This is the identifier given to the cohort, usually by the ATLAS application No No
398 COHORT_DEFINITION cohort_definition_name Yes varchar(255) A short description of the cohort No No
399 COHORT_DEFINITION cohort_definition_description No varchar(MAX) A complete description of the cohort. No No
400 COHORT_DEFINITION definition_type_concept_id Yes integer Type defining what kind of Cohort Definition the record represents and how the syntax may be executed. No Yes CONCEPT CONCEPT_ID
401 COHORT_DEFINITION cohort_definition_syntax No varchar(MAX) Syntax or code to operationalize the Cohort Definition. No No
402 COHORT_DEFINITION subject_concept_id Yes integer This field contains a Concept that represents the domain of the subjects that are members of the cohort (e.g., Person, Provider, Visit). No Yes CONCEPT CONCEPT_ID
403 COHORT_DEFINITION cohort_initiation_date No date A date to indicate when the Cohort was initiated in the COHORT table. No No
404 ATTRIBUTE_DEFINITION attribute_definition_id Yes integer No No
405 ATTRIBUTE_DEFINITION attribute_name Yes varchar(255) No No
406 ATTRIBUTE_DEFINITION attribute_description No varchar(MAX) No No
407 ATTRIBUTE_DEFINITION attribute_type_concept_id Yes integer No Yes CONCEPT CONCEPT_ID
408 ATTRIBUTE_DEFINITION attribute_syntax No varchar(MAX) No No
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
507
508
509
510
511
512
513
514
523
524
525
526