healthcare.projects.locations.datasets.fhir Stores.fhir.Patient-everything

GET {{baseUrl}}/v1/:name/$everything?_count=<integer>&_page_token=<string>&_since=<string>&_type=<string>&end=<string>&start=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

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 will contain a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the operation. Errors generated by the FHIR store will 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. For samples that show how to call Patient-everything, see Getting all patient compartment resources.

Request Params

Key	Datatype	Description
`_count`	string	Maximum number of resources in a page. Defaults to 100.
`_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.
`_since`	string	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	String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned.
`end`	string	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.
`start`	string	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.
`$.xgafv`	string	V1 error format.
`access_token`	string	OAuth access token.
`alt`	string	Data format for response.
`callback`	string	JSONP
`fields`	string	Selector specifying which fields to include in a partial response.
`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.
`oauth_token`	string	OAuth 2.0 token for the current user.
`prettyPrint`	string	Returns response with indentations and line breaks.
`quotaUser`	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.
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;contentType&quot;:&quot;\u003cstring\u003e&quot;,&quot;data&quot;:&quot;\u003cbyte\u003e&quot;,&quot;extensions&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;]}