medic · andrablaj · Feb 3, 2025 · Feb 4, 2025
diff --git a/README.md b/README.md
@@ -1,127 +1,5 @@
 # CHT Interoperability
 
-## Overview
+This project implements interoperability between the CHT and other health information systems based on [OpenHIE architecture](https://ohie.org/) and [HL7 FHIR](https://www.hl7.org/fhir/index.html) messaging format.
 
-This project implements a Loss to Follow Up (LTFU) workflow system for CHIS based on [OpenHIE LTFU Guide](https://wiki.ohie.org/display/CP/Use+Case+Summary%3A+Request+Community+Based+Follow-Up).
-
-#### Components
-
-The components and reference information for interoperability used in this project are:
-
-- [OpenHIE](https://ohie.org/) defines the architecture for an interoperability layer.
-- [OpenHIM](http://openhim.org/) is a middleware component designed to ease interoperability between systems.
-- [HL7 FHIR](https://www.hl7.org/fhir/index.html) is a messaging format to allow all systems to understand the format of the message.
-
-#### CHT
-
-The structure of documents in the CHT database reflect the configuration of the system, and therefore do not map directly to a FHIR message format. To achieve interoperability we used a middleware to convert the CHT data structure into a standardized form so the other systems can read it. Below is the standard data workflow:
-
-![](./docs/images/flow.png)
-
-This project uses OpenHIM as the middleware component with [Mediators](http://openhim.org/docs/configuration/mediators/) to do the conversion. [Outbound Push](https://docs.communityhealthtoolkit.org/apps/reference/app-settings/outbound/) is configured to make a request to the middleware when relevant documents are created or modified in the CHT. A Mediator then creates a FHIR resource which is then routed to OpenHIM. OpenHIM routes the resource to any other configured systems.
-
-Conversely, to bring data into the CHT, OpenHIM is configured to route the updated resource to the Mediator, which then calls the relevant [CHT APIs](https://docs.communityhealthtoolkit.org/apps/reference/api/) to update the document in the CHT database. This will then be replicated to users’ devices as per usual.
-
-See more information on the [CHT interoperability](https://docs.communityhealthtoolkit.org/apps/concepts/interoperability/) page on the CHT documentation site.
-
-[GitHub repository for the kubernetes configuration](https://github.com/medic/interoperability-kubernetes/).
-
-### Workflow Sequence Diagram
-
-![](./docs/sequence-diagram/diagram.png)
-
-### FHIR Resources
-
-The following [FHIR Resources](https://www.hl7.org/fhir/resource.html) are used to implement the flow above:
-
-- [Patient](https://www.hl7.org/fhir/patient.html)
-- [Encounter](https://build.fhir.org/encounter.html)
-- [Subscription](https://build.fhir.org/subscription.html)
-- [Organization](https://build.fhir.org/organization.html)
-- [Endpoint](https://build.fhir.org/endpoint.html)
-
-### Test LTFU Workflow
-
-The [workflow guide](./WORKFLOW.md) explains the steps for testing the LTFU workflow using the local setup and the Medic instances. For the local setup, you are expected to have already completed the setup procedures outlined in this document in the section below.
-
-## Get Started with Local Setup
-
-### Prerequisites
-
-- `docker`
-- `Postman` or similar tool for API testing. This will play the role of the `Requesting System` from the sequence diagram above.
-
-### Troubleshooting
-
-Users getting errors when running the following installation steps, please see the [Troubleshooting guide](/TROUBLESHOOTING.md).
-
-### Install & First Time Run
-
-1. Run `./startup.sh init` to start-up the docker containers on the first run or after calling `./startup.sh destroy`. Use `./startup.sh up` for subsequent runs after calling `init` without calling `destroy`.
-
-### OpenHIM Admin Console
-
-1. Visit the OpenHIM Admin Console at http://localhost:9000 and login with the following credentials: email - `interop@openhim.org` and password - `interop-password`. The default User username for OpenHIM is `interop@openhim.org` and password is `interop-password`. The default Client username is `interop-client` and password is `interop-password`.
-
-1. Once logged in, visit [http://localhost:9000/#!/mediators](http://localhost:9000/#!/mediators) and select the only mediator with the `Name` 'Loss to Follow Up Mediator'.
-
-1. Select the green `+` button to the right of the default channel to add the mediator.
-
-1. You can test the mediator by running:
-
-```bash
-curl -X GET http://localhost:5001/mediator -H "Authorization: Basic $(echo -n interop-client:interop-password | base64)"
-```
-
-You should get as a response:
-
-```json
-{ "status": "success" }
-```
-
-If everything is successful you should see this:
-
-<img src="./docs/images/good-client-screen.png" width="600">
-
-### CHT configuration with Docker
-
-The following steps apply when running CHT via the Docker setup provided in this repository:
-
-1. CHT can be accessed via `http://localhost:5988`, and the credentials are `medic`/`password`.
-2. Create a new user in the CHT instance with the username `interop-client` using these [instructions](https://docs.communityhealthtoolkit.org/apps/tutorials/contact-and-users-1/#4-create-the-chw-user). For the role you can select `Data entry` and `Analytics` roles. Please note that you can use any username you prefer but you would have to update the config with the new username. You can do that by editing the `cht-config/app_settings.json` file and updating the `username` value in the `outbound` object e.g. on this [line](https://github.com/medic/interoperability/blob/main/cht-config/app_settings.json#L452).
-3. Securely save the `interop-client` user's password to the database using the instructions [here](https://docs.communityhealthtoolkit.org/apps/reference/api/#credentials). Change the values `mykey` and `my pass` to `openhim1` and your user's password respectively. An example of the curls request is below:
-
-```bash
-curl -X PUT -H "Content-Type: text/plain" http://medic:password@localhost:5988/api/v1/credentials/openhim1 -d 'interop-password'
-```
-
-### Local setup of CHT Configuration
-
-The following steps apply when running CHT locally in development mode and when making configuration changes locally:
-
-#### CHT Development Environment
-
-1. Set up a local CHT instance using [these instructions](https://docs.communityhealthtoolkit.org/apps/tutorials/local-setup/).
-2. Create a new user in the CHT instance with the username `interop-client` using these [instructions](https://docs.communityhealthtoolkit.org/apps/tutorials/contact-and-users-1/#4-create-the-chw-user). For the role you can select `Data entry` and `Analytics` roles. Please note that you can use any username you prefer but you would have to update the config with the new username. You can do that by editing the `cht-config/app_settings.json` file and updating the `username` value in the `outbound` object e.g. on this [line](https://github.com/medic/interoperability/blob/main/cht-config/app_settings.json#L452).
-3. Securely save the `interop-client` user's password to the database using the instructions [here](https://docs.communityhealthtoolkit.org/apps/reference/api/#credentials). Change the values `mykey` and `my pass` to `openhim1` and your user's password respectively. An example of the curls request is below:
-
-```bash
-curl -X PUT -H "Content-Type: text/plain" http://medic:password@localhost:5988/api/v1/credentials/openhim1 -d 'interop-password'
-```
-4. After updating the mediator code or cht configuration, you need to run `./startup.sh up-dev` to upload the changes to docker compose.
-
-#### CHT Configuration
-
-1. Go into the `cht-config` directory by running `cd cht-config`.
-1. Run `npm install` to install the dependencies.
-1. Create a file named `.env` under `/mediator` folder, copy over the contents of `/mediator/.env.template` and update the `CHT_USERNAME` and `CHT_PASSWORD` values with the admin credentials of your CHT instance.
-1. Set up a proxy to your local CHT instance by running using something like [nginx-local-ip](https://github.com/medic/nginx-local-ip) or [ngrok](https://ngrok.com/) and update the `CHT_URL` value in the `.env` file with the new URL.
-1. Ensure you have [cht-conf](https://www.npmjs.com/package/cht-conf) installed and run `cht --local` to compile and upload the app settings configuration to your local CHT instance.
-1. To verify if the configuration is loaded correctly is to create a `Patient` and to access a URL like `https://*****.my.local-ip.co/#/contacts/patientUUID/report/interop_follow_up`. This should retrieve correctly the follow up form.
-1. To verify if the configuration in CouchDB, access `http://localhost:5984/_utils/#database/medic/settings`.
-
-### Shutdown the servers
-
-- To shut-down the containers run `./startup.sh down` to stop the instances.
-- To then restart the containers, run `./startup.sh up`. You do not need to run `init` again like you did in the initial install above.
-- To shut-down and delete _everything_, run `./startup.sh destroy`. You will have to subsequently run `./startup.sh init` if you wish to start the containers.
+Read more detail on the [CHT docs site](https://docs.communityhealthtoolkit.org/building/interoperability/).
diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md