Enrich examples for Satusehat Adaptor

[AishaHassen]

The current Satusehat adaptor has some examples but it would be nice to add more examples in the FHIR context.

Tasks

1. Add an Overview section for it taking some excerpts from here
2. Confirm that the Configuration section has accurate information for configuring the auth on CLI
3. Add a description on how to add authentication to the New Credentials section on app.openfn.org
4. For each example in Functions, show how they correspond to the Satusehat postman collection
5. Add examples in Functions on querying using IHS, and other FHIR resources such as NIK
6. Add an example in Functions showing a put and a post request using a FHIR resource such as an Encounter
7. Create an Examples section and add some code excerpts from the HIH workflow

[aleksa-krolls]

thanks @AishaHassen - will add to next week's sprint or the week after

[josephjclark]

I know Ayodele has been working on a plan for Overview pages. I don't know how advanced he is with it but please loop him in before addressing the Overview!

Regarding postman mappings to examples - this is an interesting area but I'm not sure the best way to go about it. It's been on my list since AkiraChix but I've not touched it! yet. Can we have a connect on it before taking any action here?

[AishaHassen]

@josephjclark will check with Ayodele before starting the Overview and we can sync on the postman mapping thing tomorrow? I will send an invite.

[josephjclark]

Thank you for your time @AishaHassen

I think the biggest takeaway for me is that the Satusehat examples should be based on examples in in the postman collection. I don't think we need to link to the collection directly (we could, but as you say the link might break), but it will let us use more realistic and relevant information in the examples.

I am not convinced that showing mappings to postman directly is a great educational tool, but I do agree that we should have better examples of how to build Satusehat URLs. Or, like, if I do get('Encounter', { subject: 1}), it maps to a url of ${baseUrl}/Encounter?subject=1. The docs and examples don't help make that connection.

We might also explore that relationship more in the readme and/or Overview section.

@hunterachieng I think first step is to have an example which maps to Get Encounter by Subject

[AishaHassen]

Thanks for the summary @josephjclark. I'm not very adamant that we should have a Postman in our examples, but this

Or, like, if I do get('Encounter', { subject: 1}), it maps to a url of ${baseUrl}/Encounter?subject=1

is more than enough for me or for any new Satusehat Adaptor user