Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.84 KB

CohortBuildingApiPlugins.md

File metadata and controls

37 lines (20 loc) · 1.84 KB

Cohort Building Api Plugins

Background

In the RDMP Cohort Builder, cohorts are built by INTERSECTing / UNIONing and EXCEPTing lists of patient identifiers.

In order to support large queries across multiple datasets in an efficient and persistent manner a query cache can be set up.

This query cache can also be used to store the results of API calls to arbitrary services (e.g. REST)

Cohort Building Tree with an Api point in it

Writing an API call plugin

API call plugins should be created in the same way as regular plugins. After ensuring that your binary works and is loaded by RDMP you should implement PluginCohortCompiler.

An example implementation is included:

The implementation should be in the main section of your plugin and so be usable from both command line and UI client. The implementation should not require user interaction when running.

Writing a User Interface

You can provide a user interface for configuring uses of your plugin by implementing PluginUserInterface. An example

An example implementation is included:

The implementation should be in the windows section of your plugin since it will only be called from the Windows Gui Client

If you want to be able to configure uses of your API from the command line you can create a new command by implementing BasicCommandExecution (which can be in the main section of your plugin)