Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalUpdateRequest
If a resource is found based on the search criteria specified in the query parameters,
updates the entire contents of that resource. Implements the FHIR standard conditional
update interaction (DSTU2,
STU3,
R4). Search terms are provided as query
parameters following the same pattern as the search method. If the search criteria identify
more than one match, the request returns a 412 Precondition Failed
error. If the search
criteria identify zero matches, and the supplied resource body contains an id
, and the
FHIR store has enable_update_create set, creates the resource with the client-specified ID.
It is strongly advised not to include or encode any sensitive data such as patient
identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path
recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in
reference fields within other resources. If the search criteria identify zero matches, and
the supplied resource body does not contain an id
, the resource is created with a
server-assigned ID as per the create method. The request body must contain a JSON-encoded
FHIR resource, and the request headers must contain Content-Type: application/fhir+json
.
On success, the response body contains a JSON-encoded representation of the updated
resource, including the server-assigned version ID. 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. This method requires thehealthcare.fhirStores.searchResources
and healthcare.fhirResources.update
permissions on the parent FHIR store. For samples that
show how to call conditionalUpdate
, see Conditionally updating a FHIR
resource.
Inheritance
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1beta1
Assembly: Google.Apis.CloudHealthcare.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalUpdateRequest : CloudHealthcareBaseServiceRequest<HttpBody>, IClientServiceRequest<HttpBody>, IClientServiceRequest
Constructors
ConditionalUpdateRequest(IClientService, HttpBody, string, string)
Constructs a new ConditionalUpdate request.
Declaration
public ConditionalUpdateRequest(IClientService service, HttpBody body, string parent, string type)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
HttpBody | body | |
string | parent | |
string | type |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Parent
Required. The name of the FHIR store this resource belongs to.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Type
Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). Must match the resource type in the provided content.
Declaration
[RequestParameter("type", RequestParameterType.Path)]
public virtual string Type { get; }
Property Value
Type | Description |
---|---|
string |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes ConditionalUpdate parameter list.
Declaration
protected override void InitParameters()