ccda-scorecard | Source code for the C-CDA Scorecard

Dependencies This project requires a prerequisite ccda parser dependency. You can build the jar from here https://github.com/onc-healthit/ccda-parser
Database Install the latest version of Postgresql. Create a user called scorecarduser with password as scorecarduser and create a DB called site_scorecard Inside the site_scorecard DB run the following scripts to create scorecard_statistics table
Tomcat Inside the latest version of Tomcat, add the following snippet under the GlobalNamingResources tag in server.xml
Add the following snippet to context.xml
Rules The execution of rules in the Scorecard is controlled by an external configuration file, scorecardConfig.xml. The file controls what rules to execute. Please follow the steps below to configure scorecardConfig.xml Download scorecardConfig.xml which is available under src/main/resources By default scorecardConfig.xml is configured to run all of the Scorecard rules. Make the necessary changes to disable/enable any specific rules. /var/opt/sitenv/scorecard/config/scorecardConfig.xml is the default path configured in /src/main/resources/config.properties file. Make sure to create a default path for scorecardConfig.xml. If you decide to create different path than specified, update config.properties appropriately. If you have the project cloned, an easy custom path to use would be within the source itself, such as Drive:/Users/Username/git/thisProjectName/src/main/resources/
Continued instructions for using a pre-built release WAR: Download scorecard.xml from https://github.com/onc-healthit/ccda-scorecard/blob/master/src/main/resources/scorecard.xml. Update parameter values accordingly. scorecard.igConformanceCall - Indicates whether conformance check need to run or not. scorecard.certificatinResultsCall - Indicates whether certification Result check need to happen or not. scorecard.igConformanceUrl - URL for igConformanceCall scorecard.certificationResultsUrl - URL for certification result call. scorecard.configFile - Path for scorecardConfig.xml file which controls the execution of scorecard rules. This can be downloaded from https://github.com/onc-healthit/ccda-scorecard/blob/master/src/main/resources/scorecardConfig.xml Place a copy of scorecard.xml in $CATALINA_BASE/conf/[enginename]/[hostname]/. For example, ~/apache-tomcat-7.0.57/conf/Catalina/localhost Copy the WAR file to the Apache Tomcat webapps folder Start Tomcat
Below is an example of the scorecard.xml configuration which uses local referenceccdaservice URLs. We have used default port (8080) as reference. It can be changed to any port
Below is an example of the scorecard.xml configuration which uses CURES production referenceccdaservice URLs
Note: If using production, you will want to download the public cert from SITE and install it
Deploy the WAR file to Tomcat and start Tomcat. You should be able to see the Scorecard UI by navigating to this URL: http://localhost:8080/scorecard/ Note: 8080 is just an example of what your Tomcat port might be. Please replace 8080 with your actual port if it differs IF you've reached this point in the instructions, you have chosen to configure with scorecard.xml and are done.
Continued instructions if building the WAR yourself: From this point one can either follow the prior instructions for using a pre-built release WAR and build the WAR instead of downloading it before deploying, or, use the override options in src/main/java/org/sitenv/service/ccda/smartscorecard/configuration/ApplicationConfiguration.java, explained ahead:
Navigate to ApplicationConfiguration.java and set OVERRIDE_SCORECARD_XML_CONFIG to true
Decide which server you would like the service to contact for Reference C-CDA Validation. Whether it be a development server, production server, or a custom (such as local) specified server. One can also control the server of the Scorecard itself if desired. These outcomes are based on the Environment set
To use the production servers, set set ENV to Environment.PROD, and skip to final "Build the Scorecard project and deploy the WAR file" step public static final Environment ENV = Environment.PROD; Note: If using production, you will want to download the public cert from SITE and install it
For example, to use the development servers, set ENV to Environment.DEV, and "Build the Scorecard project and deploy the WAR file" step public static final Environment ENV = Environment.DEV;
To use a local or custom server, set ENV to Environment.LOCAL_OR_CUSTOM, and continue through the remaining instructions public static final Environment ENV = Environment.LOCAL_OR_CUSTOM; If the Scorecard is hosted on a different port than 8000, update the port in DEFAULT_LOCAL_SCORECARD_SERVER_URL to whatever Tomcat is configured to for your local Scorecard instance (8080 is a common default but default for this is 8000 since the Reference C-CDA Validator may already be configured on 8080). To use a custom non-local server, replace the entire URL as desired, however, there probably isn't a good reason to this for this particular URL public static final String DEFAULT_LOCAL_SCORECARD_SERVER_URL = "http://localhost:XXXX", If the Reference C-CDA Validator is hosted on a different port than 8080, update the port in DEFAULT_LOCAL_REF_VAL_SERVER_URL to whatever Tomcat is configured to for your local Reference C-CDA Validator instance. To use a custom non-local server, replace the entire URL as desired public static final String DEFAULT_LOCAL_REF_VAL_SERVER_URL = "http://localhost:XXXX",
Build the Scorecard project and deploy the WAR file to Tomcat and start Tomcat. You should be able to see the Scorecard UI by navigating to this URL: http://localhost:8000/scorecard/ Note: 8000 is just an example of what your Tomcat port might be. Please replace 8000 with your actual port if it differs. For example, it might be 8080. Note: If there is an issue with the maven build due to tests failing, plase post a bug on the Scorecard issues ticket and try building with the following to continue regardless: mvn clean install -D skipTests