chore(#1658): add openmrs and ltfu docs #1657
Conversation
andrablaj
changed the title
andrablaj
changed the title
content/en/building/guides/interoperability/ltfu_reference_workflow.md
Outdated
Show resolved
Hide resolved
content/en/building/guides/interoperability/ltfu_reference_workflow.md
Outdated
Show resolved
Hide resolved
| 3. Receiving patient and patient contact data from OpenMRS. | ||
| 4. Receiving reports data (encounters and observations) from OpenMRS. | ||
|
|
||
| The steps to create an OpenMRS interoperability workflow are: |
There was a problem hiding this comment.
The steps could be more actionable and descriptive to ensure readers understand each part thoroughly.
| 1. Install the address hierarchy add-on. | ||
| 2. Download the contact hierarchy from the CHT application. | ||
| 3. Upload these contacts to OpenMRS: address 5 should be a CHW area, or the direct parent of the patient. If address 5 is not specified, the mediator will use address 4. | ||
| 4. The mediator will attempt to find CHT locations by using a place id formatted like `[12345]` at the end of the address string. `place_id` must match a CHT place id. If `place_id` is not included in the OpenMRS addresses, the mediator will attempt to match by the place name. This is not as reliable since the name must match exactly, and changes to either the CHT or OpenMRS will |
There was a problem hiding this comment.
Steps 1 to 4 assume familiarity with OpenMRS and CHT address configurations. To make it easier for users to set up, adding:
- A link to any available installation documentation for the address hierarchy add-on would be a good idea.
- How to download the contact hierarchy from the CHT application? Include steps like which tools or interfaces to use (e.g., API endpoints or admin UI).
- How can users upload these contacts to OpenMRS? If a specific OpenMRS module or upload method is needed, please mention it explicitly.
| All patients in CHT applications require a parent, which is assumed to be a CHW area or equivalent and defines which CHW the patient is assigned to. | ||
| For interoperability with OpenMRS, this means that patients created by OpenMRS must be matched to CHT locations. | ||
|
|
||
| A default implementation is provided which uses the [OpenMRS address add on](https://addons.openmrs.org/show/org.openmrs.module.addresshierarchy) to match locations in OpenMRS to contacts in CHT. |
There was a problem hiding this comment.
Do we include this add-on in cht-interoperability?
|
|
||
| Patients that do not have an address or otherwise cannot be assigned a parent in CHT will be queryable in the FHIR Server and linked to OpenMRS patients, but will not be sent to CHT. | ||
|
|
||
| After setting up the forms, test that it works in the test environment by creating a patient in OpenMRS. |
There was a problem hiding this comment.
Can you add an example of a Patient creation in OpenMRS? maybe the JSON?
| 1. A request to the FHIR server updating the patient with the corresponding id from CHT. | ||
| 1. A request to OpenMRS with the CHT id. | ||
|
|
||
| If all the above look OK, you should now be able to see the patient in CHT. |
There was a problem hiding this comment.
Here, showing an image of the patient in CHT would be a good idea. Could you compare it with the Patient creation example at the beginning of this instruction?
There was a problem hiding this comment.
A similar workflow testing doc is an excellent complement to this documentation. And the corresponding Postman collection for local testing
Co-authored-by: njuguna-n <[email protected]>
|
@witash I merged the |
There was a problem hiding this comment.
Thank you for the extended work in putting together this doc!
I shared a first batch of suggestions. Mainly:
- Replace
_with-in the file/folder names. - Simplify
linkTitlenames to make the hierarchy simpler to read and navigate. - Added
weightto pages so that the guides appear in a logical order.
I will go through the OpenMRS steps and add more comments, if any.
content/en/building/guides/interoperability/ltfu_reference_workflow.md
Outdated
Show resolved
Hide resolved
content/en/building/guides/interoperability/ltfu_reference_workflow.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Andra Blaj <[email protected]>
|
I removed the section on incoming patients from OpenMRS. Although technically the Gandaki flow does support this, it requires a lot of steps that may be difficult to generalize, so maybe we can not support this "officially" or include any documentation on it, which will necessarily either be incomplete, or add a lot stuff to this document. |
|
@witash I see various updates on this PR. Is it ready for another review? |
Description
Closes #1658
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.