diff --git a/docs/users/index.md b/docs/users/index.md index ee4e199..0d4c610 100644 --- a/docs/users/index.md +++ b/docs/users/index.md @@ -22,20 +22,36 @@ stateDiagram-v2 Ozone is a ready-to-use solution, providing a pre-selected array of FOSS[^foss] components that function seamlessly together. -It is a complete health information system allowing users to customize it by choosing which supported digital health software to include or exclude. - [^foss]: Free and open-source software -### Current Ozone HIS suite +It is a complete health information system allowing users to customize it by choosing which supported digital health software to include or exclude. -| **HIS type** | **Component** | **Version** | | -|--------------|-----------------|-----------------|----------------| -| EMR | OpenMRS | `3.0.0-beta.16` | | -| LIMS | SENAITE | `2.1.0` | | -| ERP | Odoo | `14` | | -| ERP | ERPNext | `15.12.2` | | -| BI | Apache Superset | `1.5.1` | | -| IdP | JBoss Keycloak | `22.0.0` | | +### Criteria to enter Ozone HIS' suite + +As Ozone continues to expand its suite of software components, several criteria must be met for a software component to be included in the Ozone HIS ecosystem. Below, we outline these requirements: + +|Criterion|Requirement| | +|:---:|:---:|:---:| +|:fontawesome-brands-osi: Open-source|{==**Must**==}|Ozone is FOSS under MPL 2.0. Closed-source software is accommodated within the Pro edition of Ozone or through custom developments.| +|:fontawesome-solid-tag: Released version|{==**Must**==}|Ozone supports HIS flows between versioned components with stable and, ideally, well-documented APIs.| +|:fontawesome-solid-shield-halved: OAuth 2|{==**Must**==}|OAuth2 is required for enhanced security and to implement SSO within the Ozone HIS.| +|:fontawesome-brands-docker: Docker image|{==**Must**==}|Docker, while not the sole deployment mechanism supported, is currently the default one in Ozone HIS.| +|:fontawesome-solid-heart-pulse: Health check|**Should**|It is crucial that each component includes a web endpoint to let Ozone verify it is operational within the HIS.| +|:simple-prometheus: Prometheus metrics|**Should**|Providing Prometheus metrics is recommended to enhance monitoring and ensure effective system performance management.| +|:fontawesome-solid-timeline: Backup & restore|**Should**|Each component should include automated backup and restore capabilities to ensure data integrity and system resilience.| +|:fhir: HL7 FHIR API|**Should**|Providing HL7 FHIR API reduces development overhead for peer-to-peer HIS components routes within Ozone.| +|:fontawesome-solid-sitemap: Event bus|Could|Providing an event bus could offer a more efficient method of dispatching information as it becomes available, eliminating the need for polling.| + +### Suite as of Ozone HIS `1.0.0-alpha.9 + +|HIS type|Component|Version in Ozone HIS| +|:---:|:---:|:---:| +|EMR|:openmrs: OpenMRS|`3.0.0-beta.16`| +|LIMS|SENAITE|`2.1.0`| +|ERP|Odoo|`14`| +|ERP|:erpnext: ERPNext|`15.12.2`| +|BI|:superset: Apache Superset|`1.5.1`| +|IdP|:keycloak: JBoss Keycloak|`22.0.0`| !!! tip "Ozone Pro markers" diff --git a/overrides/.icons/erpnext.svg b/overrides/.icons/erpnext.svg new file mode 100644 index 0000000..5a713ba --- /dev/null +++ b/overrides/.icons/erpnext.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/overrides/.icons/fhir.svg b/overrides/.icons/fhir.svg new file mode 100644 index 0000000..e816123 --- /dev/null +++ b/overrides/.icons/fhir.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/overrides/.icons/keycloak.svg b/overrides/.icons/keycloak.svg new file mode 100644 index 0000000..dfe5cfb --- /dev/null +++ b/overrides/.icons/keycloak.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/overrides/.icons/openmrs.svg b/overrides/.icons/openmrs.svg new file mode 100644 index 0000000..800b634 --- /dev/null +++ b/overrides/.icons/openmrs.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/overrides/.icons/superset.svg b/overrides/.icons/superset.svg new file mode 100644 index 0000000..035bffd --- /dev/null +++ b/overrides/.icons/superset.svg @@ -0,0 +1 @@ + \ No newline at end of file