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.
Scopes
You will need authorization for at least one of the following scopes to make a valid call:
- https://www.googleapis.com/auth/cloud-healthcare
- https://www.googleapis.com/auth/cloud-platform
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-healthcare.
You can set the scope for this method like this: healthcare1-beta1 --scope <scope> projects locations-datasets-fhir-stores-fhir--resource-incoming-references ...
Required Scalar Argument
- <parent> (string)
- Required. The name of the FHIR store that holds the target resource.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p -count=integer
- Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
-
-p -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, wherelink.relation
is "next". Omit_page_token
if no previous request has been made.
- Used to retrieve the next page of results when using pagination. Set
-
-p -summary=string
- Used to simplify the representation of the returned resources.
_summary=text
returns only thetext
,id
, andmeta
top-level fields._summary=data
removes thetext
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).
- Used to simplify the representation of the returned resources.
-
-p -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.
-
-p 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.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").