5.3 KiB
5.3 KiB
1 | cdmTableName | cdmFieldName | isRequired | cdmDatatype | userGuidance | etlConventions | isPrimaryKey | isForeignKey | fkTableName | fkFieldName | fkDomain | fkClass |
---|---|---|---|---|---|---|---|---|---|---|---|---|
2 | EPISODE | episode_id | Yes | bigint | A unique identifier for each Episode. | Yes | No | |||||
3 | EPISODE | person_id | Yes | bigint | The PERSON_ID of the PERSON for whom the episode is recorded. | No | Yes | PERSON | PERSON_ID | |||
4 | EPISODE | episode_concept_id | Yes | integer | The 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=) | No | Yes | Episode | |||
5 | EPISODE | episode_start_date | Yes | date | The date when the Episode beings. | Please see [article] for how to define an Episode start date. | No | No | ||||
6 | EPISODE | episode_start_datetime | No | datetime | The date and time when the Episode begins. | No | No | |||||
7 | EPISODE | episode_end_date | No | date | The date when the instance of the Episode is considered to have ended. | Please see [article] for how to define an Episode end date. | ||||||
8 | EPISODE | episode_end_datetime | No | datetime | The date when the instance of the Episode is considered to have ended. | No | No | |||||
9 | EPISODE | episode_parent_id | No | bigint | Use 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. | No | No | ||||
10 | EPISODE | episode_number | No | integer | For 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. | No | No | ||||
11 | EPISODE | episode_object_concept_id | Yes | integer | A 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. | No | Yes | CONCEPT | CONCEPT_ID | Procedure, Regimen | |
12 | EPISODE | episode_type_concept_id | Yes | integer | This 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=). | No | Yes | CONCEPT | CONCEPT_ID | Type Concept | |
13 | EPISODE | episode_source_value | No | varchar(50) | The source code for the Episdoe 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. | No | No | |||||
14 | EPISODE | episode_source_concept_id | No | integer | A 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. | No | Yes | CONCEPT | CONCEPT_ID | ||
15 | EPISODE_EVENT | episode_id | Yes | bigint | Use this field to link the EPISODE_EVENT record to its EPISODE. | Put the EPISODE_ID that subsumes the EPISODE_EVENT record here. | No | Yes | EPISODE | EPISODE_ID | ||
16 | EPISODE_EVENT | event_id | Yes | bigint | This 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. | No | No | ||||
17 | EPISODE_EVENT | episode_event_field_concept_id | Yes | integer | 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 EVENT_ID came from. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?vocabulary=CDM&conceptClass=Field&page=1&pageSize=15&query=) | No | Yes | CONCEPT | CONCEPT_ID | Metadata | |
18 | MEASUREMENT | modifier_of_event_id | No | bigint | If 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. | No | No | ||||
19 | MEASUREMENT | modifier_of_field_concept_id | No | integer | If 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 MODIFIER_OF_EVENT_ID came from. [Accepted Concepts](https://athena.ohdsi.org/search-terms/terms?vocabulary=CDM&conceptClass=Field&page=1&pageSize=15&query=) | No | Yes | CONCEPT | CONCEPT_ID | Metadata |