Iteration 1 Architecture

This wiki page describes the architecture for Iteration1 of the SCOOP project.

Context

The architecture context is basically the same as the previous iteration although the way that this is realized has changed.

/iteration1/images/architecture/IT1-Context.png

This iteration is being deployed to a laboratory environment (non production) at UVic.

There is only one practice being simulated in this iteration (i.e. one endpoint).

Logical View

/iteration1/images/architecture/IT1-Systems.png

There are a number of architectural changes planned for this iteration of SCOOP.

1. We are enhancing OSCAR to export the patient summary document, either for a single individual or by batch for all individuals with a record in the EMR

2. The data transfer format will be an emerging Canadian standard, the E2E developed by the BC PITO program. It is an HL7 CDA-based XML document. Because we are enhancing an open source Canadian EMR – it only makes sense to support a Canadian standard.

3. The middleware (Mirth) will play a much smaller role in this design. It will simply transfer individual summary documents between the EMR and the hQuery Gateway. It will not perform any aggregation or transformation.

4. hQuery Gateway will be enhanced to support the import of E2E patient summary documents. This is not a complex change because it is CDA-based and extremely similar to the already supported C32 document.

Constraints

Privacy Individual information never leaves the practice. Early feedback from discussions with the faculty physicians UBC highlighted their stewardship of patient information as a serious matter. There’s a genuine concern that anonymous data collected may be used for unintended research purposes in the future. Several are concerned by the risks of data aggregation, even when the data is de-identified.

Open Source As SCOOP development is sponsered with public funds it will be released as open source for any one to use. In addition, SCOOP will only rely on free, open source components so that its use is accessible to any individual/group.

OSCAR In addition to being open source, OSCAR is the EMR used by many faculty physicians at UBC. A few of these faculty members will the initial SCOOP users. For this reason, OSCAR will be the first supported EMR.

Design View

Software design of the new export feature in OSCAR

/iteration1/images/architecture/IT1-Template-UML.png

We will attempt to stay true to the MVC design. Velocity based templating requires both a template and a data model. We have opted to make the Patient object draw on all the pre-existing DAOs and models and have Patient group up the relevant fields for easy velocity access. Most of the heavy code work will be found in E2EVelocityExport.java and DemographicExportAction4.java acts as the Event Handler and file management for the export function.

Placeholder Software design for new hquery enhancements

Data View

introduction to E2E Overview of E2E sections (including image) statement of scope of content for the iteration

Technology Selection

OSCAR An Open Source EMR system used by many private physicians. This is way that individual information is captured - and the user interface for the physician practioner end user.

Mirth Mirth is an open source interfacing system. It acts as generic middleware between many healthcare software systems and connects them via HL7 messages (although several formats / protocols are supported).

Mirth Rest Adaptor This is an open source piece of middleware developeed by the SCOOP project. Mirth does not fully support restful web services. Specifically it does not allow naming of attachments to web service calls. For this reason, hQuery gateway cannot find the patient summary document when Mirth calls it directly. This component can be thought of as a restful web service relay that renames a single attachment (patient summary document) before forwarding the call.

hQuery gateway The query gateway is a web based application that provides the back end for executing queries. The query gateway which exposes a query API, accepts queries, runs those queries against the patient data, and returns the results of the query back to the query composer.

hQuery composer The query composer is a web based application that provides the front end for creating, managing, and executing queries. Those queries are executed against the query gateway which exposes a query API, accepts queries, runs those queries against the patient data, and returns the results of the query back to the query composer.

Scoop Endpoint refers to all the non-emr SCOOP software components that will reside at a practice in the future. This indludes hquery gateway, Mirth, and Mirth Rest adapter.

SCOOP Hub This is the application that the researcher uses to ask a "question" of the Research Network. This includes features for query management, policy enforcement, privacy management, and security. Currently, hQuery composer is the only software system in the hub - but more design and enhancements are needed.

• libraries: template