Difference between revisions of "CouchDB Documents Module"

From OpenEMR Project Wiki
(Created page with "It is implemented in such a way that it is configurable whether to store the documents only in the disk or CouchDB. The CouchDB has got a good replication feature which will make...")
 
Line 1: Line 1:
It is implemented in such a way that it is configurable whether to store the documents only in the disk or CouchDB. The CouchDB has got a good replication feature which will make it easy to have a copy of documents in another system. Its also a good feature that CouchDB database is in consistent stage at every time. So a backup of CouchDB database can be taken at anytime by simply copying the database(CouchDB_root/var/lib/couchdb). We think this feature will be useful when the documents total size grows into GBs.
==Overview==
:'''This feature will be available in OpenEMR version 4.1.1.'''
:'''This feature should only be used by users with technical proficiency. Using this feature will require devising your own backup solution for your patient documents (the OpenEMR backup mechanisms do NOT backup documents within the CouchDB database).'''
::


Even though CouchDB is not officially supported in Windows an unofficial version is available here:
==Installing CouchDB==
===Windows===
:Even though CouchDB is not officially supported in Windows an unofficial version is available here:
::1) http://wiki.apache.org/couchdb/Installing_on_Windows
::2) https://github.com/downloads/dch/couchdb/setup-couchdb-1.1.1_js185_otp_R14B03+fix-win32-crypto.exe
===Linux===
:Linux version is available here:
::1) http://couchdb.apache.org/downloads.html


1) http://wiki.apache.org/couchdb/Installing_on_Windows
==Configuring OpenEMR to use CouchDB==
2) https://github.com/downloads/dch/couchdb/setup-couchdb-1.1.1_js185_otp_R14B03+fix-win32-crypto.exe
:1) Install the Apache CouchDB. (see above)
 
:2) If installation is success, normally it will be available on port number 5984.
Linux version is available here:
:3) It can be reached through the browser (http://localhost:5984).
 
:4) Basic administration utility will be available in http://localhost:5984/_utils.
1) http://couchdb.apache.org/downloads.html
:5) Initially it is running without username and password with all privileges. This can be reset by going to CouchDB\etc\couchdb\local.ini. In the lower side uncomment the
 
;admin = mysecretpassword . Put the desired password. On restarting the couchDB, this will take effect and also the password set will be hashed in the local.ini.
We have implemented this feature in Documents upload/download screen in Patient Demographics. This feature also can be used for storing the following files:
:6) Enable CouchDB from [[http://www.open-emr.org/wiki/index.php/Administration_Globals#Document_Storage_Method|Administration->Globals->Documents->Document Storage Method]].
 
1) Generated X12 file
2) Generated PDF file
3) ERA file
 
We will implement it after getting the feedback from the community.
 
Configuring:


1) Install the Apache CouchDB.
==Future Plans==
2) If installation is success, normally it will be available on port number 5984.
:This feature currently stores patient documents in the CouchDB. Also plan to support storing of the following documents in CouchDB in the future:
3) It can be reached through the browser (http://localhost:5984).
::1) Generated X12 file
4) Basic administration utility will be available in http://localhost:5984/_utils.
::2) Generated PDF file
5) Initially it is running without username and password with all privileges. This can be reset by going to CouchDB\etc\couchdb\local.ini. In the lower side uncomment the
::3) ERA file
;admin = mysecretpassword . Put the desired password. On restarting the couchDB, this will take effect and also the password set will be hashed in the local.ini.
6) Enable CouchDB from Administration->Globals->Documents->Document Storage Method.

Revision as of 22:15, 26 May 2012

Overview

This feature will be available in OpenEMR version 4.1.1.
This feature should only be used by users with technical proficiency. Using this feature will require devising your own backup solution for your patient documents (the OpenEMR backup mechanisms do NOT backup documents within the CouchDB database).

Installing CouchDB

Windows

Even though CouchDB is not officially supported in Windows an unofficial version is available here:
1) http://wiki.apache.org/couchdb/Installing_on_Windows
2) https://github.com/downloads/dch/couchdb/setup-couchdb-1.1.1_js185_otp_R14B03+fix-win32-crypto.exe

Linux

Linux version is available here:
1) http://couchdb.apache.org/downloads.html

Configuring OpenEMR to use CouchDB

1) Install the Apache CouchDB. (see above)
2) If installation is success, normally it will be available on port number 5984.
3) It can be reached through the browser (http://localhost:5984).
4) Basic administration utility will be available in http://localhost:5984/_utils.
5) Initially it is running without username and password with all privileges. This can be reset by going to CouchDB\etc\couchdb\local.ini. In the lower side uncomment the
admin = mysecretpassword . Put the desired password. On restarting the couchDB, this will take effect and also the password set will be hashed in the local.ini.
6) Enable CouchDB from [>Globals->Documents->Document Storage Method].

Future Plans

This feature currently stores patient documents in the CouchDB. Also plan to support storing of the following documents in CouchDB in the future:
1) Generated X12 file
2) Generated PDF file
3) ERA file
Retrieved from "https://www.open-emr.org/wiki/index.php?title=CouchDB_Documents_Module&oldid=10274"