Response Pagination
© 2021-2023 Opala. All Rights Reserved.
Version 1.1.1.3
When the number of response items in a query exceeds the number that can be displayed at a single time, Opala uses response pagination to divide the response items into pages. This results in the addition of a next link within the response bundle.
Since this is server-level based functionality, Opala recommends you use the next link provided, without alteration, in order to maintain the original request results.
The type of link returned depends on the type of bundle you receive.
Type | Example Pagination Link |
---|---|
Patient and DocumentReference | [baseURL]/[Resource]?_getpages=[AssociatedBundleResourceID]&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset |
Clinical, Administrative, and Provider Directory | [baseURL]/[Resource]?[original-search-parameters]&ct=[servergenerated-code] |
The searchset bundle is the complete set of search result entries, and the continuation URL is the link provided by the FHIR service to retrieve the entries that don't fit in the first subset due to restrictions on the maximum number of entries returned for a single page. If the remaining results don't all fit on the next page, another continuation URL is provided and you can use that to retrieve the next set of results.
To retrieve the next set of results, make a GET
request for the provided URL.
GET [baseURL]/[Resource]?_getpages=[AssociatedBundleResourceID]&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset
or
GET [baseURL]/[Resource]?[original-search-parameters]&ct=[servergenerated-code]