ccdaservice/README.md

   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 the Onsite Patient Portal or the Carecoordination Module.
   4
   5 Beside installing the C-CDA service, also included in this installation are two new services.
   6 - oe-schematron-service for validating QRDA and CDA type documents. Runs on port 6662.
   7 - oe-cqm-service is our CQM calculator service. Runs on port 6660
   8 ## Prepare
   9 * 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.
  10 * Add any appropriate settings like granting Access Control for the appropriate users. Menu item: `Modules->Manage Modules->Access Control->General->Care Coordination`.
  11 * Ensure all appropriate fields are populated in `Modules->Manage Modules Settings` tab such as Author, Primary Care Provider and so forth.
  12 ## Updating
  13 #### It's important to note when updating or re-installing to stop any existing node processes before implementing any changes to the service.
  14 Whenever there are new versions or updates, be sure to navigate into the ccdaservice directory and run:
  15 - `npm i --omit=dev`
  16 - `npm ci --omit=dev`
  17
  18 To ensure the lastest libraries are installed, node version changes or the package lock file is for a different build version then it is necessary to run `node install` to update dependencies to locked versions. Next, ensure the installation is renewed by running `node ci` (clean install) will ensure package dependencies are in sync and the node_modules directory is deleted and rebuilt.
  19
  20
  21 ## Ubuntu Setup
  22 * Latest version tested is node v18.13.0
  23
  24 If node is not already installed then do the following(Research the required installation for your environment):
  25 - `cd ~`
  26 - `apt-get remove --purge nodejs npm` // Ensures clean install and will allow chance to clean up.
  27 - `curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -`
  28 - `sudo apt-get install -y nodejs`
  29
  30 Navigate to: openemr/ccdaservice and run the following to install requires dependencies.
  31 - `sudo npm install --omit=dev`
  32 ## Windows Setup
  33 * Download and install nodejs for your Windows version.
  34   - Latest version tested is node v18.13.0
  35 * Ensure system variable NODE_PATH is set i.e. `%USERPROFILE%\AppData\Roaming\npm\node_modules`.
  36
  37 Navigate to: openemr/ccdaservice and run the following from an elevated PowerShell or CMD.exe (run as Administrator):
  38 - `npm install --global --omit=dev windows-build-tools` (Recommended) Though compiling libxmljs is no longer required, if for some reason your environment doesn't have download  compiled libxmljs2 binary available then npm will try to compile.
  39 - `npm install --omit=dev`
  40 ### Use
  41 * CCDA service must be enabled in OpenEMR's menu Globals->Connectors.
  42 * This service will automatically start on demand when required by OpenEMR.
  43 ### Developing
  44 * Note that these scripts run in strict mode so javascript will hold you very much accountable with how objects and variables are handled.
  45 * For now, node modules are run local to service directory so all support dependecies are installed there.
  46 ### Tools
  47 * The nodejs ccda service now starts on demand.
  48 #### License
  49             Copyright 2018-2023 sjpadgett@gmail.com
  50         https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3