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 install 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 * 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.
  13 ## Updating
  14 Whenever there are new versions or updates, be sure to navigate into the ccdaservice directory and run:
  15 - npm i --only=production
  16
  17 This will ensure the lastest libraries are installed.
  18 ## Ubuntu Setup
  19 * Latest version tested is node v16
  20
  21 If node is not already installed then do the following:
  22 - cd ~
  23 - apt-get remove --purge nodejs npm // Ensures clean install and will allow chance to cleanup.
  24 - curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
  25 - sudo apt-get install -y nodejs
  26
  27 Navigate to: openemr/ccdaservice and run the following to install requires dependencies.
  28 - sudo npm install --only=production
  29 ## Windows Setup
  30 * Download and install nodejs for your windows version.
  31   - Latest version tested is node v16.13.1
  32 * Ensure system variable NODE_PATH is set i.e %USERPROFILE%\AppData\Roaming\npm\node_modules.
  33
  34 Navigate to: openemr/ccdaservice and run the following from an elevated PowerShell or CMD.exe (run as Administrator):
  35 - npm install --global --only=production windows-build-tools. (Deprecated) No longer required unless for some reason your environment doesn't have libxmljs binary available.
  36 - npm install --only=production
  37 ### Use
  38 * CCDA service must be enabled in OpenEMR's menu Globals->Connectors.
  39 * This service will automatically start on demand when required by OpenEMR.
  40 ### Developing
  41 * Note that these scripts run in strict mode so javascript will hold you very much accountable with how objects and variables are handled.
  42 * For now, node modules are run local to service directory so all support dependecies are installed there.
  43 ### Tools
  44 * The nodejs ccda service now starts on demand.
  45 #### License
  46             Copyright 2018-2022 sjpadgett@gmail.com
  47         https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3