dump db version
[openemr.git] / ccdaservice / README.md
blob4cafcb85978e85dc69bf9652c69f43f65d2c68c1
1 # About
2 This module/service will provide the necessary template engine to create a Patient Summary CCD.
3 CCD's can be generated from Patient Portal Two or the Carecoordination Module.
4 ## Prepare
5 * If not already completed, you must install/initialize the CCM features by going to the Modules->Manage Modules top menu then click Unregistered tab and install the necessary components.
6 * The Carecoordination module setting for Mirth IP must be set to localhost. Menu item: Modules->Manage Modules click in Carecoordination Config, the settings tab. Also add any other appropriate settings.
7 * Ignore any errors that do not throw you back to command prompt when using npm install as some libs need to be compiled and is verbose about it.
8 ## Updating
9 Whenever there are new versions or updates, be sure to navigate into the ccdaservice directory and run:
10 - npm i --production
12 This will ensure the lastest libraries are installed.
13 ## Ubuntu Setup
14 If node is not already installed then do the following:
15 - cd ~
16 - apt-get remove --purge nodejs npm // Ensures clean install and will allow chance to cleanup.
17 - curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
18 - sudo apt-get install -y nodejs.
20 Navigate to: openemr/ccdaservice and run the following to install requires dependencies.
21 - sudo npm install --production
22 ## Windows Setup
23 * Download and install nodejs v9.4 for your windows version.
24 * Ensure system variable NODE_PATH is set i.e %USERPROFILE%\AppData\Roaming\npm\node_modules.
26 Navigate to: openemr/ccdaservice and run the following from an elevated PowerShell or CMD.exe (run as Administrator):
27 - npm install --global --production windows-build-tools
28 - npm install --production
29 ### Use
30 * CCDA service must be enabled in OpenEMR's menu Globals->Connectors.
31 * This service will automatically start on demand when required by OpenEMR.
32 ### Developing
33 * Note that these scripts run in strict mode so javascript will hold you very much accountable with how objects and variables are handled.
34 * For now, node modules are run local to service directory so all support dependecies are installed there.
35 ### Tools
36 * The nodejs ccda service now starts on demand.
37 #### License
38                 Copyright 2018 sjpadgett@gmail.com
39                 GNU GPL