Finished outstanding doc TODOs in meta document. (#6987)
[openemr.git] / Documentation / EHI_Export / docs / tables / groups.html
blob2aeacbe79342a6087237258bf108d6d4dcae05e2
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <title>groups - openemr.openemr</title>
7 <!-- Tell the browser to be responsive to screen width -->
8 <meta content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" name="viewport">
9 <link rel="icon" type="image/png" sizes="16x16" href="../favicon.png">
10 <!-- Bootstrap 3.3.5 -->
11 <link rel="stylesheet" href="../bower/admin-lte/bootstrap/css/bootstrap.min.css">
12 <!-- Font Awesome -->
13 <link rel="stylesheet" href="../bower/font-awesome/css/font-awesome.min.css">
14 <!-- Ionicons -->
15 <link rel="stylesheet" href="../bower/ionicons/css/ionicons.min.css">
16 <!-- DataTables -->
17 <link rel="stylesheet" href="../bower/datatables.net-bs/css/dataTables.bootstrap.min.css">
18 <link rel="stylesheet" href="../bower/datatables.net-buttons-bs/css/buttons.bootstrap.min.css">
19 <!-- Code Mirror -->
20 <link rel="stylesheet" href="../bower/codemirror/codemirror.css">
21 <!-- Fonts -->
22 <link href='../fonts/indieflower/indie-flower.css' rel='stylesheet' type='text/css'>
23 <link href='../fonts/source-sans-pro/source-sans-pro.css' rel='stylesheet' type='text/css'>
25 <!-- Theme style -->
26 <link rel="stylesheet" href="../bower/admin-lte/dist/css/AdminLTE.min.css">
27 <!-- Salvattore -->
28 <link rel="stylesheet" href="../bower/salvattore/salvattore.css">
29 <!-- AdminLTE Skins. Choose a skin from the css/skins
30 folder instead of downloading all of them to reduce the load. -->
31 <link rel="stylesheet" href="../bower/admin-lte/dist/css/skins/_all-skins.min.css">
32 <!-- SchemaSpy -->
33 <link rel="stylesheet" href="../schemaSpy.css">
35 <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
36 <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
37 <!--[if lt IE 9]>
38 <script src="../bower/html5shiv/html5shiv.min.js"></script>
39 <script src="../bower/respond/respond.min.js"></script>
40 <![endif]-->
41 </head>
42 <!-- ADD THE CLASS layout-top-nav TO REMOVE THE SIDEBAR. -->
43 <body class="hold-transition skin-blue layout-top-nav">
44 <div class="wrapper">
45 <header class="main-header">
46 <nav class="navbar navbar-static-top">
47 <div class="container">
48 <div class="navbar-header">
49 <a href="../index.html" class="navbar-brand"><b>openemr</b></a><span class="navbar-brand" style="padding-left: 0">.openemr</span>
50 <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse"><i class="fa fa-bars"></i></button>
51 </div>
53 <!-- Collect the nav links, forms, and other content for toggling -->
54 <div class="collapse navbar-collapse pull-left" id="navbar-collapse">
55 <ul class="nav navbar-nav">
56 <li><a href="../index.html">Tables <span class="sr-only">(current)</span></a></li>
57 <li><a href="../columns.html" title="All of the columns in the schema">Columns</a></li>
58 <!-- <li><a href="../constraints.html" title="Useful for diagnosing error messages that just give constraint name or number">Constraints</a></li>-->
59 <li><a href="../relationships.html" title="Diagram of table relationships">Relationships</a></li>
60 <!-- <li><a href="../orphans.html" title="View of tables with neither parents nor children">Orphan&nbsp;Tables</a></li> -->
61 <!-- <li><a href="../anomalies.html" title="Things that might not be quite right">Anomalies</a></li> -->
62 <!-- <li><a href="../routines.html" title="Procedures and functions">Routines</a></li> -->
63 </ul>
64 </div>
65 <!-- /.navbar-collapse -->
66 <!-- Navbar Right Menu -->
67 </div>
68 <!-- /.container-fluid -->
69 </nav>
70 </header>
71 <!-- Main content -->
72 <!-- Full Width Column -->
73 <div class="content-wrapper">
74 <!-- Content Header (Page header) -->
75 <section class="content-header">
76 <h1>groups</h1><br />
77 <p>If there is patient data for this table the file for this export will be found in the extracted zip folder location under the filename of groups.csv</p>
78 <p>If there are non-patient data column elements that are not part of the designated record set they will be marked in the Comment's column for that data element</p>
79 <div class="box box-primary">
80 <div class="box-header with-border">
81 <i class="fa fa-file-text-o"></i>
82 <h3 id="Description" class="box-title">Description</h3>
83 <div class="box-tools pull-right">
84 <button type="button" class="btn btn-box-tool" data-widget="collapse"><i class="fa fa-minus"></i></button>
85 <button type="button" class="btn btn-box-tool" data-widget="remove"><i class="fa fa-times"></i></button>
86 </div>
87 </div><!-- /.box-header -->
88 <div class="box-body clearfix">
89 <p>Represent groups of users in the system</p>
90 </div><!-- /.box-body -->
91 </div>
92 </section>
93 <!-- Main content -->
94 <section class="content">
95 <div class="box box-primary">
96 <div class="box-header with-border">
97 <span class="glyphicon glyphicon-list-alt" aria-hidden="true"></span>
98 <h3 id="Columns" class="box-title">Columns</h3>
99 <div class="box-tools pull-right">
100 <button type="button" class="btn btn-box-tool" data-widget="collapse"><i class="fa fa-minus"></i></button>
101 <button type="button" class="btn btn-box-tool" data-widget="remove"><i class="fa fa-times"></i></button>
102 </div>
103 </div>
104 <div class="box-body">
105 <table
106 id="standard_table"
107 class="table table-bordered table-striped dataTable"
108 role="grid"
109 data-paging="false"
110 data-page-length="10"
111 data-length-change="false">
112 <thead align='left'>
113 <tr>
114 <th>Column</th>
115 <th>Type</th>
116 <th>Size</th>
117 <th title='Are nulls allowed?'>Nulls</th>
118 <th title='Is column automatically updated?'>Auto</th>
119 <th title='Default value'>Default</th>
120 <th title='Columns in tables that reference this column'>Children</th>
121 <th title='Columns in tables that are referenced by this column'>Parents</th>
122 <th title='Comments' class="toggle"><span>Comments</span></th>
123 </tr>
124 </thead>
125 <tbody>
126 <tr>
127 <td class='primaryKey' title='Primary Key'><i class='icon ion-key iconkey' style='padding-left: 5px;'></i><span id="id">id</span></td>
128 <td>BIGINT</td>
129 <td>19</td>
130 <td title=''></td>
131 <td title='Automatically updated by the database'></td>
132 <td>null</td>
133 <td>
134 <table border='0' cellspacing='0' cellpadding='0'>
135 </table>
136 </td>
137 <td>
138 <table border='0' cellspacing='0' cellpadding='0'>
139 </table>
140 </td>
141 <td><p>Surrogate id of the record used as the primary incrementing key.</p></td>
142 </tr>
143 <tr>
144 <td class='primaryKey' title='Primary Key'><i class='icon ion-key iconkey' style='padding-left: 5px;'></i><span id="name">name</span></td>
145 <td>LONGTEXT</td>
146 <td>2147483647</td>
147 <td title='nullable'></td>
148 <td title=''></td>
149 <td>null</td>
150 <td>
151 <table border='0' cellspacing='0' cellpadding='0'>
152 <tr>
153 <td title="billing.groupname references groups.name"><a href='billing.html'>billing</a><span class='relatedKey'>.groupname</span></td>
154 <td class="constraint detail">Defined in XML</td>
155 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
156 </tr>
157 <tr>
158 <td title="form_aftercare_plan.groupname references groups.name"><a href='form_aftercare_plan.html'>form_aftercare_plan</a><span class='relatedKey'>.groupname</span></td>
159 <td class="constraint detail">Defined in XML</td>
160 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
161 </tr>
162 <tr>
163 <td title="form_ankleinjury.groupname references groups.name"><a href='form_ankleinjury.html'>form_ankleinjury</a><span class='relatedKey'>.groupname</span></td>
164 <td class="constraint detail">Defined in XML</td>
165 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
166 </tr>
167 <tr>
168 <td title="form_bronchitis.groupname references groups.name"><a href='form_bronchitis.html'>form_bronchitis</a><span class='relatedKey'>.groupname</span></td>
169 <td class="constraint detail">Defined in XML</td>
170 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
171 </tr>
172 <tr>
173 <td title="form_CAMOS_category.groupname references groups.name"><a href='form_CAMOS_category.html'>form_CAMOS_category</a><span class='relatedKey'>.groupname</span></td>
174 <td class="constraint detail">Defined in XML</td>
175 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
176 </tr>
177 <tr>
178 <td title="form_CAMOS_item.groupname references groups.name"><a href='form_CAMOS_item.html'>form_CAMOS_item</a><span class='relatedKey'>.groupname</span></td>
179 <td class="constraint detail">Defined in XML</td>
180 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
181 </tr>
182 <tr>
183 <td title="form_group_attendance.groupname references groups.name"><a href='form_group_attendance.html'>form_group_attendance</a><span class='relatedKey'>.groupname</span></td>
184 <td class="constraint detail">Defined in XML</td>
185 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
186 </tr>
187 <tr>
188 <td title="form_painmap.groupname references groups.name"><a href='form_painmap.html'>form_painmap</a><span class='relatedKey'>.groupname</span></td>
189 <td class="constraint detail">Defined in XML</td>
190 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
191 </tr>
192 <tr>
193 <td title="form_phq9.groupname references groups.name"><a href='form_phq9.html'>form_phq9</a><span class='relatedKey'>.groupname</span></td>
194 <td class="constraint detail">Defined in XML</td>
195 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
196 </tr>
197 <tr>
198 <td title="form_questionnaire_assessments.groupname references groups.name"><a href='form_questionnaire_assessments.html'>form_questionnaire_assessments</a><span class='relatedKey'>.groupname</span></td>
199 <td class="constraint detail">Defined in XML</td>
200 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
201 </tr>
202 <tr>
203 <td title="form_sdoh.groupname references groups.name"><a href='form_sdoh.html'>form_sdoh</a><span class='relatedKey'>.groupname</span></td>
204 <td class="constraint detail">Defined in XML</td>
205 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
206 </tr>
207 <tr>
208 <td title="form_treatment_plan.groupname references groups.name"><a href='form_treatment_plan.html'>form_treatment_plan</a><span class='relatedKey'>.groupname</span></td>
209 <td class="constraint detail">Defined in XML</td>
210 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
211 </tr>
212 <tr>
213 <td title="form_vitals.groupname references groups.name"><a href='form_vitals.html'>form_vitals</a><span class='relatedKey'>.groupname</span></td>
214 <td class="constraint detail">Defined in XML</td>
215 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
216 </tr>
217 <tr>
218 <td title="forms.groupname references groups.name"><a href='forms.html'>forms</a><span class='relatedKey'>.groupname</span></td>
219 <td class="constraint detail">Defined in XML</td>
220 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
221 </tr>
222 <tr>
223 <td title="lists.groupname references groups.name"><a href='lists.html'>lists</a><span class='relatedKey'>.groupname</span></td>
224 <td class="constraint detail">Defined in XML</td>
225 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
226 </tr>
227 <tr>
228 <td title="form_gad7.groupname references groups.name"><a href='form_gad7.html'>form_gad7</a><span class='relatedKey'>.groupname</span></td>
229 <td class="constraint detail">Defined in XML</td>
230 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
231 </tr>
232 <tr>
233 <td title="pnotes.groupname references groups.name"><a href='pnotes.html'>pnotes</a><span class='relatedKey'>.groupname</span></td>
234 <td class="constraint detail">Defined in XML</td>
235 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
236 </tr>
237 </table>
238 </td>
239 <td>
240 <table border='0' cellspacing='0' cellpadding='0'>
241 </table>
242 </td>
243 <td><p>The name of the group.</p></td>
244 </tr>
245 <tr>
246 <td class='foreignKey' title='Foreign Key'><i class='icon ion-key iconkey' style='padding-left: 5px;'></i><span id="user">user</span></td>
247 <td>LONGTEXT</td>
248 <td>2147483647</td>
249 <td title='nullable'></td>
250 <td title=''></td>
251 <td>null</td>
252 <td>
253 <table border='0' cellspacing='0' cellpadding='0'>
254 </table>
255 </td>
256 <td>
257 <table border='0' cellspacing='0' cellpadding='0'>
258 <tr>
259 <td title="groups.user references users.username"><a href='users.html'>users</a><span class='relatedKey'>.username</span></td>
260 <td class="constraint detail">Defined in XML</td>
261 <td class="constraint detail"><span title='Restrict delete:&#10;Parent cannot be deleted if children exist'>R</span></td>
262 </tr>
263 </table>
264 </td>
265 <td><p>The username of the user that belongs to this group.</p></td>
266 </tr>
267 </tbody>
268 </table>
269 </div>
270 </div>
271 <div class="box box-primary">
272 <div class="box-header with-border">
273 <i class="fa fa-sitemap"></i>
274 <h3 id="Indexes" class="box-title">Indexes</h3>
275 <div class="box-tools pull-right">
276 <button type="button" class="btn btn-box-tool" data-widget="collapse"><i class="fa fa-minus"></i></button>
277 <button type="button" class="btn btn-box-tool" data-widget="remove"><i class="fa fa-times"></i></button>
278 </div>
279 </div>
280 <div class="box-body">
281 <table
282 id="indexes_table"
283 class="table table-bordered table-striped dataTable"
284 role="grid"
285 data-paging="false"
286 data-page-length="10"
287 data-length-change="false">
288 <thead>
289 <tr>
290 <th>Constraint Name</th>
291 <th>Type</th>
292 <th>Sort</th>
293 <th>Column(s)</th>
294 </tr>
295 </thead>
296 <tbody>
297 <tr>
298 <td class='primaryKey' title='Primary Key'><i class='icon ion-key iconkey'></i> PRIMARY</td>
299 <td>Primary key</td>
300 <td><span title='Ascending'>Asc</span></td>
301 <td>id</td>
302 </tr>
303 </tbody>
304 </table>
305 </div><!-- /.box-body -->
306 </div>
307 <div class="box box-primary">
308 <div class="box-header with-border">
309 <i class="fa fa-code-fork"></i>
310 <h3 id="Relationships" class="box-title">Relationships</h3>
311 <div class="box-tools pull-right">
312 <button type="button" class="btn btn-box-tool" data-widget="collapse"><i class="fa fa-minus"></i></button>
313 <button type="button" class="btn btn-box-tool" data-widget="remove"><i class="fa fa-times"></i></button>
314 </div>
315 </div>
316 <div class="box-body">
317 <div class="nav-tabs-custom"><!-- Tabs within a box -->
318 <h5>Close relationships within degrees of separation</h5>
319 <ul class="nav nav-tabs pull-left ui-sortable-handle">
320 <li class="active"><a href="#oneDegreeImg-chart" data-toggle="tab" aria-expanded="true">One</a></li>
321 <li class=""><a href="#twodegreesDegreeImg-chart" data-toggle="tab" aria-expanded="true">Two degrees</a></li>
322 </ul>
323 <div class="tab-content no-padding">
324 <div class="chart tab-pane active" id="oneDegreeImg-chart" style="position: relative; overflow-x:auto;">
326 <a name='diagram'><object type="image/svg+xml" id="oneDegreeImg" data="../diagrams/tables/groups.1degree.svg" class="diagram" border="0" align="left"></object></a>
327 </div>
328 <div class="chart tab-pane " id="twodegreesDegreeImg-chart" style="position: relative; overflow-x:auto;">
330 <a name='diagram'><object type="image/svg+xml" id="twodegreesDegreeImg" data="../diagrams/tables/groups.2degrees.svg" class="diagram" border="0" align="left"></object></a>
331 </div>
332 </div>
333 </div>
334 </div><!-- /.box-body -->
335 </div>
336 </section>
337 <script>
338 var config = {
339 pagination: false
341 </script>
343 </div>
344 <!-- /.content-wrapper -->
345 <footer class="main-footer">
346 <div>
347 <div class="pull-right hidden-xs">
348 <a href="https://github.com/schemaspy/schemaspy" title="GitHub for SchemaSpy"><i class="fa fa-github-square fa-2x"></i></a>
349 <a href="http://stackoverflow.com/questions/tagged/schemaspy" title="StackOverflow for SchemaSpy"><i class="fa fa-stack-overflow fa-2x"></i></a>
350 </div>
351 <strong>Generated by <a href="http://schemaspy.org/" class="logo-text"><i class="fa fa-database"></i> SchemaSpy 6.2.4</a></strong>
352 </div>
353 <!-- /.container -->
354 </footer>
355 </div>
356 <!-- ./wrapper -->
358 <!-- jQuery 2.2.3 -->
359 <script src="../bower/admin-lte/plugins/jQuery/jquery-2.2.3.min.js"></script>
360 <script src="../bower/admin-lte/plugins/jQueryUI/jquery-ui.min.js"></script>
361 <!-- Bootstrap 3.3.5 -->
362 <script src="../bower/admin-lte/bootstrap/js/bootstrap.min.js"></script>
363 <!-- DataTables -->
364 <script src="../bower/datatables.net/jquery.dataTables.min.js"></script>
365 <script src="../bower/datatables.net-bs/js/dataTables.bootstrap.min.js"></script>
366 <script src="../bower/datatables.net-buttons/dataTables.buttons.min.js"></script>
367 <script src="../bower/datatables.net-buttons-bs/js/buttons.bootstrap.min.js"></script>
368 <script src="../bower/datatables.net-buttons/buttons.html5.min.js"></script>
369 <script src="../bower/datatables.net-buttons/buttons.print.min.js"></script>
370 <script src="../bower/datatables.net-buttons/buttons.colVis.min.js"></script>
371 <!-- SheetJS -->
372 <script src="../bower/js-xlsx/xlsx.full.min.js"></script>
373 <!-- pdfmake -->
374 <script src="../bower/pdfmake/pdfmake.min.js"></script>
375 <script src="../bower/pdfmake/vfs_fonts.js"></script>
376 <!-- SlimScroll -->
377 <script src="../bower/admin-lte/plugins/slimScroll/jquery.slimscroll.min.js"></script>
378 <!-- FastClick -->
379 <script src="../bower/admin-lte/plugins/fastclick/fastclick.js"></script>
380 <!-- Salvattore -->
381 <script src="../bower/salvattore/salvattore.min.js"></script>
382 <!-- AnchorJS -->
383 <script src="../bower/anchor-js/anchor.min.js"></script>
384 <!-- CodeMirror -->
385 <script src="../bower/codemirror/codemirror.js"></script>
386 <script src="../bower/codemirror/sql.js"></script>
387 <!-- AdminLTE App -->
388 <script src="../bower/admin-lte/dist/js/app.min.js"></script>
389 <script src="table.js"></script>
390 <script src="../schemaSpy.js"></script>
391 </body>
392 </html>