Documentation/3rd_Party_Form_API.txt

   1 3rd Party Form API
   2 OpenEMR suite v2.0
   3 doc revision 2
   4
   5 Pennington Firm
   6 PennFirm.com
   7 San Diego, California
   8 888-480-5050
   9
  10
  11  ******* Introduction *******
  12
  13 OpenEMR is more than a simple EMR suite, it is a modular platform that allows for customized modifications to meet specific needs.
  14
  15 To create a set of patient encounter forms for use with OpenEMR, at least a limited knowledge of the PHP scripting language and the MySQL syntax is needed. The script _must_ be stored in the interface/forms/your_script_name/ directory, with at least these four files:
  16         new.php         <-- will be acessed for new data entry
  17         view.php        <-- will be used to view your form
  18         print.php       <-- should be used to print your form
  19         SQL.php         <-- contains sql table creation scripts
  20
  21  ******* Initialization *******
  22
  23 To initialize the 3rd party php library (from interface/forms/your_script_name/myfile.php):
  24         include_once("../../../library/api.inc");
  25
  26
  27  ******* Functions *******
  28
  29 --->>   formHeader("my form title name here")
  30         This is the suggested title header for forms. It maintains the style used by the rest of the suite for consistency.
  31
  32
  33 --->>   formFooter()
  34         Our suggested footer.
  35
  36
  37 --->>   formSubmit("my_table", $array_to_import, "0")
  38         Submit will submit your array into the database, in the table created during your script install process.  The array to import should be a single dimension such as the following:
  39
  40                 $myArray['column_name1']  = 'my column1 value';
  41
  42 The third argument to formSubmit() is a url to redirect to after the data from a form has been saved.  If you set this to "0" (its default) then it will forward back to "openemr/interface/patient_file/encounter/patient_encounter.php". This is the preferred operation, since users expect to be taken back to the Patient Encounter screen after saving a new form.
  43
  44
  45 --->>   formFetch("my_table", 'record id', 'columns wanted', 'activity state')
  46         This function will retrieve one record of data.  The record id must be a numeric entry in the database.  The columns wanted defaults to "*", or all columns. If only a few columns are needed, setting columns wanted manually as follows: "id, activity, column-x" for example - usually id and activity are needed by the form, so it's a good idea to include those.  The activity state controls the visibility, or activity, of the records - you can view normal records with it set to "1" (its default) or view deleted records with "0" or both with "all".
  47
  48
  49 --->>   formGetIds("my_table", 'wanted columns', 'limit', 'start point',
  50 'activity state')
  51         This function retrieves a set of ids ordered by date descending from the most recent.  "wanted columns" will once again have a default of "*".  Limit defaults to "all" with returns unlimited results.  Placing a number in its place with limit the results.  'start point' is a starting point or offset for the limited results, and 'activity state' acts as stated above.
  52
  53
  54 --->>   formDisappear("my_table", 'record id')
  55         This effectively sets the activity state to 0, causing the records to be invisible during normal suite usage. This is equivalent to letting the user delete a record. However, for maximum legal compliance, all data entered into OpenEMR should be saved. Instead of deleting records then, we merely make them invisible to normal user interface operations.
  56
  57
  58 --->>   formReappear("my_table", 'record id)
  59         This function will reverse the effects of formDisappear, cause the record to once again be active. Use this if you allow the user to modify the active or inactive flag.