Merge branch 'master' into cdm_v5.3.-bugfix.2

Documentation/CommonDataModel_Wiki_Files/StandardizedClinicalDataTables/MEASUREMENT.md

@@ -7,6 +7,7 @@ Field|Required|Type|Description
 |measurement_concept_id|Yes|integer|A foreign key to the standard measurement concept identifier in the Standardized Vocabularies.|
 |measurement_date|Yes|date|The date of the Measurement.|
 |measurement_datetime|No|datetime|The date and time of the Measurement. Some database systems don't have a datatype of time. To accomodate all temporal analyses, datatype datetime can be used (combining measurement_date and measurement_time [forum discussion](http://forums.ohdsi.org/t/date-time-and-datetime-problem-and-the-world-of-hours-and-1day/314))|
+|measurement_time |No|varchar(10)|The time of the Measurement. This is present for backwards compatibility and will deprecated in an upcoming version|
 |measurement_type_concept_id|Yes|integer|A foreign key to the predefined Concept in the Standardized Vocabularies reflecting the provenance from where the Measurement record was recorded.|
 |operator_concept_id|No|integer|A foreign key identifier to the predefined Concept in the Standardized Vocabularies reflecting the mathematical operator that is applied to the value_as_number. Operators are <, <=, =, >=, >.|
 |value_as_number|No|float|A Measurement result where the result is expressed as a numeric value.|

Documentation/CommonDataModel_Wiki_Files/StandardizedHealthEconomicsDataTables/PAYER_PLAN_PERIOD.md

@@ -1,25 +1,28 @@
-The PAYER_PLAN_PERIOD table captures details of the period of time that a Person is continuously enrolled under a specific health Plan benefit structure from a given Payer. Each Person receiving healthcare is typically covered by a health benefit plan, which pays for (fully or partially), or directly provides, the care. These benefit plans are provided by payers, such as health insurances or state or government agencies. In each plan the details of the health benefits are defined for the Person or her family, and the health benefit Plan might change over time typically with increasing utilization (reaching certain cost thresholds such as deductibles), plan availability and purchasing choices of the Person. The unique combinations of Payer organizations, health benefit Plans and time periods in which they are valid for a Person are recorded in this table.
+The PAYER_PLAN_PERIOD table captures details of the period of time that a Person is continuously enrolled under a specific health Plan benefit structure, from a certain sponsor, from a given Payer and within the same family. Each Person receiving healthcare is typically covered by a health benefit plan, which determines what health care services will be paid for (fully or partially). A sponsor (usually an employer group or government or the payer itself) holds the financial responsibility for the reimbursement, and the financial transaction of adjudicating the eligible plan-benefit and reimbursing the service provider is administered by the payer. In each plan the details of the health benefits are defined for the Person or her family, and the health benefit Plan might change over time typically with increasing utilization (reaching certain cost thresholds such as deductibles), plan availability and purchasing choices of the Person. The unique combinations of Payer organizations, health benefit Plans and time periods in which they are valid for a Person are recorded in this table.
 
 Field|Required|Type|Description
 :------------------------------|:--------|:------------|:----------------------------------------------
-|payer_plan_period_id			|Yes|integer|A identifier for each unique combination of payer, plan, family code and time span.|
+
-|person_id						|Yes|integer|A foreign key identifier to the Person covered by the payer. The demographic details of that Person are stored in the PERSON table.|
+|payer_plan_period_id|Yes|integer|A identifier for each unique combination of payer, sponsor, plan, family code and time span.|
-|payer_plan_period_start_date	|Yes|date|The start date of the payer plan period.|
+|person_id|Yes|integer|A foreign key identifier to the Person covered by the payer. The demographic details of that Person are stored in the PERSON table.|
-|payer_plan_period_end_date		|Yes|date|The end date of the payer plan period.|
+|payer_plan_period_start_date|Yes|date|The start date of the payer plan period.|
-|payer_concept_id				|No|integer|A foreign key that refers to a standard Payer concept identifier in the Standarized Vocabularies|
+|payer_plan_period_end_date|Yes|date|The end date of the payer plan period.|
-|payer_source_value				|No|varchar(50)|The source code for the payer as it appears in the source data.|
+| payer_concept_id |No|integer|A foreign key that refers to a Standard Payer concept identifiers in the Standardized Vocabularies|
-|payer_source_concept_id		|No|integer|A foreign key to a payer concept that refers to the code used in the source.|
+|payer_source_value|No|varchar(50)|The source code for the payer as it appears in the source data.|
-|plan_concept_id				|No|integer|A foreign key that refers to a standard plan concept identifier that represents the health benefit plan in the Standardized Vocabularies|
+| payer_source_concept_id |No|integer|A foreign key to a payer concept that refers to the code used in the source.|
-|plan_source_value				|No|varchar(50)|The source code for the Person's health benefit plan as it appears in the source data.|
+| plan_concept_id|No|integer|A foreign key that refers to a Standard plan that represents the health benefit plan in the Standardized Vocabularies|
-|plan_source_concept_id			|No|integer|A foreign key to a plan concept that refers to the plan code used in the source data.|
+|plan_source_value|No|varchar(50)|The source code for the Person's health benefit plan as it appears in the source data.|
-|sponsor_concept_id				|No|integer|A foreign key that refers to a concept identifier that represents the sponsor in the Standardized Vocabularies.|
+| plan_source_concept_id |No|integer|A foreign key to a plan concept that refers to the code used in the source.|
-|sponsor_source_value			|No|varchar(50)|The source code for the Person's sponsor of the health plan as it appears in the source data.|
+| sponsor_concept_id |No|integer|A foreign key that refers to a Standard plan that represents the sponsor in the Standardized Vocabularies|
-|sponsor_source_concept_id		|No|integer|A foreign key to a sponsor concept that refers to the sponsor code used in the source data.|
+|sponsor_source_value|No|varchar(50)|The source code for the Person's sponsor of the health plan as it appears in the source data.|
-|family_source_value			|No|varchar(50)|The source code for the Person's family as it appears in the source data.|
+| sponsor_source_concept_id*|No|integer|A foreign key to a sponsor concept that refers to the code used in the source.|
-|stop_reason_concept_id			|No|integer|A foreign key that refers to a standard termination reason that represents the reason for the termination in the Standardized Vocabularies.|
+|family_source_value|No|varchar(50)|The source code for the Person's family as it appears in the source data.|
-|stop_reason_source_value		|No|varchar(50)|The reason for stop-coverage as it appears in the source data.|
+| stop_reason_concept_id |No|integer|A foreign key that refers to a Standard termination reason that represents the reason for the termination in the Standardized Vocabularies.|
-|stop_reason_source_concept_id	|No|integer|A foreign key to a stop-coverage concept that refers to the code used in the source.|
+| stop_reason_source_value |No|varchar(50)|The reason for stop-coverage of the record.|
+| stop_reason_source_concept_id |No|integer|A foreign key to a stop-coverage concept that refers to the code used in the source.|
 
 ### Conventions 
-  * Different Payers have different designs for their health benefit Plans. The PAYER_PLAN_PERIOD table does not capture all details of the plan design or the relationship between Plans or the cost of healthcare triggering a change from one Plan to another. However, it allows identifying the unique combination of Payer (insurer), Plan (determining healthcare benefits and limits) and Person. Typically, depending on healthcare utilization, a Person may have one or many subsequent Plans during coverage by a single Payer.
+  * Different Payers have different designs for their health benefit Plans. The PAYER_PLAN_PERIOD table does not capture all details of the plan design or the relationship between Plans or the cost of healthcare triggering a change from one Plan to another. However, it allows identifying the unique combination of Payer (insurer), Plan (determining healthcare benefits and limits), Sponsor (holds the financial risk), Family and Person. Typically, depending on healthcare utilization, a Person may have one or many subsequent Plans during coverage by a single Payer.
-  * Typically, family members are covered under the same Plan as the Person. In those cases, the payer_source_value, plan_source_value and family_source_value are identical.
+  * **sponsor:** who finances the transaction. **payer:** who administers the transaction. **plan:** the actual contract being administered by the payer and agreed by the sponsor. **stop reason:** reason for termination of the contract
+  * Source values of the Payer, Plan, Sponsor, Family are captured as the respective _source_value. Concept_id's are used to support standardized analysis, similar to other OMOP CDM tables that use _source_concept_id and _concept_id.
+  * Typically, family members are covered under the same Plan as the Person. In those cases, the payer_source_value, plan_source_value and family_source_value are identical

Documentation/CommonDataModel_Wiki_Files/StandardizedVocabularies/VOCABULARY.md

@@ -5,7 +5,7 @@ Field|Required|Type|Description
 |vocabulary_id|Yes|varchar(20)|A unique identifier for each Vocabulary, such as ICD9CM, SNOMED, Visit.|
 |vocabulary_name|Yes|varchar(255)|The name describing the vocabulary, for example "International Classification of Diseases, Ninth Revision, Clinical Modification, Volume 1 and 2 (NCHS)" etc.|
 |vocabulary_reference|Yes|varchar(255)|External reference to documentation or available download of the about the vocabulary.|
-|vocabulary_version|Yes|varchar(255)|Version of the Vocabulary as indicated in the source.|
+|vocabulary_version|No|varchar(255)|Version of the Vocabulary as indicated in the source.|
 |vocabulary_concept_id|Yes|integer|A foreign key that refers to a standard concept identifier in the CONCEPT table for the Vocabulary the VOCABULARY record belongs to.|
 
 ### Conventions

ParallelDataWarehouse/OMOP CDM pdw ddl.txt

@@ -590,7 +590,7 @@ IF XACT_STATE() = 1 COMMIT; CREATE TABLE  payer_plan_period
   sponsor_source_concept_id     INTEGER       NULL ,
   family_source_value			      VARCHAR(50)	  NULL ,
   stop_reason_concept_id        INTEGER       NULL ,
-  stop_reason_source_value      VARCHAR(50)      NULL ,
+  stop_reason_source_value      VARCHAR(50)   NULL ,
   stop_reason_source_concept_id INTEGER       NULL
 )
 WITH (DISTRIBUTION = HASH(person_id));

PostgreSQL/OMOP CDM postgresql ddl.txt

@@ -451,11 +451,11 @@ CREATE TABLE measurement
   measurement_time              VARCHAR(10) NULL ,
   measurement_type_concept_id	  INTEGER			NOT NULL ,
   operator_concept_id			      INTEGER			NULL ,
-  value_as_number				        NUMERIC			  NULL ,
+  value_as_number				        NUMERIC			NULL ,
   value_as_concept_id			      INTEGER			NULL ,
   unit_concept_id				        INTEGER			NULL ,
-  range_low					          	NUMERIC			  NULL ,
+  range_low					          	NUMERIC			NULL ,
-  range_high					          NUMERIC			  NULL ,
+  range_high					          NUMERIC			NULL ,
   provider_id					          INTEGER			NULL ,
   visit_occurrence_id			      INTEGER			NULL ,
   visit_detail_id               INTEGER     NULL ,
@@ -623,7 +623,7 @@ CREATE TABLE payer_plan_period
   sponsor_source_concept_id     INTEGER       NULL ,
   family_source_value			      VARCHAR(50)	  NULL ,
   stop_reason_concept_id        INTEGER       NULL ,
-  stop_reason_source_value      VARCHAR(50)      NULL ,
+  stop_reason_source_value      VARCHAR(50)   NULL ,
   stop_reason_source_concept_id INTEGER       NULL
 )
 ;

Redshift/OMOP CDM redshift ddl.txt

@@ -590,7 +590,7 @@ CREATE TABLE payer_plan_period
   sponsor_source_concept_id     INTEGER       NULL ,
   family_source_value			      VARCHAR(50)	  NULL ,
   stop_reason_concept_id        INTEGER       NULL ,
-  stop_reason_source_value      VARCHAR(50)      NULL ,
+  stop_reason_source_value      VARCHAR(50)   NULL ,
   stop_reason_source_concept_id INTEGER       NULL
 )
 DISTKEY(person_id);

Sql Server/OMOP CDM sql server ddl.txt

@@ -623,7 +623,7 @@ CREATE TABLE payer_plan_period
   sponsor_source_concept_id     INTEGER       NULL ,
   family_source_value			      VARCHAR(50)	  NULL ,
   stop_reason_concept_id        INTEGER       NULL ,
-  stop_reason_source_value      VARCHAR(50)      NULL ,
+  stop_reason_source_value      VARCHAR(50)   NULL ,
   stop_reason_source_concept_id INTEGER       NULL
 )
 ;