Versions Compared

Old Version 3

changes.mady.by.user Phillip Warner

Saved on

compared with

New Version Current

changes.mady.by.user David Shields

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

(Needs validation) 

 

...

 

Table of Contents

Exporting a Knowledge Module to OpenCDS is currently a manual process.

...

  1. The opencds-decision-support-service war (v1.1.5), or
  2. Specified in the OpenCDS base properties file:
    1. $HOME/.opencds/opencds.properties
    2. %HOME%\.opencds\opencds.properties on Windows (deployed as a user)
    3. C:\.opencds\opencds.properties (deployed as a service)
    4. As specified as a server flag (see example configuration for details–TBD)

 

Anchor
ConfigurationOverview
ConfigurationOverview
Configuration Overview

The current configuration requires the following folder hierarchy:

  • conceptMappingSpecifications
    • autoGeneratedMappings
      • folder containing auto-generated concept mappings
    • manualMappings
      • folder containing manually created concept mappings
  • knowledgeModules
    • folder containing knowledge modules exported from Guvnor (or other systems that generate knowledge packages)
  • resourceAttributes
    • folder containing OpenCDS configuration resources
    • knowledgeModules.xml
      • used for knowledge module metadata, for knowledge modules contained in the knowledgeModules folder (see above)
    • openCDSCodeSystems.xml
      • used to define the Code Systems supported by OpenCDS
    • openCdsExecutionEngines.xml
      • used to define which inferencing engines should be available to/used by OpenCDS
      • This file should not need to be modified except in certain cases.
    • semanticSignifiers.xml
      • Used to define which vMR versions are supported by the system.
      • This file should not need to be modified except in certain cases.
    • supportedConceptsConfigFile.xml
      • Used to indicate the supported concept for each OpenCDS Concept Type. (Unused during runtime.)

Anchor
ConceptMappings
ConceptMappings
Concept Mappings

Concept mappings group ConceptDeterminationMethods with a Code System and the Codes within that Code System.  Three examples are provided in the snippets below.

...

Code Block
languagexml
titleManual Concept Mapping Example
linenumberstrue
<openCdsConceptMappingSpecificationFile>
  <specificationNotes>Codes from Appendix A.1 ICD-9-CM Code Table 5.22 from the Specifications Manual for National Hospital Inpatient Quality Measures
    Discharges 01-01-13 (1Q13) through 12-31-13 (4Q13)</specificationNotes>
  <openCdsConcept code='C502' displayName='Elective Hip Replacement' />
  <conceptDeterminationMethod code='C494' displayName='NHIQM 2013' />
  <membersForCodeSystem codeSystem='2.16.840.1.113883.6.104' displayName='ICD9CM procedures'>
    <CD code='00.70' displayName='Revision of hip replacement, both acetabular and femoral components' />
    <CD code='00.71' displayName='Revision of hip replacement, acetabular component' />
    <CD code='00.72' displayName='Revision of hip replacement, femoral component' />
    <CD code='00.73' displayName='Revision of hip replacement, acetabular liner and/or femoral head only' />
    <CD code='00.77' displayName='Hip bearing surface, ceramic-on-polyethylene' />
    <CD code='00.85' displayName='Resurfacing hip, total, acetabulum and femoral head' />
    <CD code='00.86' displayName='Resurfacing hip, partial, femoral head' />
    <CD code='00.87' displayName='Resurfacing hip, partial, acetabulum' />
    <CD code='81.51' displayName='Total hip replacement' />
    <CD code='81.52' displayName='Partial hip replacement' />
    <CD code='81.53' displayName='Revision of hip replacement, not otherwise specified' />
  </membersForCodeSystem>
</openCdsConceptMappingSpecificationFile>

 

Resource Attributes

Anchor
CodeSystems
CodeSystems
OpenCDS Code Systems

Code Block
languagexml
titleExample: openCDSCodeSystems.xml
linenumberstrue
<tcs:codeSystems xsi:schemaLocation="org.opencds.term.codeSystem ..\schema\OpenCDSCodeSystems.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tcs="org.opencds.term.codeSystem">
  <codeSystem codeSystemOID="2.16.840.1.113883.6.12" codeSystemDisplayName="CPT4" apelonNamespaceName="CPT" isApelonOntylog="false" />
  …
</tcs:codeSystems>

Anchor
SupportedConcepts
SupportedConcepts
Supported Concepts

Code Block
languagexml
titleExample: supportedConceptsConfigFile.xml
linenumberstrue
<SupportedOpenCdsConceptsConfigFile>
  <supportedConceptsForType>
    <openCdsConceptType>conceptDeterminationMethod</openCdsConceptType>
    <supportedOpenCdsConcept>
      <openCdsConcept code="C265" displayName="UUHC"></openCdsConcept>
    </supportedOpenCdsConcept>
    …
  </supportedConceptsForType>
  <supportedConceptsForType>
    <openCdsConceptType>gender</openCdsConceptType>
    <supportedOpenCdsConcept>
      <openCdsConcept code="C404" displayName="Other or Unknown Gender"></openCdsConcept>
    </supportedOpenCdsConcept>
    …
  </supportedConceptsForType>
  …
</SupportedOpenCdsConceptsConfigFile>

Anchor
KnowledgeModules
KnowledgeModules
Knowledge Modules

Code Block
languagexml
titleExample: knowledgeModules.xml
linenumberstrue
<kmm:kmMetadataList xsi:schemaLocation="org.opencds.km.metadata.v1_0 ..\schema\OmgDssKmMetadata.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:kmm="org.opencds.km.metadata.v1_0">
  <kmMetadata>
    <identifier scopingEntityId="edu.utah" businessId="SCIP_VTE_2" version="2014.0.0" />
    <purpose language="en">SCIP VTE Rule</purpose>
    <explanation language="en">some explanation of the KM</explanation>
    <executionEngine>org.opencds.service.drools.v55.DroolsAdapter</executionEngine>
    <dataModel>org.opencds.vmr^VMR^1.0</dataModel>
    <knowledgeModulePrimaryProcessName>PrimaryProcess</knowledgeModulePrimaryProcessName>
  </kmMetadata>
  …
</kmm:kmMetadataList>

...

All other fields (with the exception of purpose and explanation, should remain the same.

 

Export/Import Process

The steps for importing a Knowledge Module into OpenCDS are are as follows:

  1. If you are using new concepts, add them to the relevant folder within the conceptMappingsSpecifications folder (see Concept Mappings).
  2. If your Knowledge Module supports one or more Code Systems that are not currently specified in OpenCDS configuration, add them to openCDSCodeSystems.xml (see OpenCDS Code Systems).If your Knowledge Module supports one or more concept types that are not currently specified in OpenCDS configuration, add them to supportedConceptsConfigFile.xml (see Supported Concepts).
  3. New Knowledge Module
    1. If Export the knowledge module is new, export it from Guvnor and place the downloaded binary package into the knowledgeModules folder (see Configuration Overview).
    2. Add an entry for the new knowledge module in knowledgeModules.xml (see Knowledge Modules).
  4. Replacing an Existing Knowledge Module
    1. If Export the knowledge module already exists and you want to replace it with changes made in Guvnor, you may replace from Guvnor and replace the existing module; be sure , ensuring the file name is consistent with the previous instance (see Configuration Overview).
  5. Restart OpenCDS (v1.1.5 and earlier).

...