acl_setup.php

   1 <?php
   2  // Copyright (C) 2005-2006 Rod Roark <rod@sunsetsystems.com>
   3  //
   4  // This program is free software; you can redistribute it and/or
   5  // modify it under the terms of the GNU General Public License
   6  // as published by the Free Software Foundation; either version 2
   7  // of the License, or (at your option) any later version.
   8  //
   9  // This program is run by the OpenEMR setup.php script to install phpGACL
  10  // and creates the Access Control Objects and their sections.
  11  // See openemr/library/acl.inc file for the list of
  12  // currently supported Access Control Objects(ACO), which this
  13  // script will install.  This script also creates several
  14  // ARO groups, an "admin" ARO, and some reasonable ACL entries for
  15  // the groups.
  16  //   ARO groups include:
  17  //      Administrators
  18  //      Physicians     (Doctors)
  19  //      Clinicians     (Nurses, Physician Assistants, etc.)
  20  //      Front Office   (Receptionist)
  21  //      Accounting
  22  //
  23  // Upgrade Howto
  24  // When upgrading to a new version of OpenEMR, run the acl_upgrade.php
  25  // script to update the phpGACL access controls.  This is required to
  26  // ensure the database includes all the required Access Control
  27  // Objects(ACO).
  28  //
  29
  30  // On 06/2009, added pertinent comments below each entry to allow capture
  31  //  of these terms by the translation engine.
  32
  33  require_once(dirname(__FILE__).'/library/acl.inc');
  34
  35  if (! $phpgacl_location) die("You must first set up library/acl.inc to use phpGACL!");
  36
  37  require_once("$phpgacl_location/gacl_api.class.php");
  38
  39  $gacl = new gacl_api();
  40
  41  // Create the ACO sections.  Every ACO must have a section.
  42  //
  43  if ($gacl->add_object_section('Accounting', 'acct', 10, 0, 'ACO') === FALSE) {
  44   echo "Unable to create the access controls for OpenEMR.  You have likely already run this script (acl_setup.php) successfully.<br>Other possible problems include php-GACL configuration file errors (gacl.ini.php or gacl.class.php).<br>";
  45   return;
  46  }
  47      // xl('Accounting')
  48  $gacl->add_object_section('Administration', 'admin'        , 10, 0, 'ACO');
  49      // xl('Administration')
  50  $gacl->add_object_section('Encounters'    , 'encounters'   , 10, 0, 'ACO');
  51      // xl('Encounters')
  52  $gacl->add_object_section('Lists'         , 'lists'        , 10, 0, 'ACO');
  53      // xl('Lists')
  54  $gacl->add_object_section('Patients'      , 'patients'     , 10, 0, 'ACO');
  55      // xl('Patients')
  56  $gacl->add_object_section('Squads'        , 'squads'       , 10, 0, 'ACO');
  57      // xl('Squads')
  58  $gacl->add_object_section('Sensitivities' , 'sensitivities', 10, 0, 'ACO');
  59      // xl('Sensitivities')
  60  $gacl->add_object_section('Placeholder'   , 'placeholder'  , 10, 0, 'ACO');
  61      // xl('Placeholder')
  62  $gacl->add_object_section('Nation Notes'   , 'nationnotes'  , 10, 0, 'ACO');
  63      // xl('Nation Notes')
  64  $gacl->add_object_section('Patient Portal','patientportal'  , 10, 0, 'ACO');
  65      // xl('Patient Portal')
  66  // Create Accounting ACOs.
  67  //
  68  $gacl->add_object('acct', 'Billing (write optional)'           , 'bill' , 10, 0, 'ACO');
  69      // xl('Billing (write optional)')
  70  $gacl->add_object('acct', 'Price Discounting'                  , 'disc' , 10, 0, 'ACO');
  71      // xl('Price Discounting')
  72  $gacl->add_object('acct', 'EOB Data Entry'                     , 'eob'  , 10, 0, 'ACO');
  73      // xl('EOB Data Entry')
  74  $gacl->add_object('acct', 'Financial Reporting - my encounters', 'rep'  , 10, 0, 'ACO');
  75      // xl('Financial Reporting - my encounters')
  76  $gacl->add_object('acct', 'Financial Reporting - anything'     , 'rep_a', 10, 0, 'ACO');
  77      // xl('Financial Reporting - anything')
  78
  79  // Create Administration ACOs.
  80  //
  81  $gacl->add_object('admin', 'Superuser'                       , 'super'    , 10, 0, 'ACO');
  82      // xl('Superuser')
  83  $gacl->add_object('admin', 'Calendar Settings'               , 'calendar' , 10, 0, 'ACO');
  84      // xl('Calendar Settings')
  85  $gacl->add_object('admin', 'Database Reporting'              , 'database' , 10, 0, 'ACO');
  86      // xl('Database Reporting')
  87  $gacl->add_object('admin', 'Forms Administration'            , 'forms'    , 10, 0, 'ACO');
  88      // xl('Forms Administration')
  89  $gacl->add_object('admin', 'Practice Settings'               , 'practice' , 10, 0, 'ACO');
  90      // xl('Practice Settings')
  91  $gacl->add_object('admin', 'Superbill Codes Administration'  , 'superbill', 10, 0, 'ACO');
  92      // xl('Superbill Codes Administration')
  93  $gacl->add_object('admin', 'Users/Groups/Logs Administration', 'users'    , 10, 0, 'ACO');
  94      // xl('Users/Groups/Logs Administration')
  95  $gacl->add_object('admin', 'Batch Communication Tool'        , 'batchcom' , 10, 0, 'ACO');
  96      // xl('Batch Communication Tool')
  97  $gacl->add_object('admin', 'Language Interface Tool'         , 'language' , 10, 0, 'ACO');
  98      // xl('Language Interface Tool')
  99  $gacl->add_object('admin', 'Pharmacy Dispensary'             , 'drugs'    , 10, 0, 'ACO');
 100      // xl('Pharmacy Dispensary')
 101  $gacl->add_object('admin', 'ACL Administration'              , 'acl'      , 10, 0, 'ACO');
 102      // xl('ACL Administration')
 103
 104  // Create ACOs for encounters.
 105  //
 106  $gacl->add_object('encounters', 'Authorize - my encounters'                        , 'auth'    , 10, 0, 'ACO');
 107      // xl('Authorize - my encounters')
 108  $gacl->add_object('encounters', 'Authorize - any encounters'                       , 'auth_a'  , 10, 0, 'ACO');
 109      // xl('Authorize - any encounters')
 110  $gacl->add_object('encounters', 'Coding - my encounters (write,wsome optional)'    , 'coding'  , 10, 0, 'ACO');
 111      // xl('Coding - my encounters (write,wsome optional)')
 112  $gacl->add_object('encounters', 'Coding - any encounters (write,wsome optional)'   , 'coding_a', 10, 0, 'ACO');
 113      // xl('Coding - any encounters (write,wsome optional)')
 114  $gacl->add_object('encounters', 'Notes - my encounters (write,addonly optional)'   , 'notes'   , 10, 0, 'ACO');
 115      // xl('Notes - my encounters (write,addonly optional)')
 116  $gacl->add_object('encounters', 'Notes - any encounters (write,addonly optional)'  , 'notes_a' , 10, 0, 'ACO');
 117      // xl('Notes - any encounters (write,addonly optional)')
 118  $gacl->add_object('encounters', 'Fix encounter dates - any encounters'             , 'date_a'  , 10, 0, 'ACO');
 119      // xl('Fix encounter dates - any encounters')
 120  $gacl->add_object('encounters', 'Less-private information (write,addonly optional)', 'relaxed' , 10, 0, 'ACO');
 121      // xl('Less-private information (write,addonly optional)')
 122
 123  // Create ACOs for lists.
 124  //
 125  $gacl->add_object('lists', 'Default List (write,addonly optional)'        , 'default'  , 10, 0, 'ACO');
 126      // xl('Default List (write,addonly optional)')
 127  $gacl->add_object('lists', 'State List (write,addonly optional)'          , 'state'    , 10, 0, 'ACO');
 128      // xl('State List (write,addonly optional)')
 129  $gacl->add_object('lists', 'Country List (write,addonly optional)'        , 'country'  , 10, 0, 'ACO');
 130      // xl('Country List (write,addonly optional)')
 131  $gacl->add_object('lists', 'Language List (write,addonly optional)'       , 'language' , 10, 0, 'ACO');
 132      // xl('Language List (write,addonly optional)')
 133  $gacl->add_object('lists', 'Ethnicity-Race List (write,addonly optional)' , 'ethrace'  , 10, 0, 'ACO');
 134      // xl('Ethnicity-Race List (write,addonly optional)')
 135
 136  // Create ACOs for patientportal.
 137  //
 138  $gacl->add_object('patientportal', 'Patient Portal' , 'portal'  , 10, 0, 'ACO');
 139      // xl('Patient Portal')
 140
 141  // Create ACOs for patients.
 142  //
 143  $gacl->add_object('patients', 'Appointments (write,wsome optional)'      , 'appt' , 10, 0, 'ACO');
 144      // xl('Appointments (write,wsome optional)')
 145  $gacl->add_object('patients', 'Demographics (write,addonly optional)'    , 'demo' , 10, 0, 'ACO');
 146      // xl('Demographics (write,addonly optional)')
 147  $gacl->add_object('patients', 'Medical/History (write,addonly optional)' , 'med'  , 10, 0, 'ACO');
 148      // xl('Medical/History (write,addonly optional)')
 149  $gacl->add_object('patients', 'Transactions (write optional)'            , 'trans', 10, 0, 'ACO');
 150      // xl('Transactions (write optional)')
 151  $gacl->add_object('patients', 'Documents (write,addonly optional)'       , 'docs' , 10, 0, 'ACO');
 152      // xl('Documents (write,addonly optional)')
 153  $gacl->add_object('patients', 'Patient Notes (write,addonly optional)'   , 'notes', 10, 0, 'ACO');
 154      // xl('Patient Notes (write,addonly optional)')
 155  $gacl->add_object('patients', 'Sign Lab Results (write,addonly optional)', 'sign'  , 10, 0, 'ACO');
 156      // xl('Sign Lab Results (write,addonly optional)')
 157
 158  // Create ACOs for sensitivities.
 159  //
 160  $gacl->add_object('sensitivities', 'Normal', 'normal', 10, 0, 'ACO');
 161      // xl('Normal')
 162  $gacl->add_object('sensitivities', 'High'  , 'high'  , 20, 0, 'ACO');
 163      // xl('High')
 164
 165  // Create ACO for placeholder.
 166  //
 167  $gacl->add_object('placeholder', 'Placeholder (Maintains empty ACLs)', 'filler', 10, 0, 'ACO');
 168      // xl('Placeholder (Maintains empty ACLs)')
 169
 170  // Create ACO for nationnotes.
 171  //
 172  $gacl->add_object('nationnotes', 'Nation Notes Configure', 'nn_configure', 10, 0, 'ACO');
 173      // xl('Nation Notes Configure')
 174
 175  // Create ARO groups.
 176  //
 177  $users = $gacl->add_group('users', 'OpenEMR Users' , 0     , 'ARO');
 178      // xl('OpenEMR Users')
 179  $admin = $gacl->add_group('admin', 'Administrators', $users, 'ARO');
 180      // xl('Administrators')
 181  $clin  = $gacl->add_group('clin' , 'Clinicians'    , $users, 'ARO');
 182      // xl('Clinicians')
 183  $doc   = $gacl->add_group('doc'  , 'Physicians'    , $users, 'ARO');
 184      // xl('Physicians')
 185  $front = $gacl->add_group('front', 'Front Office'  , $users, 'ARO');
 186      // xl('Front Office')
 187  $back  = $gacl->add_group('back' , 'Accounting'    , $users, 'ARO');
 188      // xl('Accounting')
 189 $breakglass  = $gacl->add_group('breakglass' , 'Emergency Login'    , $users, 'ARO');
 190      // xl('Emergency Login')
 191
 192
 193  // Create a Users section for the AROs (humans).
 194  //
 195  $gacl->add_object_section('Users', 'users', 10, 0, 'ARO');
 196      // xl('Users')
 197
 198  // Create the Administrator in the above-created "users" section
 199  // and add him/her to the above-created "admin" group.
 200  // If this script is being used by OpenEMR's setup, then will
 201  //   incorporate the installation values. Otherwise will
 202 //    hardcode the 'admin' user.
 203  if ( isset($this->iuser) ) {
 204   $gacl->add_object('users', $this->iuname, $this->iuser, 10, 0, 'ARO');
 205   $gacl->add_group_object($admin, 'users', $this->iuser, 'ARO');
 206  }
 207  else {
 208   $gacl->add_object('users', 'Administrator', 'admin' ,10, 0, 'ARO');
 209   $gacl->add_group_object($admin, 'users', 'admin', 'ARO');
 210  }
 211
 212  // Declare return terms for language translations
 213  //  xl('write') xl('wsome') xl('addonly')
 214
 215  // Set permissions for administrators.
 216  //
 217  $gacl->add_acl(
 218   array(
 219    'acct'=>array('bill', 'disc', 'eob', 'rep', 'rep_a'),
 220    'admin'=>array('calendar', 'database', 'forms', 'practice', 'superbill', 'users', 'batchcom', 'language', 'super', 'drugs', 'acl'),
 221    'encounters'=>array('auth_a', 'coding_a', 'notes_a', 'date_a'),
 222    'lists'=>array('default','state','country','language','ethrace'),
 223    'patients'=>array('appt', 'demo', 'med', 'trans', 'docs', 'notes'),
 224    'sensitivities'=>array('normal', 'high'),
 225    'nationnotes'=>array('nn_configure'),
 226    'patientportal'=>array('portal')
 227   ),
 228   NULL, array($admin), NULL, NULL,
 229   1, 1, 'write', 'Administrators can do anything'
 230  );
 231      // xl('Administrators can do anything')
 232
 233  // Set permissions for physicians.
 234  //
 235  $gacl->add_acl(
 236   array(
 237    'placeholder'=>array('filler')
 238   ),
 239   NULL, array($doc), NULL, NULL,
 240   1, 1, 'addonly', 'Things that physicians can read and enter but not modify'
 241  );
 242      // xl('Things that physicians can read and enter but not modify')
 243  $gacl->add_acl(
 244   array(
 245    'acct'=>array('disc', 'rep'),
 246    'admin'=>array('drugs'),
 247    'encounters'=>array('auth_a', 'coding_a', 'notes_a', 'date_a'),
 248    'patients'=>array('appt', 'demo', 'med', 'trans', 'docs', 'notes', 'sign'),
 249    'sensitivities'=>array('normal', 'high')
 250   ),
 251   NULL, array($doc), NULL, NULL,
 252   1, 1, 'write', 'Things that physicians can read and modify'
 253  );
 254      // xl('Things that physicians can read and modify')
 255
 256  // Set permissions for clinicians.
 257  //
 258  $gacl->add_acl(
 259   array(
 260    'encounters'=>array('notes', 'relaxed'),
 261    'patients'=>array('demo', 'med', 'docs', 'notes'),
 262    'sensitivities'=>array('normal')
 263   ),
 264   NULL, array($clin), NULL, NULL,
 265   1, 1, 'addonly', 'Things that clinicians can read and enter but not modify'
 266  );
 267      // xl('Things that clinicians can read and enter but not modify')
 268  $gacl->add_acl(
 269   array(
 270    'admin'=>array('drugs'),
 271    'encounters'=>array('coding'),
 272    'patients'=>array('appt')
 273   ),
 274   NULL, array($clin), NULL, NULL,
 275   1, 1, 'write', 'Things that clinicians can read and modify'
 276  );
 277      // xl('Things that clinicians can read and modify')
 278
 279  // Set permissions for front office staff.
 280  //
 281  $gacl->add_acl(
 282   array(
 283    'placeholder'=>array('filler')
 284   ),
 285   NULL, array($front), NULL, NULL,
 286   1, 1, 'addonly', 'Things that front office can read and enter but not modify'
 287  );
 288      // xl('Things that front office can read and enter but not modify')
 289  $gacl->add_acl(
 290   array(
 291    'patients'=>array('appt', 'demo', 'trans', 'notes')
 292   ),
 293   NULL, array($front), NULL, NULL,
 294   1, 1, 'write', 'Things that front office can read and modify'
 295  );
 296      // xl('Things that front office can read and modify')
 297
 298  // Set permissions for back office staff.
 299  //
 300  $gacl->add_acl(
 301   array(
 302    'placeholder'=>array('filler')
 303   ),
 304   NULL, array($back), NULL, NULL,
 305   1, 1, 'addonly', 'Things that back office can read and enter but not modify'
 306  );
 307      // xl('Things that back office can read and enter but not modify')
 308  $gacl->add_acl(
 309   array(
 310    'acct'=>array('bill', 'disc', 'eob', 'rep', 'rep_a'),
 311    'admin'=>array('practice', 'superbill'),
 312    'encounters'=>array('auth_a', 'coding_a', 'date_a'),
 313    'patients'=>array('appt', 'demo')
 314   ),
 315   NULL, array($back), NULL, NULL,
 316   1, 1, 'write', 'Things that back office can read and modify'
 317  );
 318      // xl('Things that back office can read and modify')
 319  // Set permissions for Emergency Login.
 320  //
 321  $gacl->add_acl(
 322   array(
 323    'acct'=>array('bill', 'disc', 'eob', 'rep', 'rep_a'),
 324    'admin'=>array('calendar', 'database', 'forms', 'practice', 'superbill', 'users', 'batchcom', 'language', 'super', 'drugs', 'acl'),
 325    'encounters'=>array('auth_a', 'coding_a', 'notes_a', 'date_a'),
 326    'lists'=>array('default','state','country','language','ethrace'),
 327    'patients'=>array('appt', 'demo', 'med', 'trans', 'docs', 'notes'),
 328    'sensitivities'=>array('normal', 'high'),
 329    'nationnotes'=>array('nn_configure'),
 330    'patientportal'=>array('portal')
 331   ),
 332   NULL, array($breakglass), NULL, NULL,
 333   1, 1, 'write', 'Emergency Login user can do anything'
 334  );
 335      // xl('Emergency Login user can do anything')
 336
 337 ?>
 338 <html>
 339 <head>
 340 <title>OpenEMR ACL Setup</title>
 341 <link rel=STYLESHEET href="interface/themes/style_blue.css">
 342 </head>
 343 <body>
 344 <b>OpenEMR ACL Setup</b>
 345 <br>
 346 All done configuring and installing access controls (php-GACL)!
 347 </body>
 348 </html>