The following are recommended non-functional requirements for OpenHIE reference software.
Well Documented: An OpenHIE reference system should include appropriate background, design, installation, configuration, and operational documentation to ensure it is easy to understand, maintain, and debug.
Source code should have comments so that developers do not need to look anywhere else to understand the code.
Configuration files should have embedded comments explaining the different options.
Installation, configuration, and operational activities should be described.
Easy to implement for common use cases
Built using open source tools and technology: The OpenHIE component should be built using widely available open-source technology (including development environments and languages).
Open, easy access to source code: A standard version control system (e.g., GitHub) should be used to ensure that source code access is fast, easy to download, compile, and execute code.
Standards-based: The software should use broadly adopted standards that enable interoperability among systems.
Reliable and easy-to-use User Interface: Common identity management workflows must be supported by the user interface, including initial system configuration, and routine workflows.
Minimal software library dependencies: An OpenHIE component should minimize dependencies on 3rd-party libraries.
Minimal abstraction: A OHIE component should not have more layers of abstraction than necessary, and seek to minimize abstraction that confounds design.
Easy Initiation: When properly installed and configured, administrators should be able to initiate the OpenHIE and any associated supporting processes with a single step.
Build on commonly used technology:
In order to make it easy to run/configure/debug, the software should be built on popular technologies that developers like to use.
Any 3rd party libraries used by the software should be easy for a typical developer to use.
Any external software/systems (like the database) should also be easy to use.
It should be easy to view the contents of the database.
If a traditional SQL database is used, then multiple databases should be supported (MySQL/PostgreSQL/Oracle).
The source code should include unit tests that are based on the specific requirements of OpenHIE.
License: The component would ideally be distributed under an open-source license that minimizes complexity and enables an implementer community to leverage the software in a broad variety of sustainability contexts.
The component should have a clear and standard license so that it is easy to understand what kinds of usage are allowed.
The code should be hosted somewhere that developers like to use.
The component should have an easy to use, well thought out and well implemented front end