Features
Dashboard
The dashboard screen shows a summary of the current state of the CDR system, including counts of various resource types.
AQL workbench
Write and execute ad-hoc AQL, or execute a STORED_QUERY from the CDR. The AQL is syntax coloured in the editor and can be quickly formatted for readability.
The AQL editor simplifies query writing via code completion capabilities. If a template name is provided, then the code completion includes the archetypes from within the template.
If the AQL query requires parameters, these can be entered in the parameter panel. The panel will automatically show the parameters contained within the AQL query.
The AQL query results are displayed in a table view, with the option to view the results in JSON or AQL format.
The results can be exported to CSV for further analysis, and the underlying AQL can be copied to the clipboard for use in other tools.
An AQL Library allows AQL queries to be saved into a personal collection, and then retrieved at a later date. All saved queries are stored locally within the browser and are available to the user only.
Request History
All API calls made by the application are stored in the Request History. These can be replayed on request.
All API responses for queries can be viewed either in tabular format or in JSON format. The underlying AQL can be copied to the clipboard for use in other tools.
Other API responses are displayed in JSON format.
EHR Maintenance
The CDR EHR entries can be viewed using the built-in AQL screen. The ability to filter on the main attributes of the EHR, such as the EHR ID, the subject ID, and the subject namespace, is provided. The results can be viewed in tabular format or in JSON format. Exporting to a CSV is also available.
From the query screen, the EHR can be selected, and the EHR details can be viewed either by double-clicking on the EHR entry or by selecting the appropriate action from the context menu. The context menu provides many handy shortcuts to the other menu items in the sidebar; these can be accessed directly from the sidebar as well.
Options to add new EHRs are provided, and the deletion of EHRs will also be supported in future versions (provided the Admin mode is enabled).
Compositions
The CDR compositions can be viewed using the built-in AQL screen. The ability to filter on the main attributes of the composition, such as the ehr_id and the template_id, is provided. The results can be viewed in tabular format or in JSON format. Exporting to a CSV is also available.
From the query screen, double-clicking on a composition entry or selecting the appropriate action from the context menu will display the composition details. The context menu provides many handy shortcuts to the other menu items in the sidebar; these can be accessed directly from the sidebar as well.
When viewing the composition details, the composition can be viewed in tabular format or in FLAT, JSON, STRUCTURED, or XML formats.
The ability to update or add new compositions is provided, and the deletion of compositions will also be supported in future versions (provided the Admin mode is enabled).
Template Management
The application allows the templates stored with the CDR to be managed. An initial view lists all the templates, with an option to filter by template_id.
From the list screen, double-clicking on a template entry or selecting the appropriate action from the context menu will display the template details.
The context menu provides various shortcuts to the other menu items in the sidebar; these can be accessed directly from the sidebar as well.
When viewing the template details, the template can be viewed in either JSON or XML formats. Templates can be downloaded or new ones uploaded to the CDR. The deletion of templates will also be supported in future versions (provided the Admin mode is enabled).
When viewing the template details, the structure of the template can be viewed. This shows both the constrained archetypes and the path to each node.
The ability to update or add new templates is provided, and the deletion of templates will also be supported in future versions (provided the Admin mode is enabled).
Example compositions can be generated from the templates, and these can be viewed in FLAT, JSON, STRUCTURED, or XML formats.
Stored Query Management
The stored queries within the CDR can be viewed as a list, with a filter based on the query name.
Double-clicking on a query launches the view query screen, where the underlying AQL can be viewed.
From this screen, the option to execute the query is also available.
New queries, or versions of queries, can be added. Additionally, queries can be deleted when the application is in Admin mode.
Settings for CDR Connections
The settings screen is where the connection details for CDRs are configured. The settings are stored in the browser and are available to the user only.
The application allows multiple settings to be configured. The settings can be switched at any time. The list on the left-hand side of the screen shows which connection is currently active.
To ensure you know which is the currently selected CDR at any time, the application shows the currently selected CDR on the left-hand side of the footer bar on every screen.
The screen below shows the settings required to connect to the EHRbase public sandpit. This is an internet-accessible CDR that is available for testing and development purposes. The connection details are available from the EHRbase website.
If connecting to EHRbase running in a local docker container, then assuming the default credentials are used, the connection details would be as shown below.