RxMix Tutorial Simple Example

Introduction

• Function composition. The RxMix interface allows the user to build a workflow of API functions to execute. This saves the user from having to write complex programs to handle multiple function calls. Examples of function composition are contained in the examples below.
• Batch processing. Through the user interface, RxMix allows the user to process large amounts of data through the user defined workflow. The user can provide a file containing a list of inputs, such as drug names or drug identifiers, for input to the workflow. RxMix will execute the workflow and inform the user via email when the job has completed, providing information on how to retrieve the results.
• Output in XML, JSON or Text. RxMix offers the user the choice of formatting the output in XML, JSON, or text.
• Interactive mode. RxMix allows users to interactively test and display the results of the workflow on a single input value.

Users of the RxMix interface should be familiar with the RxNorm, NDF-RT and/or the RxTerms API functions.

The RxMix web page is located here.

Batch example

A Simple Example

The figure below shows the initial RxMix page.

The main panel is divided up into five sections.

• Workflow is where the workflow is displayed (the left side) and where the user defines the workflow (the right side). The user can either load in a previously defined workflow, or define one using the "Select Function" Menu and the "Add to Workflow" button.
• Input is where the user specifies the input values needed to run the workflow. The "Run Batch" popup menu allows the user to run batch jobs on the workflow.
• Output is where the user specifies the output type (JSON, TEXT, TABLE or XML), and the output filters.
• Execute contains buttons that allows the user the clear, save or run (interactively) the workflow.
• Result contains the result of an interactive run.

The menu of available functions shows the API (RxNorm, RxTerms or NDF-RT) type and the names for each available function.

Scroll down to the NDF-RT functions and select the NDF-RT API function "findConceptsByName". The workflow area is changed to the figure below.

The findConceptsByName function needs two parameters. The concept name parameter will be specified in the input data section. The other parameter, the kind name, is specified in the workflow area. RxMix provides a default value (all kinds are highlighted) for this field.

Note: The documentation for a selected function can be viewed by positioning the cursor over the help icon .

Select "DRUG_KIND" in the kind menu. Click the "Add to Workflow" button to add the function to the workflow. The workflow area is changed to the figure below.

Notice that a "Remove Last" button has appeared below the workflow diagram. This allows the last function in the workflow to be removed.

The next step is to add the second function to the workflow. From the function menu under NDF-RT, select "findDrugInteractions". Then click on the "Add to Workflow" button. The workflow is changed to the figure below.

The next step is to add the input data. The input for this workflow needs a drug name. Type in "morphine" in the input box.

The Output Filter lists the fields to be included in the output. Uncheck the comment and kind boxes to exclude them from the output.

Now click on the "Run" button in the EXECUTE section to start the processing. The results will be shown as a table (the output format selected) in the RESULT area.

Congratulations, you have created and ran your first workflow in RxMix.

The next example will demonstrate the use of batch processing in RxMix. Click here to view the batch example.

Comments? Feedback? Questions?
Contact: Contact us