Added ESign api and implemantion of ESign on forms and encounters
[openemr.git] / library / ESign / README
blobb1ed2161055126d1490c0bc113c4a99cf1ad5633
1 /**
2  * How to use and extend the ESign module
3  *
4  * Copyright (C) 2013 OEMR 501c3 www.oemr.org
5  *
6  * LICENSE: This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 3
9  * of the License, or (at your option) any later version.
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://opensource.org/licenses/gpl-license.php>;.
16  *
17  * @package OpenEMR
18  * @author  Ken Chapple <ken@mi-squared.com>
19  * @author  Medical Information Integration, LLC
20  * @link    http://www.open-emr.org
21  **/
23 In order to properly build an ESign implementation, developer must implement
24 the FactoryIF interface. This ensures that you create all of the necessary 
25 parts of an ESign implementation.
27 Developer must subclass Abstract_Controller for the routing to work properly.  
29 Developer should implement the IFactory interface so the ESign API can assemble
30 the ESign object using \ESign\Api::createEsign(FactoryIF)
32 Refer to the Form and Encounter implementations for examples on how to implement
33 the required interfaces.