Method: fhir.Resource-incoming-references

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.