Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Draft Proposal - 2/28/2014

Overview

One of the features of interest for a future version of OpenCDS is the ability to "hot deploy" new knowledge bases (e.g. - codes, concepts, drools rules, and supporting data) as needed without having to restart OpenCDS for the changes to take place. ICE, an application based on OpenCDS, envisions the following automated knowledge deployment capabilities within OpenCDS to support the operation of ICE. However, we also believe that the proposed functionality is generic and would benefit any OpenCDS-based services. For purposes of this discussion document, we will talk about the scenarios with respect to ICE for complete understanding of the requirements, and then abstract the requirements afterwards.

  • ICE is immunization forecasting software; the customizable rules are written in software called the CDS Administration Tool (CAT).
  • CAT manages - and can deploy to OpenCDS - the following artifacts, all of which are files stored in the OpenCDS knowledge-repository-data file structure:
    • OpenCDS concepts    (resourceAttributes/supportedConceptsConfigFile.xml)
    • Code to OpenCDS concepts mappings    (conceptMappingSpecifications/manualMappings)
    • Knowledge modules; Scoping Entity ID/Business ID/Version    (resourceAttributes/knowledgeModules.xml)
    • Code System Code List    (resourceAttributes/OpenCDSCodeSystems.xml)
    • Drools Artifacts (DSLs, DRLs, DSLRs)
  • CAT also manages the following information that are represented in OpenCDS indirectly or in memory):
    • Supporting Data    (in-memory data that is cached by a knowledgeModule, such as immunization schedule parameters)
    • Concept Determination Method (not directly deployable to OpenCDS but contained in code->concept mapping files)

Supporting data is any kind of data that is cached in instances of Java classes by the knowledgeModule during runtime operation. OpenCDS has the infrastructure to support the cached data (see Deployment Scenarios below).

  • For ICE, most of the cached data is stored in various Map classes that are accessed by the rules. Examples include table of static data related to vaccine, etc., and static values such as recommended ages and intervals. The cached data is not modified during execution and remains in memory for as long as the knowledge module is in memory by OpenCDS.

Deployment Use Case Scenarios

To start, I propose supporting the following "hot" deployment scenarios to OpenCDS. For those functions at the level of a knowledge module, the knowledgeModule is defined by its associated <scoping-entity>/<businessId>/<version>. That is, the OpenCDS web service should have the following capabilities for deploying knowledge to OpenCDS. 

Note: For each of the below, we talk about the OpenCDS capability with respect to its XML representation in OpenCDS v1. However, this list is not meant to describe the solution via the XML - just the functionality. (e.g. - if the data in these files are represented in some other way in future versions of OpenCDS, the functionality requested is the same.)

    1. Code Systems
      1. Replace entire OpenCDSCodeSystems.xml file.  (Q: Is this still used somehow? We are using code systems not specified in this file and all still seems to work ok. If not, nevermind.)
    2. Concepts and Codes
      1. supportedConceptsConfigFile.xml:
      2. FOR DEPLOYMENT: Replace the entire supportedConceptsConfigFile.xml file
      3. FOR DEPLOYMENT: Add/Update/Delete individual entries in the supportedConceptsConfig.xml file
      4. Concept Mapping Files
      5. FOR DEPLOYMENT: Add/Replace all mapping files in the conceptMappingSpecifications/manualMappings or conceptMappingSpecifications/autoGeneratedMappings directory.
    3. BPMNs/DSLs/DRLs/DSLRs
      1. FOR DEPLOYMENT: Replace all DSLs/DRLs/DSLRs associated with a specified knowledgeModule at once
    4. Supporting Data. (The supporting data will be supplied to OpenCDS as an XML (or some other type of) document, and it is up to the knowledgeModule implementer to write the necessary routines to read in the document contents into its custom Java instance objects.) 
      1. FOR DEPLOYMENT: Replace the entire contents of the Supporting Data into the necessary persistence mechanism - likely files, as with artifacts - associated with a specified knowledgeModule at once. 
      2. FOR RUNTIME: Provide the knowledgeModule author a routine for adding the in-memory contents to the global OpenCDS cache, which associates one-and-only-one in-memory supporting data object with a knowledgeModule
      3. FOR RUNTIME: Provide the knowledgeModule author a routine for removing the in-memory contents for a knowledgeModule from the global OpenCDS cache
      4. FOR RUNTIME: Provide the knowledgeModule author a routine for checking if in-memory contents exists for a knowledgeModule from the global OpenCDS cache

    5. Initial functionality will not support the automated modifications to the knowledgeModule.xml or openCdsExeuctionEngines.xml files; these files can continue to be modified manually as they will rarely change. 

Revisions to OpenCDS Concept Determination Method

Description of Functionality

Initial Document Here.

The initial document (authored by Dave Shields) with some proposed designs for new features for Concept Determination Method handling in OpenCDS is in the link above. The proposed functionality is a simplification of what is in the document.

ICE would like to support the following functionality now - configurable at the knowledge module level:

  1. For each knowledgeModule, provide a way to represent in knowledgeModules.xml,indicate the Concept Determination Methods (CDMs) of interest for that particular knowledgeModule. 
    1. If no CDM is specified in the knowledgeModule.xml, mappings for all CDMs take place. (This is the Current OpenCDS behavior).
  2. If specific CDMs are specified to be applied, then only apply mappings for the specified CDMs for the knowledge module during runtime. (That is, for each runtime request, only mappings for those CDMs listed for the knowledge module will be mapped to a concept and placed on the concept/fact list.)
  3. If specific CDMs are listed for a knowledge module, one primary CDM must be specified. Primary CDMs are are always mapped (except as indicated by additive or replacement CDMs).
  4. Additive CDMs can be specified for the knowledge module. Additive CDMs ALSO get mapped in addition to the primary CDM. 
  5. Replacement CDMs can be specified for the knowledge module (if any) which will replace any mappings from the primary CDM. So if the primary CDM for a code maps to one concept but the replacement CDM maps to a different concept for that code, the concept associated with the replacement CDM is chosen.   (Note: Need to work out what to do if more than one replacement CDM is specified, or only permit one replacement CDM per knowledge module.) 

Examples

Example definition of CDMs for a knowledge module

The below example knowledgeModules.xml entry shows three way to specify the CDMs of interest for the knowledge module for illustrative purposes only. Only concepts with codes belonging to these CDMs would be put on the Concept List / Fact List.

(1)

<kmMetadata>
    <identifier scopingEntityId="org.nyc.cir" businessId="ICE" version="1.0.1"/>
    <purpose language="en">New York City Immunization Calculation Engine (ICE)</purpose>
    <explanation language="en">String</explanation>
    <executionEngine>gov.nyc.health.ice.service.ICEDecisionEngineDSS55EvaluationAdapter</executionEngine>
    <dataModel>org.opencds.vmr^VMR^1.0</dataModel>
    <knowledgeModulePrimaryProcessName>PrimaryProcess</knowledgeModulePrimaryProcessName>
</kmMetadata>

 

(2)

<kmMetadata>
    <identifier scopingEntityId="org.nyc.cir" businessId="ICE" version="1.0.1"/>
    <purpose language="en">New York City Immunization Calculation Engine (ICE)</purpose>
    <explanation language="en">String</explanation>
    <executionEngine>gov.nyc.health.ice.service.ICEDecisionEngineDSS55EvaluationAdapter</executionEngine>
    <dataModel>org.opencds.vmr^VMR^1.0</dataModel>
    <knowledgeModulePrimaryProcessName>PrimaryProcess</knowledgeModulePrimaryProcessName>
    <conceptDeterminationMethods>
        <primary>NYCICESchedule-Primary</primary>
    </conceptDeterminationMethods>
</kmMetadata>

 

(3)

<kmMetadata>
    <identifier scopingEntityId="org.nyc.cir" businessId="ICE" version="1.0.1"/>
    <purpose language="en">New York City Immunization Calculation Engine (ICE)</purpose>
    <explanation language="en">String</explanation>
    <executionEngine>gov.nyc.health.ice.service.ICEDecisionEngineDSS55EvaluationAdapter</executionEngine>
    <dataModel>org.opencds.vmr^VMR^1.0</dataModel>
    <knowledgeModulePrimaryProcessName>PrimaryProcess</knowledgeModulePrimaryProcessName>
    <conceptDeterminationMethods>
        <primary>NYCICESchedule-Primary</primary>
        <additive>NYCICESchedule-Schools</additive>
        <additive>NYCICESchedule-NewFeature</additive>
        <replacing>NYCICESchedule-FIX</replacing>
    </conceptDeterminationMethods>
</kmMetadata>


Examples of multiple CDMs in a knowledge modules

Below are 4 mapping files. The first one mapping files uses the primary CDM "NYCICESchedule-Primary". The next 3 mapping files use a different CDM, "NYCICESchedule-FIX", denoted as a "replacing" CDM above. 

 

<?xml version="1.0" encoding="UTF-8"?>
<OpenCdsConceptMappingSpecificationFile>
 <specificationNotes>Created manually.</specificationNotes>
 <openCdsConcept code="MMR" displayName="MMR"></openCdsConcept>
 <conceptDeterminationMethod code="NYCICESchedule-Primary" displayName="Best available OpenCDS concept determination method"></conceptDeterminationMethod>
 <membersForCodeSystem codeSystem="2.16.840.1.113883.12.292" codeSystemName="Vaccines administered (CVX)">
 <CD code="03" displayName="MMR" />
 </membersForCodeSystem>
</OpenCdsConceptMappingSpecificationFile>
<OpenCdsConceptMappingSpecificationFile>
 <specificationNotes>Created manually.</specificationNotes>
 <openCdsConcept code="Measles" displayName="Measles"></openCdsConcept>
 <conceptDeterminationMethod code="NYCICESchedule-FIX" displayName="Best available OpenCDS concept determination method"></conceptDeterminationMethod>
 <membersForCodeSystem codeSystem="2.16.840.1.113883.12.292" codeSystemName="Vaccines administered (CVX)">
 <CD code="03" displayName="MMR" />
 </membersForCodeSystem>
</OpenCdsConceptMappingSpecificationFile>
<OpenCdsConceptMappingSpecificationFile>
 <specificationNotes>Created manually.</specificationNotes>
 <openCdsConcept code="Mumps" displayName="Mumps"></openCdsConcept>
 <conceptDeterminationMethod code="NYCICESchedule-FIX" displayName="Best available OpenCDS concept determination method"></conceptDeterminationMethod>
 <membersForCodeSystem codeSystem="2.16.840.1.113883.12.292" codeSystemName="Vaccines administered (CVX)">
 <CD code="03" displayName="MMR" />
 </membersForCodeSystem>
</OpenCdsConceptMappingSpecificationFile>
<OpenCdsConceptMappingSpecificationFile>
 <specificationNotes>Created manually.</specificationNotes>
 <openCdsConcept code="Rubella" displayName="Rubella"></openCdsConcept>
 <conceptDeterminationMethod code="NYCICESchedule-FIX" displayName="Best available OpenCDS concept determination method"></conceptDeterminationMethod>
 <membersForCodeSystem codeSystem="2.16.840.1.113883.12.292" codeSystemName="Vaccines administered (CVX)">
 <CD code="03" displayName="MMR" />
 </membersForCodeSystem>
</OpenCdsConceptMappingSpecificationFile>

 

 

  • No labels