CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything (Cloud Healthcare API v1beta1-rev20241009-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest<HttpBody>
        
        com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir

public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything
extends CloudHealthcareRequest<HttpBody>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected PatientEverything(String name)
Retrieves a Patient resource and resources related to that patient.

Constructors
Modifier	Constructor and Description
`protected`	`PatientEverything(String name)` Retrieves a Patient resource and resources related to that patient.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Integer`	`getCount()` Maximum number of resources in a page.
`String`	`getEnd()` The response includes records prior to the end date.
`String`	`getName()` Required.
`String`	`getPageToken()` Used to retrieve the next or previous page of results when using pagination.
`String`	`getSince()` If provided, only resources updated after this time are returned.
`String`	`getStart()` The response includes records subsequent to the start date.
`String`	`getType()` String of comma-delimited FHIR resource types.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`set(String parameterName, Object value)`
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setAccessToken(String accessToken)` OAuth access token.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setAlt(String alt)` Data format for response.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setCallback(String callback)` JSONP
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setCount(Integer count)` Maximum number of resources in a page.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setEnd(String end)` The response includes records prior to the end date.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setKey(String key)` API key.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setName(String name)` Required.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setPageToken(String pageToken)` Used to retrieve the next or previous page of results when using pagination.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setSince(String since)` If provided, only resources updated after this time are returned.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setStart(String start)` The response includes records subsequent to the start date.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setType(String type)` String of comma-delimited FHIR resource types.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - PatientEverything
```
protected PatientEverything(String name)
```
    Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). 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](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), 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](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#getting_all_patient_compartment_resources). Create a request for the method "fhir.Patient-everything". This request holds the parameters needed by the the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    PatientEverything#initialize(com.google.api.client.googleapis.services.Ab stractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. Name of the `Patient` resource for which the information is required.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<HttpBody>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<HttpBody>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudHealthcareRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudHealthcareRequest<HttpBody>
  - setAccessToken
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setAccessToken(String accessToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudHealthcareRequest<HttpBody>
  - setAlt
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setAlt(String alt)
```
    Description copied from class: CloudHealthcareRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudHealthcareRequest<HttpBody>
  - setCallback
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setCallback(String callback)
```
    Description copied from class: CloudHealthcareRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudHealthcareRequest<HttpBody>
  - setFields
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setFields(String fields)
```
    Description copied from class: CloudHealthcareRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudHealthcareRequest<HttpBody>
  - setKey
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setKey(String key)
```
    Description copied from class: CloudHealthcareRequest
    
    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.
    
    Overrides:
    
    setKey in class CloudHealthcareRequest<HttpBody>
  - setOauthToken
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setOauthToken(String oauthToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudHealthcareRequest<HttpBody>
  - setPrettyPrint
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudHealthcareRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudHealthcareRequest<HttpBody>
  - setQuotaUser
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setQuotaUser(String quotaUser)
```
    Description copied from class: CloudHealthcareRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class CloudHealthcareRequest<HttpBody>
  - setUploadType
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setUploadType(String uploadType)
```
    Description copied from class: CloudHealthcareRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudHealthcareRequest<HttpBody>
  - setUploadProtocol
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudHealthcareRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudHealthcareRequest<HttpBody>
  - getName
```
public String getName()
```
    Required. Name of the `Patient` resource for which the information is required.
  - setName
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setName(String name)
```
    Required. Name of the `Patient` resource for which the information is required.
  - getCount
```
public Integer getCount()
```
    Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
  - setCount
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setCount(Integer count)
```
    Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
  - getPageToken
```
public String getPageToken()
```
    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.
  - setPageToken
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setPageToken(String pageToken)
```
    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.
  - getSince
```
public String getSince()
```
    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.
  - setSince
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setSince(String since)
```
    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.
  - getType
```
public String getType()
```
    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.
  - setType
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setType(String type)
```
    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.
  - getEnd
```
public String getEnd()
```
    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.
  - setEnd
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setEnd(String end)
```
    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.
  - getStart
```
public String getStart()
```
    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.
  - setStart
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything setStart(String start)
```
    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.
  - set
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything set(String parameterName,
                                                                                         Object value)
```
    Overrides:
    
    set in class CloudHealthcareRequest<HttpBody>

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PatientEverything

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

getCount

setCount

getPageToken

setPageToken

getSince

setSince

getType

setType

getEnd

setEnd

getStart

setStart

set