Stay organized with collections
Save and categorize content based on your preferences.
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, R5).
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, R5), which details the eligible resource types and referencing search parameters.
Required. Name of the Patient resource for which the information is required.
Authorization requires the following IAM permission on the specified resource name:
healthcare.fhirResources.get
Query parameters
Parameters
start
string
Optional. The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope.
end
string
Optional. The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope.
_page_token
string
Used to retrieve the next or previous page of results when using pagination. Set _page_token to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where link.relation is "previous" or "next".
Omit _page_token if no previous request has been made.
_count
integer
Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
_since
string
Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z. The time must be specified to the second and include a time zone.
_type
string
Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple _type parameters isn't supported. For example, the result of _type=Observation&_type=Encounter is undefined. Use _type=Observation,Encounter instead.
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-07-23 UTC."],[[["\u003cp\u003eThis endpoint, \u003ccode\u003ePatient-everything\u003c/code\u003e, retrieves a specified Patient resource along with all related resources, based on FHIR standards (DSTU2, STU3, R4).\u003c/p\u003e\n"],["\u003cp\u003eThe response is a \u003ccode\u003eBundle\u003c/code\u003e resource of type \u003ccode\u003esearchset\u003c/code\u003e, containing the requested patient data and any directly or indirectly referenced resources that are in the patient compartment, or an \u003ccode\u003eOperationOutcome\u003c/code\u003e resource describing any error.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires a \u003ccode\u003ename\u003c/code\u003e parameter, specifying the Patient resource, and it also supports optional query parameters like \u003ccode\u003estart\u003c/code\u003e, \u003ccode\u003eend\u003c/code\u003e, \u003ccode\u003e_page_token\u003c/code\u003e, \u003ccode\u003e_count\u003c/code\u003e, \u003ccode\u003e_since\u003c/code\u003e, and \u003ccode\u003e_type\u003c/code\u003e to filter the data.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully call this \u003ccode\u003eGET\u003c/code\u003e endpoint, it requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scopes, as well as \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permissions.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.Patient-everything\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.Patient-everything\n\nRetrieves a Patient resource and resources related to that patient.\n\nImplements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html), [R5](https://hl7.org/fhir/R5/patient-operation-everything.html)).\n\nOn 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.\n\nThe resources in scope for the response are:\n\n- The patient resource itself.\n- All the resources directly referenced by the patient resource.\n- 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](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html), [R5](http://hl7.org/fhir/R5/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters.\n\nFor samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everything`\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)."]]
