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  include_once('library/acl.inc');
  31
  32  if (! $phpgacl_location) die("You must first set up library/acl.inc to use phpGACL!");
  33
  34  include_once("$phpgacl_location/gacl_api.class.php");
  35
  36  $gacl = new gacl_api();
  37
  38  // Create the ACO sections.  Every ACO must have a section.
  39  //
  40  if ($gacl->add_object_section('Accounting', 'acct', 10, 0, 'ACO') === FALSE) {
  41   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>";
  42   return;
  43  }
  44  $gacl->add_object_section('Administration', 'admin'        , 10, 0, 'ACO');
  45  $gacl->add_object_section('Encounters'    , 'encounters'   , 10, 0, 'ACO');
  46  $gacl->add_object_section('Patients'      , 'patients'     , 10, 0, 'ACO');
  47  $gacl->add_object_section('Squads'        , 'squads'       , 10, 0, 'ACO');
  48  $gacl->add_object_section('Sensitivities' , 'sensitivities', 10, 0, 'ACO');
  49
  50  // Create Accounting ACOs.
  51  //
  52  $gacl->add_object('acct', 'Billing (write optional)'           , 'bill' , 10, 0, 'ACO');
  53  $gacl->add_object('acct', 'Price Discounting'                  , 'disc' , 10, 0, 'ACO');
  54  $gacl->add_object('acct', 'EOB Data Entry'                     , 'eob'  , 10, 0, 'ACO');
  55  $gacl->add_object('acct', 'Financial Reporting - my encounters', 'rep'  , 10, 0, 'ACO');
  56  $gacl->add_object('acct', 'Financial Reporting - anything'     , 'rep_a', 10, 0, 'ACO');
  57
  58  // Create Administration ACOs.
  59  //
  60  $gacl->add_object('admin', 'Superuser'                       , 'super'    , 10, 0, 'ACO');
  61  $gacl->add_object('admin', 'Calendar Settings'               , 'calendar' , 10, 0, 'ACO');
  62  $gacl->add_object('admin', 'Database Reporting'              , 'database' , 10, 0, 'ACO');
  63  $gacl->add_object('admin', 'Forms Administration'            , 'forms'    , 10, 0, 'ACO');
  64  $gacl->add_object('admin', 'Practice Settings'               , 'practice' , 10, 0, 'ACO');
  65  $gacl->add_object('admin', 'Superbill Codes Administration'  , 'superbill', 10, 0, 'ACO');
  66  $gacl->add_object('admin', 'Users/Groups/Logs Administration', 'users'    , 10, 0, 'ACO');
  67  $gacl->add_object('admin', 'Batch Communication Tool'        , 'batchcom' , 10, 0, 'ACO');
  68  $gacl->add_object('admin', 'Language Interface Tool'         , 'language' , 10, 0, 'ACO');
  69  $gacl->add_object('admin', 'Pharmacy Dispensary'             , 'drugs'    , 10, 0, 'ACO');
  70  $gacl->add_object('admin', 'ACL Administration'              , 'acl'      , 10, 0, 'ACO');
  71
  72  // Create ACOs for encounters.
  73  //
  74  $gacl->add_object('encounters', 'Authorize - my encounters'                        , 'auth'    , 10, 0, 'ACO');
  75  $gacl->add_object('encounters', 'Authorize - any encounters'                       , 'auth_a'  , 10, 0, 'ACO');
  76  $gacl->add_object('encounters', 'Coding - my encounters (write,wsome optional)'    , 'coding'  , 10, 0, 'ACO');
  77  $gacl->add_object('encounters', 'Coding - any encounters (write,wsome optional)'   , 'coding_a', 10, 0, 'ACO');
  78  $gacl->add_object('encounters', 'Notes - my encounters (write,addonly optional)'   , 'notes'   , 10, 0, 'ACO');
  79  $gacl->add_object('encounters', 'Notes - any encounters (write,addonly optional)'  , 'notes_a' , 10, 0, 'ACO');
  80  $gacl->add_object('encounters', 'Fix encounter dates - any encounters'             , 'date_a'  , 10, 0, 'ACO');
  81  $gacl->add_object('encounters', 'Less-private information (write,addonly optional)', 'relaxed' , 10, 0, 'ACO');
  82
  83  // Create ACOs for patients.
  84  //
  85  $gacl->add_object('patients', 'Appointments (write optional)'           , 'appt' , 10, 0, 'ACO');
  86  $gacl->add_object('patients', 'Demographics (write,addonly optional)'   , 'demo' , 10, 0, 'ACO');
  87  $gacl->add_object('patients', 'Medical/History (write,addonly optional)', 'med'  , 10, 0, 'ACO');
  88  $gacl->add_object('patients', 'Transactions (write optional)'           , 'trans', 10, 0, 'ACO');
  89  $gacl->add_object('patients', 'Documents (write,addonly optional)'      , 'docs' , 10, 0, 'ACO');
  90  $gacl->add_object('patients', 'Patient Notes (write,addonly optional)'  , 'notes', 10, 0, 'ACO');
  91
  92  // Create ACOs for sensitivities.
  93  //
  94  $gacl->add_object('sensitivities', 'Normal', 'normal', 10, 0, 'ACO');
  95  $gacl->add_object('sensitivities', 'High'  , 'high'  , 20, 0, 'ACO');
  96
  97  // Create ARO groups.
  98  //
  99  $users = $gacl->add_group('users', 'OpenEMR Users' , 0     , 'ARO');
 100  $admin = $gacl->add_group('admin', 'Administrators', $users, 'ARO');
 101  $clin  = $gacl->add_group('clin' , 'Clinicians'    , $users, 'ARO');
 102  $doc   = $gacl->add_group('doc'  , 'Physicians'    , $users, 'ARO');
 103  $front = $gacl->add_group('front', 'Front Office'  , $users, 'ARO');
 104  $back  = $gacl->add_group('back' , 'Accounting'    , $users, 'ARO');
 105
 106  // Create a Users section for the AROs (humans).
 107  //
 108  $gacl->add_object_section('Users', 'users', 10, 0, 'ARO');
 109
 110  // Create the Administrator in the above-created "users" section
 111  // and add him/her to the above-created "admin" group.
 112  //
 113  $gacl->add_object('users', 'Administrator', 'admin' ,10, 0, 'ARO');
 114  $gacl->add_group_object($admin, 'users', 'admin', 'ARO');
 115
 116  // Set permissions for administrators.
 117  //
 118  $gacl->add_acl(
 119   array(
 120    'acct'=>array('bill', 'disc', 'eob', 'rep', 'rep_a'),
 121    'admin'=>array('calendar', 'database', 'forms', 'practice', 'superbill', 'users', 'batchcom', 'language', 'super', 'drugs', 'acl'),
 122    'encounters'=>array('auth_a', 'coding_a', 'notes_a', 'date_a'),
 123    'patients'=>array('appt', 'demo', 'med', 'trans', 'docs', 'notes'),
 124    'sensitivities'=>array('normal', 'high')
 125   ),
 126   NULL, array($admin), NULL, NULL,
 127   1, 1, 'write', 'Administrators can do anything'
 128  );
 129
 130  // Set permissions for physicians.
 131  //
 132  $gacl->add_acl(
 133   array(
 134    'acct'=>array('disc', 'rep'),
 135    'admin'=>array('drugs'),
 136    'encounters'=>array('auth_a', 'coding_a', 'notes_a', 'date_a'),
 137    'patients'=>array('appt', 'demo', 'med', 'trans', 'docs', 'notes'),
 138    'sensitivities'=>array('normal', 'high')
 139   ),
 140   NULL, array($doc), NULL, NULL,
 141   1, 1, 'write', 'Things that physicians can read and modify'
 142  );
 143
 144  // Set permissions for clinicians.
 145  //
 146  $gacl->add_acl(
 147   array(
 148    'encounters'=>array('notes', 'relaxed'),
 149    'patients'=>array('demo', 'med', 'docs', 'notes'),
 150    'sensitivities'=>array('normal')
 151   ),
 152   NULL, array($clin), NULL, NULL,
 153   1, 1, 'addonly', 'Things that clinicians can read and enter but not modify'
 154  );
 155  $gacl->add_acl(
 156   array(
 157    'admin'=>array('drugs'),
 158    'encounters'=>array('coding'),
 159    'patients'=>array('appt')
 160   ),
 161   NULL, array($clin), NULL, NULL,
 162   1, 1, 'write', 'Things that clinicians can read and modify'
 163  );
 164
 165  // Set permissions for front office staff.
 166  //
 167  $gacl->add_acl(
 168   array(
 169    'patients'=>array('appt', 'demo', 'trans', 'notes')
 170   ),
 171   NULL, array($front), NULL, NULL,
 172   1, 1, 'write', 'Things that front office can read and modify'
 173  );
 174
 175  // Set permissions for back office staff.
 176  //
 177  $gacl->add_acl(
 178   array(
 179    'acct'=>array('bill', 'disc', 'eob', 'rep', 'rep_a'),
 180    'admin'=>array('practice', 'superbill'),
 181    'encounters'=>array('auth_a', 'coding_a', 'date_a'),
 182    'patients'=>array('appt', 'demo')
 183   ),
 184   NULL, array($back), NULL, NULL,
 185   1, 1, 'write', 'Things that back office can read and modify'
 186  );
 187
 188 ?>
 189 <html>
 190 <head>
 191 <title>OpenEMR ACL Setup</title>
 192 <link rel=STYLESHEET href="interface/themes/style_blue.css">
 193 </head>
 194 <body>
 195 <b>OpenEMR ACL Setup</b>
 196 <br>
 197 All done configuring and installing access controls (php-GACL)!
 198 </body>
 199 </html>