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
OMOP/docs/cdm60.html

969 lines
19 KiB
HTML
Raw Normal View History

Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<!DOCTYPE html>
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<html>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=EDGE" />
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<title>CDM v6.0</title>
<script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<script src="site_libs/jqueryui-1.11.4/jquery-ui.min.js"></script>
<link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
<script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/highlightjs-9.12.0/default.css" rel="stylesheet" />
<script src="site_libs/highlightjs-9.12.0/highlight.js"></script>
<link href="site_libs/font-awesome-5.1.0/css/all.css" rel="stylesheet" />
<link href="site_libs/font-awesome-5.1.0/css/v4-shims.css" rel="stylesheet" />
<link rel='shortcut icon' type='image/x-icon' href='favicon.ico' />
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
pre:not([class]) {
background-color: white;
}
</style>
<script type="text/javascript">
if (window.hljs) {
hljs.configure({languages: []});
hljs.initHighlightingOnLoad();
if (document.readyState && document.readyState === "complete") {
window.setTimeout(function() { hljs.initHighlighting(); }, 0);
}
}
</script>
<style type="text/css">
h1 {
font-size: 34px;
}
h1.title {
font-size: 38px;
}
h2 {
font-size: 30px;
}
h3 {
font-size: 24px;
}
h4 {
font-size: 18px;
}
h5 {
font-size: 16px;
}
h6 {
font-size: 12px;
}
.table th:not([align]) {
text-align: left;
}
</style>
<link rel="stylesheet" href="style.css" type="text/css" />
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
code {
color: inherit;
background-color: rgba(0, 0, 0, 0.04);
}
img {
max-width:100%;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
</style>
<style type="text/css">
/* padding for bootstrap navbar */
body {
padding-top: 51px;
padding-bottom: 40px;
}
/* offset scroll position for anchor links (for fixed navbar) */
.section h1 {
padding-top: 56px;
margin-top: -56px;
}
.section h2 {
padding-top: 56px;
margin-top: -56px;
}
.section h3 {
padding-top: 56px;
margin-top: -56px;
}
.section h4 {
padding-top: 56px;
margin-top: -56px;
}
.section h5 {
padding-top: 56px;
margin-top: -56px;
}
.section h6 {
padding-top: 56px;
margin-top: -56px;
}
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #ffffff;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
</style>
<script>
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
menuAnchor.parent().addClass('active');
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
});
</script>
<!-- tabsets -->
<style type="text/css">
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
background: white;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: "&#xe258;";
border: none;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
background-color: transparent;
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
</style>
<!-- code folding -->
<style type="text/css">
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
@media print {
.toc-content {
/* see https://github.com/w3c/csswg-drafts/issues/4434 */
float: right;
}
}
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.90em;
}
.tocify .list-group-item {
border-radius: 0px;
}
</style>
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
</head>
<body>
<div class="container-fluid main-container">
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<!-- setup 3col/9col grid for toc_float and main content -->
<div class="row-fluid">
<div class="col-xs-12 col-sm-4 col-md-3">
<div id="TOC" class="tocify">
</div>
</div>
<div class="toc-content col-xs-12 col-sm-8 col-md-9">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"><div><img src="ohdsi16x16.png"></img> OMOP Common Data Model </div></a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fa fa-home"></span>
</a>
</li>
Updates to website
2019-10-31 19:06:09 +00:00
<li>
<a href="background.html">
<span class="fa fa-landmark"></span>
Background
</a>
</li>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<li>
<a href="dataModelConventions.html">
<span class="fa fa-list-alt"></span>
Conventions
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
<span class="fa fa-history"></span>
CDM Versions
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="cdm531.html">CDM v5.3.1</a>
</li>
<li>
<a href="cdm60.html">CDM v6.0</a>
</li>
</ul>
</li>
Updates to website
2019-10-31 19:06:09 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
<span class="fa fa-plus-square"></span>
Proposals
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="reviewProposals.html">Under Review</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Accepted</a>
<ul class="dropdown-menu" role="menu">
<li>
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<a href="oncology.html">Oncology CDM Proposal</a>
Updates to website
2019-10-31 19:06:09 +00:00
</li>
<li>
<a href="https://github.com/OHDSI/CommonDataModel/issues/252">Region_concept_id</a>
</li>
<li>
<a href="https://github.com/OHDSI/CommonDataModel/issues/264">Units in Device Table</a>
</li>
</ul>
</li>
</ul>
</li>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<li>
<a href="faq.html">
<span class="fa fa-question"></span>
FAQ
</a>
</li>
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<span class="fa fa-wrench"></span>
Contribute
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<span class="caret"></span>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</a>
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<ul class="dropdown-menu" role="menu">
<li>
<a href="contribute.html">Get involved</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">How to</a>
<ul class="dropdown-menu" role="menu">
<li class="dropdown-header">Download the DDL</li>
<li>
<a href="download.html"></a>
</li>
</ul>
</li>
</ul>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
Updates to website
2019-10-31 19:06:09 +00:00
<li>
<a href="https://github.com/OHDSI/CommonDataModel">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div class="fluid-row" id="header">
<h1 class="title toc-ignore">CDM v6.0</h1>
</div>
<div id="cdm-v6.0" class="section level2">
<h2>CDM v6.0</h2>
Updates to website
2019-10-31 19:06:09 +00:00
<p><em>Documentation still in development</em></p>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<div id="person" class="section level3 tabset tabset-pills">
<h3>PERSON</h3>
<table class="table table-hover table-condensed table-responsive" style="margin-left: auto; margin-right: auto;">
<thead>
<tr>
<th style="text-align:left;">
CDM Field
</th>
<th style="text-align:left;">
User Guide
</th>
<th style="text-align:left;">
ETL Conventions
</th>
<th style="text-align:left;">
Datatype
</th>
<th style="text-align:left;">
Updates to website
2019-10-31 19:06:09 +00:00
Required
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</th>
<th style="text-align:left;">
Updates to website
2019-10-31 19:06:09 +00:00
Primary Key
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</th>
<th style="text-align:left;">
Updates to website
2019-10-31 19:06:09 +00:00
Foreign Key (FK)
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</th>
<th style="text-align:left;">
FK Table
</th>
<th style="text-align:left;">
FK Domain
</th>
<th style="text-align:left;">
FK Class
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;">
person_id
</td>
<td style="text-align:left;">
A unique identifier for each person.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
gender_concept_id
</td>
<td style="text-align:left;">
A foreign key that refers to an identifier in the CONCEPT table for the unique gender of the person.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
CONCEPT
</td>
<td style="text-align:left;">
Gender
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
year_of_birth
</td>
<td style="text-align:left;">
The year of birth of the person. For data sources with date of birth, the year is extracted. For data sources where the year of birth is not available, the approximate year of birth is derived based on any age group categorization available.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
month_of_birth
</td>
<td style="text-align:left;">
The month of birth of the person. For data sources that provide the precise date of birth, the month is extracted and stored in this field.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
day_of_birth
</td>
<td style="text-align:left;">
The day of the month of birth of the person. For data sources that provide the precise date of birth, the day is extracted and stored in this field.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
birth_datetime
</td>
<td style="text-align:left;">
The date and time of birth of the person.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
datetime
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
death_datetime
</td>
<td style="text-align:left;">
The date and time of death of the person.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
datetime
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
race_concept_id
</td>
<td style="text-align:left;">
A foreign key that refers to an identifier in the CONCEPT table for the unique race of the person, belonging to the ‘’Race’’ vocabulary.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
CONCEPT
</td>
<td style="text-align:left;">
Race
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
ethnicity_concept_id
</td>
<td style="text-align:left;">
A foreign key that refers to the standard concept identifier in the Standardized Vocabularies for the ethnicity of the person, belonging to the ‘’Ethnicity’’ vocabulary.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
CONCEPT
</td>
<td style="text-align:left;">
Ethnicity
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
location_id
</td>
<td style="text-align:left;">
A foreign key to the place of residency for the person in the location table, where the detailed address information is stored.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
LOCATION
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
provider_id
</td>
<td style="text-align:left;">
A foreign key to the primary care provider the person is seeing in the provider table.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
PROVIDER
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
care_site_id
</td>
<td style="text-align:left;">
A foreign key to the site of primary care in the care_site table, where the details of the care site are stored.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
integer
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
Yes
</td>
<td style="text-align:left;">
CARE_SITE
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
person_source_value
</td>
<td style="text-align:left;">
An (encrypted) key derived from the person identifier in the source data. This is necessary when a use case requires a link back to the person data at the source dataset.
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
varchar(50)
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
No
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
<td style="text-align:left;">
</td>
</tr>
<tr>
<td style="text-align:left;">
gender_source_value
</td>
<td style="text-align:left;">
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<p>The source code for the gender of the person as it appears in the source data. The person</p>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
</div>
</div>
</div>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.header').parent('thead').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
</script>
Added oncology documentation. Removed extranneous files from /docs folder.
2020-04-27 20:35:41 +00:00
<!-- tabsets -->
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
$(document).ready(function () {
$('.tabset-dropdown > .nav-tabs > li').click(function () {
$(this).parent().toggleClass('nav-tabs-open')
});
});
</script>
<!-- code folding -->
<script>
$(document).ready(function () {
// move toc-ignore selectors from section div to header
$('div.section.toc-ignore')
.removeClass('toc-ignore')
.children('h1,h2,h3,h4,h5').addClass('toc-ignore');
// establish options
var options = {
selectors: "h1,h2,h3,h4,h5",
theme: "bootstrap3",
context: '.toc-content',
hashGenerator: function (text) {
return text.replace(/[.\\/?&!#<>]/g, '').replace(/\s/g, '_').toLowerCase();
},
ignoreSelector: ".toc-ignore",
scrollTo: 0
};
options.showAndHide = true;
options.smoothScroll = true;
// tocify
var toc = $("#TOC").tocify(options).data("toc-tocify");
});
</script>
Adding docs folder for future move to github.io site
2019-08-28 15:02:47 +00:00
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>