MVP Scope

[spicyfalafel]

The goal of ViewDefinition Designer is to provide better UX to create ViewDefinition, compared to plain text editing.
UX instantly gives feedback of what the current VD will do.

MVP is a version of a product with just enough features to be usable by early customers who can then provide feedback for future product development.
By customers we mean Aidbox team to evaluate.
The goal of MVP is to make a decision about the UX of the ViewDefinition form.

MVP scope

1. Form page

• user can edit existing ViewDefinition resource in form
• user can get data from db of current VD by clicking the button "Run"
• styling is good in our opinion (Layout enhancements #45, Form enhancements #46, UI compactness enhancements #47, Table enhancements #48, Create new nodes in tree expanded by defaullt #36)
• user can choose which elements are shown in the form by hitting "options" icon at every "type" of SELECT and also on the from itself (root elements) (Add settings popup to set optional ViewDefinition fields #37)
• user can save VD resource to the server by clicking "create" VD button in VD Form (for "edit" and "create" mode) (Add "Create" button in VD form #41)
• user can view and download ViewDefinition resource represented in YAML & JSON in read-only mode and cannot modify it (Add ability to view raw json/yaml and download it #26)
• user can view SQL result in the tab (Show SQL in VD form #42)
• when VD is saved by clicking "save" button, show "saved" message (Show response info on top of the ViewDefinition form page #51)
• if "get data from db by VD resource" request fails, show the error message (Show response info on top of the ViewDefinition form page #51)

2. List of ViewDefinitions page

• user can see which ViewDefinitions resources are already present in connected FHIR server
• user can search for ViewDefinitions
• user can delete VD resource from the server (only external server)
• create an opinionated collection of VDs from SoF tests playground website which is good start point to understand possible ViewDefinitions Create set of VDs in Aidbox Default box #77

3. Settings page

• user can do nothing with the settings and use preconfigured aidbox instance in read-only mode
• user can create and save any number of configurations (see VANYA viewer server list)
• user can choose and configure:
  • URL to get data from (/metadata, /ViewDefinition)
  • any custom headers for every request e.g. to use basic authentication
• user can see FHIR version of connected server
• user understands if server is "connected" successfully and see errors if something went wrong

[Leningradez]

Suggestions

ViewDefinition Designer aims to provide better UX to create and debug ViewDefinitions than JSON/YAML editing.
Better UX is achieved through the following features:

• visual editor with the predefined structure of ViewDefinition resource,
• real-time representation of results based on sandbox data and debug API,
• basic autocomplete feature for FHIRpath expressions (path selection only)
• education tooltips with element definitions

@spicyfalafel