Difference between revisions of "The OpenEMR API"
From OpenEMR Project Wiki
(add forms and notes API stubs and pointers.) |
(document acl_check.) |
||
| Line 15: | Line 15: | ||
! Function | ! Function | ||
! Use | ! Use | ||
! Accepts | |||
! Returns | ! Returns | ||
|- | |- | ||
| acl_check | | acl_check | ||
| check access | | Check if a user has a given type or types of access to an access control object | ||
| A category/subcategory describing a specific ACO, and optionally, a username to check, and type or types of access being requested | |||
| TRUE or FALSE if a single type of access is being checked, or an array of TRUE/FALSE values coresponding to the types of access requested | |||
|} | |} | ||
Revision as of 09:01, 6 December 2012
Overview
The OpenEMR API is divided into many modules, few of which have been documented.
There is presently a documentation project underway. please see OpenEMR API for an overview.
Core API
api.inc
The preferred method of including api.inc from your form is to use require_once. for instance: require_once($GLOBALS['srcdir'].'/api.inc');.
The following functions are common to use everywhere in OpenEMR:
| Function | Use | Accepts | Returns |
|---|---|---|---|
| acl_check | Check if a user has a given type or types of access to an access control object | A category/subcategory describing a specific ACO, and optionally, a username to check, and type or types of access being requested | TRUE or FALSE if a single type of access is being checked, or an array of TRUE/FALSE values coresponding to the types of access requested |
Forms API
The Forms API includes all of the functions required to create both per-encounter and non-encounter forms in the OpenEMR system. see The Forms API for more information.
Notes API
The Notes API manages non-medical notes, attached to a client's medical record. see The Notes API for more information.
