Skip to content

Add performance and pagination guidance to FhirEngine.search KDoc (#2684) #2834

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add performance and pagination guidance to FhirEngine.search KDoc (#2684) #2834

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8b9240
Update Search.kt
himanshu-pandey-git Jul 5, 2025
748ac08
Merge branch 'master' into doc/2684-search-pagination-guidelines
himanshu-pandey-git Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions engine/src/main/java/com/google/android/fhir/search/Search.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,25 @@ import org.hl7.fhir.r4.model.ResourceType
* })
* }
* ```
* ### Performance Tip:
* Avoid requesting all resources at once — especially if they number in the thousands — as it can
* significantly impact performance due to memory use and JSON deserialization overhead.
*
* ### Recommended Usage:
* Always paginate queries using `.count()` and `.from()` in [Search] to fetch only the number of
* results needed for the UI.
*
* Example (Paginated Search):
* ```
* val results = fhirEngine.search<Patient> {
* count = 20 // Limit to 20 results
* from = 0 // Offset for pagination
* }
* ```
*
* For technical context, see:
* - Issue: https://github.com/google/android-fhir/issues/2684
* - PR with performance metrics: https://github.com/google/android-fhir/pull/2669
*
* @param init The lambda expression used to configure the [Search] object.
* @return A list of [SearchResult] objects containing the matching resources and any included
Expand Down