REST Resource: projects.locations.datasets.fhirStores.fhir

Resource: HttpBody

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc fhir.read(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc fhir.update(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

JSON representation 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Fields
contentType

string

The HTTP Content-Type header value specifying the content type of the body.
data

string (bytes format)

The HTTP request/response body as raw binary.

A base64-encoded string.
extensions[]

object

Application specific response metadata. Must be set in the first response for streaming APIs.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Methods

Binary-create

 Creates a FHIR Binary resource.

Binary-read

 Gets the contents of a FHIR Binary resource.

Binary-update

 Updates the entire contents of a Binary resource.

Binary-vread

 Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID.
Returns the consent enforcement status of a single consent resource.
Returns the consent enforcement status of all consent resources for a patient.

Patient-everything

 Retrieves a Patient resource and resources related to that patient.

Resource-purge

 Deletes all the historical versions of a resource (excluding the current version) from the FHIR store.

Resource-validate

 Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store.

bulk-export

 Bulk exports all resources from the FHIR store to the specified destination.

capabilities

 Gets the FHIR capability statement (STU3, R4, R5), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server.

conditionalDelete

 Deletes a FHIR resource that match an identifier search query.

conditionalPatch

 If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a JSON Patch document.

conditionalUpdate

 If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource.

create

 Creates a FHIR resource.

delete

 Deletes a FHIR resource.

executeBundle

 Executes all the requests in the given Bundle.

history

 Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store.

patch

 Updates part of an existing resource by applying the operations specified in a JSON Patch document.

read

 Gets the contents of a FHIR resource.
Searches for resources in the given FHIR store according to criteria specified as query parameters.

search-type

 Searches for resources in the given FHIR store according to criteria specified as query parameters.

update

 Updates the entire contents of a resource.

vread

 Gets the contents of a version (current or historical) of a FHIR resource by version ID.