Method: fhir.Patient-everything

Full name: projects.locations.datasets.fhirStores.fhir.Patient-everything

Retrieves a Patient resource and resources related to that patient.

Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4).

On success, the response body contains a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

The resources in scope for the response are:

  • The patient resource itself.
  • All the resources directly referenced by the patient resource.
  • Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition (DSTU2, STU3, R4), which details the eligible resource types and referencing search parameters.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Name of the Patient resource for which the information is required.

Query parameters



The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope.



The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope.



Used to retrieve the next or previous page of results when using pagination. Value should be set to the value of pageToken set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where link.relation is "previous" or "next".

Omit pageToken if no previous request has been made.



Maximum number of resources in a page. Defaults to 100.

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:


For more information, see the Authentication Overview.

Try it!