Back to Genai Toolbox

cloud-healthcare-fhir-fetch-page

docs/en/integrations/cloudhealthcare/tools/cloud-healthcare-fhir-fetch-page.md

1.1.01.8 KB
Original Source

About

A cloud-healthcare-fhir-fetch-page tool fetches a page of FHIR resources from a given URL.

cloud-healthcare-fhir-fetch-page can be used for pagination when a previous tool call (like cloud-healthcare-fhir-patient-search or cloud-healthcare-fhir-patient-everything) returns a 'next' link in the response bundle.

Compatible Sources

{{< compatible-sources >}}

Example

yaml
kind: tool
name: get_fhir_store
type: cloud-healthcare-fhir-fetch-page
source: my-healthcare-source
description: Use this tool to fetch a page of FHIR resources from a FHIR Bundle's entry.link.url

Reference

fieldtyperequireddescription
typestringtrueMust be "cloud-healthcare-fhir-fetch-page".
sourcestringtrueName of the healthcare source.
descriptionstringtrueDescription of the tool that is passed to the LLM.

Parameters

fieldtyperequireddescription
pageURLstringtrueThe full URL of the FHIR page to fetch. This would usually be the value of Bundle.entry.link.url field within the response returned from FHIR search or FHIR patient everything operations.