google / android-fhir

The Android FHIR SDK is a set of Kotlin libraries for building offline-capable, mobile-first healthcare applications using the HL7® FHIR® standard on Android.
https://google.github.io/android-fhir/
Apache License 2.0
494 stars 295 forks source link

Update documentation with search API best practice #2684

Open ndegwamartin opened 1 month ago

ndegwamartin commented 1 month ago

Describe the Issue We need to add to the documentation some tips and recommendations on how we to efficiently use some of our APIs of interest.

For example, when using the search API there's a significant performance hit if one makes a request for all the records when they span the thousands. See metrics here. A better approach would be to paginate the request and fetch in batches to only return to the user the records they need e.g. 10 or 20 records to render in a view.

cc @jingtang10 @ellykits @aditya-07 @santosh-pingle @nsabale7

VishalGawade1 commented 3 weeks ago

Hello @ndegwamartin , I’m interested in working on this issue. Could you please let me know if it's still available and if there are any specific guidelines or pointers to keep in mind? Thank you!