Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.fhir.Resource-incoming-references
Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted.
On success, the response body contains a Bundle with type searchset, where each entry in the Bundle contains the full content of the resource. If the operation fails, an OperationOutcome is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.
HTTP request
GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$references
Required. The name of the FHIR store that holds the target resource.
Authorization requires the following IAM permission on the specified resource parent:
healthcare.fhirStores.searchResources
Query parameters
Parameters
target
string
Required. The target whose incoming references are requested. This param is required and must not be empty. It uses the format "ResourceType/ResourceID", for example, target=ResourceType/ResourceID.
_page_token
string
Used to retrieve the next page of results when using pagination. Set _page_token to the value of _page_token set in next page links' url. Next page are returned in the response bundle's links field, where link.relation is "next".
Omit _page_token if no previous request has been made.
_count
integer
Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
_summary
string
Used to simplify the representation of the returned resources. _summary=text returns only the text, id, and meta top-level fields. _summary=data removes the text field and returns all other fields. _summary=false returns all parts of the resource(s). Either not providing this parameter or providing an empty value to this parameter also returns all parts of the resource(s).
_type
string
String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. If not provided or an empty value is provided, no filter on the returned resource type(s) is applied.
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis endpoint retrieves all FHIR resources that directly reference a specified target resource, even if the target resource has been deleted.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the target resource to be specified in the format "ResourceType/ResourceID" using the \u003ccode\u003etarget\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe response is a FHIR Bundle of type \u003ccode\u003esearchset\u003c/code\u003e, containing the full content of each referencing resource, or an \u003ccode\u003eOperationOutcome\u003c/code\u003e if the operation fails.\u003c/p\u003e\n"],["\u003cp\u003ePagination is supported via the \u003ccode\u003e_page_token\u003c/code\u003e and \u003ccode\u003e_count\u003c/code\u003e query parameters, allowing retrieval of large sets of referencing resources in manageable chunks.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003e_summary\u003c/code\u003e query parameter offers options to simplify the returned resource data, allowing for only the most important information to be shown.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.Resource-incoming-references\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.Resource-incoming-references\n\nLists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted.\n\nOn success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$references`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
