Installing and Configuring the CDA Redaction Web Service

Overview

These are the instructions for deploying the CDA Redaction Web Service under the Glassfish application server.

 The CDA Web Service implements a "reduce" call which operates as follows:

  1. Accepts a list of files
  2. Looks through the list to determine is a consent document has been supplied
  3. Generates a redaction map based on supplied consent information
  4. Converts clinical documents to a single VMR
  5. Submits the VMR to the redaction OpenCDS service
  6. The redaction OpenCDS service classifies the VMR entries with a set of ILHIE redaction states
  7. Receives the response back from the redaction OpenCDS service
  8. Applies the consent map decisions with respect to the redaction OpenCDS service classifications
  9. Redacts the original clinical documents accordingly
  10. Returns the documents redacted to the caller 

Downloads

ProjectVersion Download
CDA Web Service1.0
CDA Web Service WSDLWSDL

Visit this project's build page for source build instructions.

Prerequisites

Consult with the Java SE and Glassfish documentation for installation guides.

The CDA Redaction Web Service does not work with Glassfish version 4.  Version 3.1.2 is the recommended version.

The OpenCDS call can be disabled if desired. See below for instructions.

See "// ENTRY POINT FOR ALTERNATIVE REDACTION CODE" in CdaServiceMGR.java for extending redaction processing.

Deploying Service

  1. Download or build the appropriate distribution
  2. (If not already performed during the build step) Disable/Enable OpenCDS calls and configure the OpenCDS Predicate/Reducer endpoint
    1. Extract the cda-ws-ear.ear file
    2. Extract the cda-ws-ejb.jar
    3. Edit the cda-ws-ejb.jar's META-INF/ejb-jar.xml file and set OPENCDS_ENABLED (true to utilize the OpenCDS Predicate-Reducer, false if you are only interested in CCD-to-vMR conversion and not the Predicate-Reducer). If you set OPENCDS_ENABLED to true, then also set OPENCDS_ENDPOINT to the URL of the Predicate-Reducer endpoint as configured in the Predicate/Reducer project.
    4. Archive the cda-ws-ejb.jar with the changed META-INF/ejb-jar.xml file
    5. Archive the cda-ws-ear.ear file with the changed cda-ws-ejb.jar file
  3. Copy the cda-ws-ear.ear file to the autodeploy directory of the Glassfish domain you have setup

Web Service Endpoint

The deployed endpoint will be:

    http://<domain hostname>:<domain port>/CdaService/Evaluate?wsdl