VitalKnowledge Code Lookup

Overview

 

VitalWare's VitalKnowledge™

How-to Embed the VitalKnowledge HTML Control

  • Load the vitalware.common.widget.js script.  To load the VitalKnowledge widget you will need to retrieve a VwToken from within your program. 

Sample code to load the VitalKnowledge widget:

<script language="javascript" src="https://mashery.vitalware.com/ctl/v1/vitalware.common.widget.js?api_key={your_api_key}"></script>

new commonWidget()

Instantiate the commonWidget using the following options object:

<script language="javascript">
    var cmnWidget = new commonWidget({
        autoLoad:true,
        container: '<strong>commonWidget</strong>', //id of the container where you want the widget to load
        environment: '<strong>secure</strong>', //options: secure (production), rc (staging), build (development)
        module: '<strong>vwVitalCoderWidget</strong>', //for Vital Knowledge this will be your module
        component: '<strong>vitalCoder</strong>', //component for Vital Knowledge
        resultFormat: '<strong>json</strong>', //format you would like to send and receive data json|xml
        receiveCallback: '<strong>receiveResult</strong>', //callback when the user clicks Save 
        vwToken: {token optained from your application} //call /authorize to get a vwToken you can send here
    });
</script>

 Widget Options

Parameter Data type Default Description
autoload boolean true If true, the application will automatically instantiate the iFrame with the init options provided. If false, the load() method must be explicitly called before the widget will generate the iFrame.
container string *Required ID of the element that the widget script will generate the iFrame in.
environment string

*Required

VitalWare environment to load the widget script from. Users will only be able to access the environments VitalWare has granted access to.

Valid Values:

  • "secure" - Production environment
  • "rc" - Staging environment
  • "build" - Development environment
module string

*Required

Always use "vwVitalCoderWidget" for the VitalKnowledge application

component string *Required

Always use "vitalCoder" for the VitalKnowledge application

resultFormat string json

Values:

  • json
  • csv
receiveCallback string

Javascript method to call when the user clicks the "Save" button. The results of the Cart will be passed to this method.

vwToken string *Required

vwToken returned from the Authentication call

load() method

To load data you will want to send the widget a load command with the data you want sent. The only parameter the load object accepts is an options object. For example:

cmnWidget.load({
    selectedCodeType: 'ICD-10 CM',
    includeExpiredCodes: '1',
    searchTerm: 'Diabetes'
});

Load Options

Parameter Data type Default Description
selectedCodeType string

Code Set to search on. Valid Values:

  • ICD-10 CM
  • ICD-10 PCS
  • ICD-9-CM Diagnosis
  • ICD-9-CM Procedure
  • CPT/HCPCS
  • APC
  • Modifiers
  • MS/DRG
  • NCD/Pharmacy
  • Revenue Codes
  • Devices
includeExpiredCodes boolean View/Hide expired codes
searchTerm string

 

Text to search in the selected code set

Results Callback Method

Save codes to the Cart in VitalKnowledge, then click the "Save" button to return a JSON object containing the cart contents to your application. The only parameter the method accepts is a result object. For example:

   function receiveResult(result){
        console.log('receiveResult......');
        console.log(result);
        document.getElementById('jsonResults').innerHTML = result; 
    }

Sample Result Object

{
    "records": [{
        "codeType": "string",
        "createdDate": "dateTime",
        "targetDate": "dateTime",
        "code": "string",
        "codeDisplay": "sting",
        "longDescription": "string",
        "shortDescription": "string",
        "createdBy": "string",
        "codeId": int,
        "baseMetaVId": int
    }],
    "totalRecords": int
}

Try it out!

Registered Mashery users with access to the VitalKnowledge control can use the forms below to initiate and then query the app inline with our documentation.

View this page source code for the sample code in this example.

Once the app is initialized, try passing a different JSON object to it using the 'load' method.

Save codes to the Cart by right clicking on the row. Click the "Save" button to return a JSON representation of the cart here:

"Save Cart" to display JSON results here.

 

Loading...

VitalWare's VitalKnowledge™ - South Panel

  • VitalWare proxy users who have a license for VitalKnowledge™ can view code details in the VitalKnowledge South Panel
  • To load the south panel, use the following script, replacing the codeTypeKey with the code set you are querying for in the {codeTypeKey} parameter and specifying the code to search for.

See the table below for a list of valid codeTypeKey values:

<script language="javascript" src="https://mashery.vitalware.com/ctl/v1/vitalware.common.widget.js?api_key={your_api_key_here}"></script>
<script language="javascript">
    var cmnWidget = new commonWidget({
                        autoLoad: false,
                        container: 'commonWidget',
                        environment: 'secure',
                        module: 'vwContainer',
                        component: 'vcSouth',
                        receiveCallback: 'receiveResult',
                        resultFormat: 'json',
                        vwToken: token
                    });
</script>

Once you have created the widget you can load with your code search. For example, this call will display code details for the ICD-10 CM code Z12.31:

<script language="javascript">
    cmnWidget.load({
        codeType:'ICD-10 CM',
        code:'Z12.31'
    });
</script>

Input your credentials for a full working example of the Code Referential Panel.

Once the app is initialized, try passing a different JSON object to it using the 'load' method.

Loading...

Please note:

  • This control will only display the content that the authenticated proxy user has rights to view. 
  • Proxy users who do not have rights to the requested VitalKnowledge South Panel content will see a blank screen.
  • Optionally pass a vwToken URL parameter to authenticate proxy users.
  • Some code types require leading 0’s for VitalKnowledge to recognize the code. See the table below for details.

Valid codeTypeKey values:

codeTypeKey      Code type(s) Description
apc APC* Ambulatory Payment Classification
cpt CPT Current Procedural Terminology
cpt-mod CPT Mod Current Procedural Terminology Modifier
hcpcs HCPCS LVL II Healthcare Common Procedure Coding System Level II
hcpcs-mod HCPCS LVL II Mod Healthcare Common Procedure Coding System Level II Modifier
icd-9 cm ICD-9-CM Diagnosis International Classification of Diseases Version 9 Diagnosis
icd-9 pcs ICD-9-CM Procedure International Classification of Diseases Version 9 Procedure
icd-10 cm ICD-10 CM International Classification of Diseases Version 10 Diagnosis
icd-10 pcs ICD-10 PCS International Classification of Diseases Version 10 Procedure
ms-drg MS-DRG** Medicaid Services Diagnosis Related Group
ndc NDC National Drug Code
revCode Rev Code* Revenue Code
cdt Dental Procedures Current Dental Terminology
asaCpt Anasthesia Procedures American Society of Anesthesiologists Current Procedural Terminology
cptHcpcs CPT/HCPCS CPT and HCPCS
cptHcpcsAsa CPT/HCPCS/ASA CPT and HCPCS Includes Anesthesia
cptHcpcsCdt CPT/HCPCS/CDT CPT and HCPCS Includes Dental Terminology
modCptHcpcs CPT/HCPCS Mod CPT/HCPCS Modifier

* These codes must be 0-padded to 4 characters. For example, APC Code 0437 must be passed with the leading 0 for the code to be recognized by VitalWare.

** These codes must be 0-padded to 3 characters. For example, MS-DRG 001 must be passed with the leading 0’s for the code to be recognized by VitalWare.

Supported Browsers