Review CHT Interoperability documentation

[andrablaj]

Currently, the CHT Interoperability documentation is focused on Loss To Follow-up workflow and is split across repos as follows:

CHT Interoperability repo:

• README - focused on LTFU workflow
• LTFU Workflow testing
• troubleshooting page
• docs folder: diagrams, postman collection for LTFU

Docs site:

• Interoperability overview
• LTFU example
• Building Interoperability with FHIR systems

As we will soon merge the OpenMRS mediator work, the documentation must be updated with OpenMRS <> CHT additional flows.

This seems like a perfect opportunity to reflect on organizing the documentation. What should we keep in the CHT Interoperability repo vs. the docs site?

[Phil-Mwago]

Thanks @andrablaj, I would add the ANC and PNC as examples of interop scenarios under examples on the doc site, I would propose to move some of the details in the ReadMe to the doc site. @esthermmoturi what do you think with the current doc site revamp? I have also created this ticket to track the changes we need to make on other partner sites.

[esthermmoturi]

Hey @Phil-Mwago and @andrablaj , thank you for actively working on documenting the work that's ongoing. With the revamp, I am working to group concepts rather than having them scattered throughout the docsite. The important thing to understand is what you would like to communicate with the audience in the long run? Do you foresee more work being done around interoperability(more workflows, integration with more systems etc?). Would you like a subsection that takes the reader from an overview of the concept, configuration, examples and troubleshooting?

[Phil-Mwago]

There will be more changes and updates we will need to add to the current documentation. An overview of where to place what would be best informed by the categories or structure you envision to have. I would prefer to have everything around interoperability under one category, then iterate from there. Subsections sound great, with one on the reference app (LTFU) and another that will talk about OpenMRS mediator work.

[andrablaj]

@Phil-Mwago @esthermmoturi thank you for your thoughts. Can you share a plan on how the documentation should be organized? What should stay in the repo vs. how pages should be organized and where on the docs site. This will give the team a great starting point to create those pages one by one.

[esthermmoturi]

1. As agreed during the meeting:
   • Missing on the current documentation.
     • General interoperability documentation. Documentation beyond LTFU workflow.
     • How interop fits in real-world situations.For example documentation on how data is transferred(patient records and forms)
   • The only thing to be kept on the README(not transferred to docsite) - link to local testing
2. Action items:
   • @esthermmoturi will work on a Draft document on how the Interop documentation will be arranged on the docsite(to be done by 27/06/2024)
   • @Phil-Mwago will work on the missing items with guidance from Mariachana and Tom

[andrablaj]

Related: #1555