android-fhir icon indicating copy to clipboard operation
android-fhir copied to clipboard

Update documentation with search API best practice

Open ndegwamartin opened this issue 1 year ago • 3 comments

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

ndegwamartin avatar Oct 01 '24 12:10 ndegwamartin

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!

VishalGawade1 avatar Oct 30 '24 04:10 VishalGawade1

Hi 👋 I've opened a pull request that adds performance and pagination usage guidance to the FhirEngine.search() KDoc as discussed in this issue.

PR: #2834

Please let me know if there are any suggestions or improvements you'd like me to make. Happy to contribute!

himanshu-pandey-git avatar Jul 05 '25 20:07 himanshu-pandey-git

Hi @ndegwamartin , can I pick up this issue?

DeTuksa avatar Nov 17 '25 10:11 DeTuksa