Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(#1658): add openmrs and ltfu docs #1657

Merged
merged 24 commits into from
Jan 27, 2025
Merged

chore(#1658): add openmrs and ltfu docs #1657

merged 24 commits into from
Jan 27, 2025

Conversation

witash
Copy link
Contributor

@witash witash commented Oct 28, 2024

Description

Closes #1658

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

@andrablaj andrablaj changed the title feat(#129): add openmrs and ltfu docs feat(#1658): add openmrs and ltfu docs Oct 28, 2024
@andrablaj andrablaj changed the title feat(#1658): add openmrs and ltfu docs chore(#1658): add openmrs and ltfu docs Oct 28, 2024
@witash witash marked this pull request as ready for review November 8, 2024 13:53
Copy link
Contributor

@njuguna-n njuguna-n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work on this! I have added some minor comments and typo fixes but approving now to unblock.

Copy link
Contributor

@lorerod lorerod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @witash. Left some suggestions inline. Let me know what you think.

content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
@andrablaj
Copy link
Member

@witash I merged the main branch into this branch to get the latest updates from the site revamp. This helps better understand the overall Building section structure.

Copy link
Member

@andrablaj andrablaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 linkTitle names to make the hierarchy simpler to read and navigate.
  • Added weight to 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/concepts/interoperability.md Outdated Show resolved Hide resolved
content/en/building/concepts/interoperability.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/cht_config.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
Copy link
Member

@andrablaj andrablaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions based on my own comments above.

@witash
Copy link
Contributor Author

witash commented Dec 13, 2024

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.

@andrablaj
Copy link
Member

@witash I see various updates on this PR. Is it ready for another review?

@witash
Copy link
Contributor Author

witash commented Jan 10, 2025

@witash I see various updates on this PR. Is it ready for another review?

I think this is ready for another review

@witash witash requested review from andrablaj, njuguna-n and lorerod and removed request for njuguna-n January 10, 2025 08:52
Copy link
Member

@andrablaj andrablaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@witash I reviewed the content but didn't try to reproduce the OpenMRS steps.

This is a massive amount of work, thank you for putting it together! ⚡️

I added a few non-blocking suggestions.

It would be lovely if someone could go through the OpenMRS setup steps (@lorerod, @mrjones-plip ?) to validate the clarity of the instructions. I will try to do this myself next week, but I don't want to be a blocker to having this merged.

content/en/building/guides/interoperability/ltfu.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/ltfu.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/ltfu.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
@lorerod
Copy link
Contributor

lorerod commented Jan 10, 2025

It would be lovely if someone could go through the OpenMRS setup steps (@lorerod, @mrjones-plip ?) to validate the clarity of the instructions. I will try to do this myself next week, but I don't want to be a blocker to having this merged.

@andrablaj, I have a pending re-review of this PR, and I will follow the OpenMRS setup steps next week.

@andrablaj andrablaj mentioned this pull request Jan 15, 2025
Copy link
Contributor

@lorerod lorerod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the effort you've put into this documentation. I’m reviewing it by reproducing the steps on my local machine using the cht-interoperability openmrs-mediator branch.

content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openhim.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
### Sending forms OpenMRS->CHT

When sending form data to CHT, first find, create, or import the concepts in OpenMRS, and create the forms in OpenMRS.
Then create a form in CHT to receive the reports [as described in the CHT interop config documentation]({{< ref "building/guides/interoperability/cht-config#outbound-reports" >}}); the codes from OpenMRS are the field names, and labels can be added for human readability.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is pre-configured in the cht-interoperability repository, please include a notice here.

@lorerod lorerod self-requested a review January 20, 2025 16:45
Copy link
Contributor

@lorerod lorerod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving this PR to unblock as the documentation aligns with what is expected, and we will address the pending issues in separate, independent tickets.

"gender": "male",
"birthDate": "1980-06-06"
}
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is expected, you can add a step to explain what this is.

content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
content/en/building/guides/interoperability/openmrs.md Outdated Show resolved Hide resolved
@witash witash merged commit 4b85d99 into main Jan 27, 2025
2 checks passed
@witash witash deleted the 129-openmrs-interop branch January 27, 2025 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation to include OpenMRS <> CHT interoperability functionalities
4 participants