ajflynn / mopen-opioid-collection

This is a collection of KOs for KGrid that can be used to identify and report on certain features of opioid prescribing

Michigan OPEN Opioid-related Knowledge Object (KO) Collection

This is a collection of KOs for KGrid that can be used to identify and report on certain features of opioid prescribing. Each KO in this collection uses patient prescription data for its input and provides information about patient prescriptions as its output.

Table of Contents

• Getting Started
• Knowledge Object Collection
  1. Opioid Use Detector
  2. Opioid and Benzodiazepine Detector
  3. Respiratory Depression Risk Indicator
• Install the Michigan OPEN Opioid-related KO Collection
• Common Issues/Problems
• Roadmap

Getting Started

These instructions will allow you to test drive one or more of the KOs in the MOpen Opioid-related Knowledge Object Collection on our sandbox at Herokuapp.com here. To check if the sandbox is working, you can click here: Heroku KGrid Activator.

Below in this documentation, find each KO's API documentation in the OpenAPI 3.0 specification format. By clicking on the API Documentation link for each KO, the API documentation will be displayed in a Swagger UI tool. Utilizing the example curl or the Swagger UI tool you can test out the interation using each KO.

Knowledge Object Collection

1️⃣ Opioid Use Detector

This KO scans a patient's medication regimen, which is presented to the KO as a list of RxNorm Semantic Clinical Drug codes, for the presence of an opioid prescription. This KO has many potential uses, including one use as a filtering or screening mechanism when applied in the context of health information exchange.

Example API Usage with curl

curl -X POST \
  http://kgrid-activator.herokuapp.com/99999/10101/v0.0.1/opioidDetector \
  -H 'Content-Type: application/json' \
  -d '{"rxcuis":"106500,200240,856917,994226,197446,801958"}'

Example API Response

{
    "result": {
        "condition_satisfied": true,
        "summary": {
            "opioid": true
        },
        "detail": {
            "106500": {
                "opioid": true
            },
            "197446": {
                "opioid": false
            },
            "200240": {
                "opioid": false
            },
            "801958": {
                "opioid": false
            },
            "856917": {
                "opioid": false
            },
            "994226": {
                "opioid": true
            }
        }
    },
    "info": {
        "ko": "99999/10101/v0.0.1",
        "inputs": {
            "rxcuis": "106500,200240,856917,994226,197446,801958"
        }
    }
}

Additional API documentation can be found in the Swagger UI visualation of the OpenAPI specification.

2️⃣ Opioid and Benzodiazepine Detector

This KO scans a list of a patient's prescriptions, which are presented to the KO as a list of RxNorm Semantic Clinical Drug codes, and determines if they are being exposed simultaneously to a known risky combination of an opioid and a benzodiazepine.

Example API Usage with curl

curl -X POST \
  http://kgrid-activator.herokuapp.com/99999/10102/v0.0.1/opioidbzdDetector \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{"rxcuis":"106500,200240,856917,994226,197446,801958"}'

Additional API documentation can be found in the Swagger UI visualation of the OpenAPI specification.

3️⃣ Respiratory Depression Risk Indicator

This KO scans a list of a patient's prescriptions, which are presented to the KO as a list or RxNorm Semantic Clinical Drug Codes, and determines if they are at higher risk for drug-induced respiratory depression because of being exposed simultaneously to a combination of an opioid, a benzodiazepine, and a muscle relaxant.

Example API Usage with curl

curl -X POST \
  http://kgrid-activator.herokuapp.com/99999/10103/v0.0.1/tripleThreatDetector \
  -H 'Content-Type: application/json' \
  -d '{"rxcuis":"106500,200240,856917,994226,197446,801958"}'

Additional API documentation can be found in the Swagger UI visualation of the OpenAPI specification.

Install KOs on KGrid Activator

In order to use the MOpen Opioid Knowledge Object Collection you need to have an instance of the KGrid Activator up and running. To do this, refer to KGrid Activator deployment details. Once you have KGrid Activator up and running you will need to add the MOpen Opioid KOs to the existing shelf.

1. Download the released MOpen Opiod KOs self (opid_shelf.zip) from github MOpen-Opioid Collection
2. Place the opid_shelf.zip.zip into the directory where the activator jar is located and unzip. This will place the KOs into existing shelf directory

Directory structure should look similar to the following

 ├── shelf
 │   └── 99999-10103
 │       └── v0.0.1   
 │   └── 99999-10102
 │       └── v0.0.1   
 │   └── 99999-10101
 │       └── v0.0.1   
 └── kgrid-activator-0.6.2.jar

Once on the KGrid Activator shelf the KOs will need to be activated. This is accomplished by calling the executors resource.

curl http://localhost:8080/endpoints

This will load and activate the KOs on the shelf. You should recieve a list of the activated endpoint similar to the following

[
    "99999/10103/v0.0.1/tripleThreatDetector",
    "99999/10101/v0.0.1/opioidDetector",
    "99999/10102/v0.0.1/opioidbzdDetector"
]

Common Issues/Problems

More to come

Roadmap

Current

Planned

Release/Publish KOs

The current released/published MOpen collection is stored on GitHub MOpen Opioid Collection Releases. This zipped ko collection can be installed in an activator as descrided in Install the Michigan OPEN Opioid-related KO Collection