...
- Consultations with the relevant communities on profiles, use cases, and workflows, including with the OpenHIE Architecture Community and DevOps Community.
- Capturing the community feedback into an Instant OpenHIE Technical Design document for sharing. The Technical Design document is the entry point for understanding how to get started and make use of the stack as well as contribute to it and its future.
- The initial efforts at creating a core prototypical health information exchange using open standards and open source software to help developers add interoperability to your own products.
- Two packages will be produced in the first phase, the core package and the health workforce package that extends from core and adds health workforce related functions and metadata.
Phase 1 Roadmap
| Roadmap Planner |
|---|
| maplinks | |
|---|
| timeline | true |
|---|
| pagelinks | |
|---|
| source | %7B%22title%22%3A%22Roadmap%20Planner%22%2C%22timeline%22%3A%7B%22startDate%22%3A%222019-1210-01%2000%3A00%3A00%22%2C%22endDate%22%3A%222020-09-1030%2000%3A00%3A00%22%2C%22displayOption%22%3A%22MONTH%22%7D%2C%22lanes%22%3A%5B%7B%22title%22%3A%22Phase%201%20-31%2000%3A00%3A00%22%2C%22displayOption%22%3A%22MONTH%22%7D%2C%22lanes%22%3A%5B%7B%22title%22%3A%22Instant%20OpenHIE%22%2C%22color%22%3A%7B%22lane%22%3A%22%23f6c342%22%2C%22bar%22%3A%22%23fadb8e%22%2C%22text%22%3A%22%23594300%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22title%22%3A%22Project%20Management%20%26%20Scheduling%22%2C%22description%22%3A%22This%20is%20the%20first%20bar%20Core%20%26%20Health%20Workforce%22%2C%22color%22%3A%7B%22lane%22%3A%22%238eb021%22%2C%22bar%22%3A%22%23aac459%22%2C%22text%22%3A%22%23ffffff%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22title%22%3A%22Tool%20Review%20and%20Selection%22%2C%22description%22%3A%22This%20is%20the%20first%20bar.%22%2C%22startDate%22%3A%222019-1210-01%2007%3A21%3A58%22%2C%22duration%22%3A1001%2004%3A03%3A05%22%2C%22duration%22%3A2.009900990099009%2C%22rowIndex%22%3A0%2C%22id%22%3A%225a81be6098019801980198%2C%22rowIndex%22%3A0%2C%22id%22%3A%225a81be60-763c-4168-aa58-76e4b13f8b92%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22title%22%3A%22Architectural%20Review%20and%20Tool%20selection%22%2C%22description%22%3A%22This%20is%20the%20second%20bar76e4b13f8b92%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22title%22%3A%22Instant%20OpenHIE%20Architecture%20Draft%20Specification%22%2C%22description%22%3A%22This%20is%20the%20second%20bar.%22%2C%22startDate%22%3A%222019-1210-08%2016%3A09%3A30%22%2C%22duration%22%3A901%2004%3A03%3A05%22%2C%22duration%22%3A3.485148514851485%2C%22rowIndex%22%3A1%2C%22id%22%3A%22aaa316ea99009900990099%2C%22rowIndex%22%3A1%2C%22id%22%3A%22aaa316ea-6e6e-45aa-b999-b5c97fd5f54c%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A2%2C%22startDate%22%3A%222020b5c97fd5f54c%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A2%2C%22startDate%22%3A%222019-0112-31%2016%3A38%3A01%22%2C%22id%22%3A%22a0f1f41b31%2005%3A57%3A08%22%2C%22id%22%3A%22a0f1f41b-356f-4270-995c-196b6fa7151a%22%2C%22title%22%3A%22Containerisation%20%26%20Deployment%20Strategies%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2.00990099009901%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A3%2C%22startDate%22%3A%222020196b6fa7151a%22%2C%22title%22%3A%22Containerisation%20%26%20Deployment%20Approach%22%2C%22description%22%3A%22%22%2C%22duration%22%3A3%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A3%2C%22startDate%22%3A%222020-0201-01%2006%3A53%3A27%22%2C%22id%22%3A%22b2ab854d31%2014%3A03%3A19%22%2C%22id%22%3A%22b2ab854d-9420-4a5a-afec-6e013c431ffa%22%2C%22title%22%3A%22HIE%20Configuration%20%26%20Workflow%20Instantiation%22%2C%22description%22%3A%22%22%2C%22duration%22%3A5.98019801980198%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A4%2C%22startDate%22%3A%2220206e013c431ffa%22%2C%22title%22%3A%22Component%20Config%20Scripts%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A4%2C%22startDate%22%3A%222020-03-31%2001%3A54%3A03%22%2C%22id%22%3A%2259b5f65331%2010%3A00%3A14%22%2C%22id%22%3A%2259b5f653-612e-44b0-ab79-c09acc9ad704%22%2C%22title%22%3A%22HIE%20Instantiation%20%26%20Testing%22%2C%22description%22%3A%22%22%2C%22duration%22%3A4%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A4%2C%22startDate%22%3A%222020c09acc9ad704%22%2C%22title%22%3A%22Workflow%20Config%20Scripts%20and%20mCSD%20Mediator%22%2C%22description%22%3A%22%22%2C%22duration%22%3A4%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A5%2C%22startDate%22%3A%222020-0803-01%2007%3A21%3A58%22%2C%22id%22%3A%2233d2263431%2009%3A16%3A02%22%2C%22id%22%3A%2233d22634-4326-40bd-949b-fc6158e01cb0%22%2C%22title%22%3A%22Use%20Case%20Configuration%22%2C%22description%22%3A%22%22%2C%22duration%22%3A1fc6158e01cb0%22%2C%22title%22%3A%22HIE%20Instantiation%20%26%20Testing%22%2C%22description%22%3A%22%22%2C%22duration%22%3A3.9801980198019802%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A5%2C%22startDate%22%3A%2220209603960396039604%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A6%2C%22startDate%22%3A%222020-0107-04%2001%3A39%3A48%22%2C%22id%22%3A%224c2ae4fd30%2018%3A32%3A04%22%2C%22id%22%3A%224c2ae4fd-7e69-4fc9-815c-de34cfdd71bb%22%2C%22title%22%3A%22Community%20Engagement%20%26%20Support%22%2C%22description%22%3A%22%22%2C%22duration%22%3A8.990099009900991%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A6%2C%22startDate%22%3A%222019-12-01%2007%3A21%3A58%22%2C%22id%22%3A%22eb60c175-5865-47b1-b251-282ebf66d657%22%2C%22title%22%3A%22Reporting%20(Monthly%2C%20Quarterly%20%26%20Financial%20reports)%22%2C%22description%22%3A%22%22%2C%22duration%22%3A10.98019801980198%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A7%2C%22startDate%22%3A%222020-01-01%2000%3A00%3A00%22%2C%22id%22%3A%222c009145-89f8-44fa-a7b6-3ccb260696b0%22%2C%22title%22%3A%22New%20Bar%22%2C%22description%22%3A%22%22%2C%22duration%22%3A1%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%5D%2C%22markers%22%3A%5B%7B%22title%22%3A%22Quarterly%20Progress%20Report%22%2C%22markerDate%22%3A%222020-02-01%2000%3A00%3A00%22%7D%2C%7B%22markerDate%22%3A%222020-07-31%2016%3A38%3A01%22%2C%22title%22%3A%22Quarterly%20Progress%20Report%22%7D%2C%7B%22markerDate%22%3A%222020-05-01%2000%3A00%3A00%22%2C%22title%22%3A%22Quarterly%20Progress%20Report%22%7D%2C%7B%22markerDate%22%3A%222020-10-31%2016%3A38%3A01%22%2C%22title%22%3A%22Quarterly%20Progress%20Report%22%7D%5D%7D |
|---|
| title | Roadmap%20Planner |
|---|
| hash | aefb6c0dd395259ee4fe55f58838ae46 |
|---|
|
Architecture
The fundamental concept of Instant OpenHIE is that it can be extended to support additional use cases and workflows. This will be achieved through packages. A core package will be produced in this first phase which other packages will all derive from. A package will either extend directly from the core package or from another package.
Each package will contain the following sorts of technical artefacts:
- Docker compose scripts for setting up the applications required for this package’s use cases and workflows
- Kubernetes scripts for setting up the applications required for this package’s use cases and workflows
- Configuration scripts to setup required configuration metadata
- Extensions to the test harness to test the added use cases with test data
...
| de34cfdd71bb%22%2C%22title%22%3A%22Configure%20for%20Use%20Case%22%2C%22description%22%3A%22%22%2C%22duration%22%3A1.9801980198019802%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%5D%2C%22markers%22%3A%5B%7B%22markerDate%22%3A%222020-10-31%2016%3A38%3A01%22%2C%22title%22%3A%22Quarterly%20Progress%20Report%22%7D%5D%7D | | title | Roadmap%20Planner |
|---|
| hash | 21568cfea624f5c62f74bf7a545d5084 |
|---|
|
Illustrative Roadmap for Future Use Cases
| Roadmap Planner |
|---|
| maplinks | |
|---|
| timeline | true |
|---|
| pagelinks | |
|---|
| source | %7B%22title%22%3A%22Roadmap%20Planner%22%2C%22timeline%22%3A%7B%22startDate%22%3A%222021-01-01%2000%3A00%3A00%22%2C%22endDate%22%3A%222021-12-31%2000%3A00%3A00%22%2C%22displayOption%22%3A%22MONTH%22%7D%2C%22lanes%22%3A%5B%7B%22title%22%3A%22Phase%202%2C3%20etc.%20-%20Extensions%22%2C%22color%22%3A%7B%22lane%22%3A%22%233b7fc4%22%2C%22bar%22%3A%22%236c9fd3%22%2C%22text%22%3A%22%23ffffff%22%2C%22count%22%3A1%7D%2C%22bars%22%3A%5B%7B%22title%22%3A%22Package%20Definition%22%2C%22description%22%3A%22This%20is%20the%20first%20bar.%22%2C%22startDate%22%3A%222020-01-01%2004%3A03%3A05%22%2C%22duration%22%3A2%2C%22rowIndex%22%3A0%2C%22id%22%3A%226485467a-7138-4868-b648-22eff36d7ca9%22%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A0%2C%22startDate%22%3A%222021-01-01%2004%3A03%3A05%22%2C%22id%22%3A%226e6849c0-fdd0-4743-926e-e80cdffeceff%22%2C%22title%22%3A%22Package%20Definition%22%2C%22description%22%3A%22%22%2C%22duration%22%3A1.9801980198019802%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A1%2C%22startDate%22%3A%222021-03-01%2004%3A03%3A05%22%2C%22id%22%3A%2298610354-420a-4a0b-833e-d09fb94aeb66%22%2C%22title%22%3A%22Docker%20Scripts%20for%20Relevant%20Tools%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2.9603960396039604%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A2%2C%22startDate%22%3A%222021-03-01%2011%3A25%3A03%22%2C%22id%22%3A%223fbee878-6712-4961-a154-9deb25e0d015%22%2C%22title%22%3A%22Kubernetes%20Scripts%20for%20Relevant%20Tools%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2.9603960396039604%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A3%2C%22startDate%22%3A%222021-05-31%2020%3A41%3A06%22%2C%22id%22%3A%22b8a5da33-c209-4a45-89c4-74cb8bb7fc91%22%2C%22title%22%3A%22Config%20Scripts%20to%20Setup%20Workflows%20and%20Metadata%22%2C%22description%22%3A%22%22%2C%22duration%22%3A3.9504950495049505%2C%22pageLink%22%3A%7B%7D%7D%2C%7B%22rowIndex%22%3A4%2C%22startDate%22%3A%222021-09-29%2016%3A59%3A24%22%2C%22id%22%3A%22a6746aa2-7dd6-4204-834b-fd7f18981dd4%22%2C%22title%22%3A%22Test%20Harness%22%2C%22description%22%3A%22%22%2C%22duration%22%3A2.8118811881188117%2C%22pageLink%22%3A%7B%7D%7D%5D%7D%5D%2C%22markers%22%3A%5B%5D%7D |
|---|
| title | Roadmap%20Planner |
|---|
| hash | 82a6bb718d8224bc8acc4762c7fa34a1 |
|---|
|
Documentation and Architecture
For more information about Instant OpenHIE see the user documentation.
For an depth description of the architecture see to following links:
- For documentation and architecture relating to the first phase see the Instant OpenHIE Technical Architecture.
- For the generic architecture of Instant OpenHIE see the architecture section of the user documentation.
Contributing
Instant OpenHIE is designed to be extensible. There are two broad areas of contribution to the Instant OpenHIE stack:
- Contributing new components/apps to new and existing packages,
- Contributing new sets of workflows, use cases and tests to new and existing packages.
When contributing new components/apps, the following artefacts are expected to be produced to support this:
App owner responsibilities | Description |
Tagged releases | Releases should be tagged in git or other version control system and in a public repository. |
| Environment variables | Configurations must be stored in or be able to be overridden by environment variables. See the Twelve Factor App: https://12factor.net/config |
Dockerfile | Create a publicly available Dockerfile used to build the image and a link to it. |
Container image | Make available a link to a public image of the application. A tagged release image should be available. |
Docker Compose | Provide a link to a versioned Docker Compose script. A Docker Compose file should exist for running the application stack, including databases or web servers or other needs. Where possible use existing containers for things like databases or web servers. Slim images (e.g. Alpine) are recommended as many images will be run concurrently. |
Automated configuration | Provide detailed information or scripts that can run in a non-GUI environment for automated configuration. |
When contributing new workflows or implementation use cases, the following artefacts are expected to be produced to support this:
Workflow owner responsibilities | Description |
Test data | Generate fake but realistic data for E2E tests and general functionality. |
Package test data | Make test data available or reproducible online. |
Tests | Write tests for the expected workflows supported using the containers, configuration, and fake data. |
Dockerfile | Tests can be written in any language. Provide a Docker container for tests so that they can be run easily (with environment variables) against any stack (not just Instant OpenHIE) |
Container image | Make available a link to a public image of the tests. A tagged release image should be available. |
Project Team
Digital Square
Jembi Health Systems
IntraHealth International
Engaging with Us
Please join us in the OpenHIE DevOps Community https://groups.google.com/forum/#!forum/ohie-devopsCommunity Call DevOps Subcommunity Calls
or, in the OpenHIE Architecture Community https://groups.google.com/forum/#!forum/ohie-architecture