Skip to content

Commit

Permalink
OZ-456: Documented HIS compoment criteria.
Browse files Browse the repository at this point in the history
  • Loading branch information
mks-d committed May 9, 2024
1 parent 0b193d4 commit 7dcd1c8
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 11 deletions.
38 changes: 27 additions & 11 deletions docs/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
1 change: 1 addition & 0 deletions overrides/.icons/erpnext.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions overrides/.icons/fhir.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions overrides/.icons/keycloak.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions overrides/.icons/openmrs.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions overrides/.icons/superset.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7dcd1c8

Please sign in to comment.