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.

For samples that show how to call Patient-everything, see Getting all patient compartment resources.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everything

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

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

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

Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
_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. 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.

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.