cloud-healthcare-fhir-patient-search Tool
A “cloud-healthcare-fhir-patient-search” tool searches for patients in a FHIR store.
2 minute read
About
A cloud-healthcare-fhir-patient-search tool searches for patients in a FHIR
store based on a set of criteria.
cloud-healthcare-fhir-patient-search returns a list of patients that match the
given criteria.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Cloud Healthcare API Source |
Example
kind: tools
name: fhir_patient_search
type: cloud-healthcare-fhir-patient-search
source: my-healthcare-source
description: Use this tool to search for patients in the FHIR store.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “cloud-healthcare-fhir-patient-search”. |
| source | string | true | Name of the healthcare source. |
| description | string | true | Description of the tool that is passed to the LLM. |
Parameters
| field | type | required | description |
|---|---|---|---|
| active | string | false | Whether the patient record is active. |
| city | string | false | The city of the patient’s address. |
| country | string | false | The country of the patient’s address. |
| postalcode | string | false | The postal code of the patient’s address. |
| state | string | false | The state of the patient’s address. |
| addressSubstring | string | false | A substring to search for in any address field. |
| birthDateRange | string | false | A date range for the patient’s birth date in the format YYYY-MM-DD/YYYY-MM-DD. |
| deathDateRange | string | false | A date range for the patient’s death date in the format YYYY-MM-DD/YYYY-MM-DD. |
| deceased | string | false | Whether the patient is deceased. |
| string | false | The patient’s email address. | |
| gender | string | false | The patient’s gender. |
| addressUse | string | false | The use of the patient’s address. |
| name | string | false | The patient’s name. |
| givenName | string | false | A portion of the given name of the patient. |
| familyName | string | false | A portion of the family name of the patient. |
| phone | string | false | The patient’s phone number. |
| language | string | false | The patient’s preferred language. |
| identifier | string | false | An identifier for the patient. |
| summary | boolean | false | Requests the server to return a subset of the resource. True by default. |
| storeID | string | true* | The FHIR store ID to search in. |
*If the allowedFHIRStores in the source has length 1, then the storeID
parameter is not needed.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.