Differences

This shows you the differences between two versions of the page.

--- documentation:next_cdm:add_survey [2017/06/19 15:48] – cmkerr
+++ documentation:next_cdm:add_survey [2017/08/01 18:08] (current) – clairblacketer
@@ Line 1: / Line 1: @@
 ===== Adding PROM data to CDM =====
+===Proposals now housed on github===
+[[https://github.com/OHDSI/CommonDataModel/issues/90|link to github]]
   * Requestor: Colin Orr and Catherine Kerr, ICON plc
   * Revising party: Joshua Ransom, Anna Corning, Emelly Rusli, Rayhnuma Ahmed, Aaron Stern; SHYFT Analytics
@@ Line 53: / Line 56: @@
 === RESPONSE table ===
-Will be added here.
+^ Field                  ^ Required ^ Type      ^ Description                          ^
+| RESPONSE_OCCURRENCE_ID | Yes      | integer   | Unique identifier for each response. |
+| PERSON_ID              | Yes      | integer   | A foreign key identifier to the Person in the PERSON table about whom the response was recorded. |
+| SURVEY_OCCURRENCE_ID   | Yes      | integer   | A foreign key to SURVEY table about which survey the question and response occurred. |
+| QUESTION_CONCEPT_ID    | Yes      | integer   | A foreign key that refers to a question Concept identifier in the Standardized Vocabularies |
+| QUESTION_SOURCE_VALUE  | No       | varchar(255) | The question as it appears in the source data. This code is mapped to a Standard Concept in the Standardized Vocabularies and the original code is, stored here for reference. |
+| RESPONSE_DATE          | Yes      | date      | Date on which the response was recorded |
+| RESPONSE_DATETIME      | No       | datetime  | Date and time on which the response was recorded |
+| RESPONSE_AS_CONCEPT_ID | Yes      | integer   | Foreign key that refers to a response Concept identifier in the Standardized Vocabularies |
+| RESPONSE _AS_STRING    | No       | varchar(255) | The response stored as a string. This is applicable to questions where the result is expressed as verbatim text. |
+| RESPONSE _AS_NUMBER    | No       | float     | The response stored as a number. This is applicable to questions where the result is expressed as a numeric value. |
+| RESPONSE_AS_DATETIME   | No       | datetime  | The response stored as a datetime. This is applicable to questions where the result is expressed as a historical date/time. |
+| RESPONSE_RANGE_LOW     | No       | varchar(50) | The lowest value of the range of responses for the question. |
+| RESPONSE_RANGE_HIGH    | No       | varchar(50) | The highest value of the range of responses for the question |
 ==== Use Cases ====
@@ Line 60: / Line 76: @@
 === CONCEPT table - example ===
-^ CONCEPT_ID ^ CONCEPT_NAME ^ DOMAIN_ID ^ VOCABULARY_ID ^ CONCEPT_CLASS_ID ^ STANDARD_CONCEPT ^ CONCEPT_CODE ^
+^ CONCEPT_ID ^ CONCEPT _NAME ^ DOMAIN_ID ^ VOCABULARY_ID ^ CONCEPT_ CLASS_ID ^ STANDARD _CONCEPT ^ CONCEPT _CODE ^
 | 2020 | HPS1 | Metadata | Domain | Domain |  | ICHOM generated |
 | 2021 | None | HPS1 | ICHOM Observation | PRO Measure | S | 0 |
@@ Line 73: / Line 89: @@
 ^ Column ^ Value ^ Comment ^
-| SURVEY_ID | 19073 |  |
+| SURVEY_OCCURRENCE_ID | 19073 |  |
 | SURVEY_CONCEPT_ID | 3501 | Concept for HOOSPS survey |
 | PERSON_ID | 21405 |  |
-| VISIT_OCCURRENCE_ID | 13403 | ID of visit during which treatment was carried out |
+| VISIT_OCCURRENCE_ID | 13403 |  |
 | SURVEY_DATE | 2016-07-14 |  |
-| ASSISTED_IND_CONCEPT_ID | 3601 | Concept for "Completed without assistance" |
+| ASSISTANCE_CONCEPT_ID | 3601 | Concept for "Completed without assistance" |
-| ASSISTED_IND | 1 | ICHOM value for "Completed without assistance" |
+| ASSISTANCE_SOURCE_VALUE | 1 | ICHOM value for "Completed without assistance" |
-| DATA_SOURCE_CONCEPT_ID | 3611 | Concept for "Patient-reported" |
+| SURVEY_RECORDER_CONCEPT_ID | 3611 | Concept for "Patient-reported" |
-| DATA_SOURCE | 3 | ICHOM value for "Patient-reported" |
+| SURVEY_RECORDER_SOURCE_VALUE | 3 | ICHOM value for "Patient-reported" |
 | TIMING_CONCEPT_ID | 3621 | Concept for "BASELINE" timing |
 | TIMING_SOURCE_VALUE | BASELINE |  |
 | COLLECTION_METHOD_CONCEPT_ID | 3631 | Concept for "Electronic questionnaire" |
-| COLLECTION_METHOD | 3 | ICHOM value for "Electronic questionnaire" |
+| COLLECTION_METHOD_SOURCE_VALUE | 3 | ICHOM value for "Electronic questionnaire" |
-| DURATION | 00:07:45 | Patient took 7 minutes and 45 seconds to complete online survey |
+| DURATION_TIME | 00:07:45 | Patient took 7 minutes and 45 seconds to complete online survey |
-| SURVEY_SOURCE_VALUE | HS001234 |  |
+| SURVEY_SOURCE_VALUE | HOOSPS |  |
-| SURVEY_NAME | HOOSPS |  |
+| SURVEY_SOURCE_IDENTIFIER | HS001234 |  |
+| VALIDATED_SURVEY_CONCEPT_ID | 3701 | Concept for "Validated survey" |
+| VALIDATED_SURVEY_SOURCE_VALUE | 1 | ICHOM value for "Validated Survey" |
-=== OBSERVATION table - example ===
+=== RESPONSE table - example ===
 ^ Column ^ Value ^ Comment ^
-| OBSERVATION_ID | 794657 |  |
+| RESPONSE_OCCURRENCE_ID | 794657 |  |
 | PERSON_ID | 21405 |  |
-| OBSERVATION_CONCEPT_ID | 2020 | Concept for HPS1 |
+| SURVEY_OCCURRENCE_ID | 19073 |  |
-| OBSERVATION_DATE | 2016-07-14 |  |
+| QUESTION_CONCEPT_ID | 2020 | Concept for HPS1 |
-| OBSERVATION_DATETIME |  |  |
+| QUESTION_SOURCE_VALUE | HPS1 |  |
-| OBSERVATION_TYPE_CONCEPT_ID | 1001 | Concept for 'PRO Measure' |
+| RESPONSE_DATE | 2016-07-14 |  |
-| VALUE_AS_NUMBER |  |  |
+| RESPONSE_DATETIME |  |  |
-| VALUE_AS_STRING |  |  |
+| RESPONSE_AS_CONCEPT_ID | 2023 | Concept for "Moderate" |
-| VALUE_AS_CONCEPT_ID | 2023 | Concept for "Moderate" |
+| RESPONSE _AS_STRING |  |  |
-| QUALIFIER_CONCEPT_ID |  |  |
+| RESPONSE _AS_NUMBER |  |  |
-| UNIT_CONCEPT_ID |  |  |
+| RESPONSE_AS_DATETIME |  |  |
-| PROVIDER_ID |  |  |
+| RESPONSE_RANGE_LOW | 0 |  |
-| VISIT_OCCURRENCE_ID | 13403 |  |
+| RESPONSE_RANGE_HIGH | 4 |  |
-| OBSERVATION_SOURCE_VALUE |  |  |
-| OBSERVATION_SOURCE_CONCEPT_ID |  |  |
-| UNIT_SOURCE_VALUE |  |  |
-| QUALIFIER_SOURCE_VALUE |  |  |
-| SURVEY_ID | 19073 |  |
-| TIMING_CONCEPT_ID | 3621 |  |
-| TIMING_SOURCE_VALUE | BASELINE |  |