Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource
The "fhir" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResourceConstructors
FhirResource(IClientService)
Constructs a new resource.
Declaration
public FhirResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
BinaryCreate(HttpBody, string)
Creates a FHIR Binary resource. This method can be used to create a Binary resource either
by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource
is created with this method using the FHIR content type this method's behavior is the same
as
fhir.create.
If a resource type other than Binary is used in the request it's treated in the same way as
non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content
type is used in the request, a Binary resource will be generated, and the uploaded data will
be stored in the content field (DSTU2 and STU3), or the data field (R4). The
Binary resource's contentType will be filled in using the value of the Content-Type
header, and the securityContext field (not present in DSTU2) will be populated from the
X-Security-Context header if it exists. At this time securityContext has no special
behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method
is 1 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a
Binary resource. Some of the Healthcare API features, such as exporting to
BigQuery or
Pub/Sub
notifications
with full resource content, do not support Binary resources that are larger than 10 MB. In
these cases the resource's data field will be omitted. Instead, the
"http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to
indicate that including the data is unsupported. On success, an empty 201 Created
response is returned. The newly created resource's ID and version are returned in the
Location header. Using Prefer: representation=resource is not allowed for this method. The
definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryCreateRequest BinaryCreate(HttpBody body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | parent | Required. The name of the FHIR store this resource belongs to. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryCreateRequest |
BinaryRead(string)
Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary
resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a
raw data stream. If the FHIR Accept type is used this method will return a Binary resource
with the data base64-encoded, regardless of how the resource was created. The resource data
can be retrieved in base64-decoded form if the Accept type of the request matches the value
of the resource's contentType field. The definition of the Binary REST API can be found at
https://hl7.org/fhir/binary.html#rest.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryReadRequest BinaryRead(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Binary resource to retrieve. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryReadRequest |
BinaryUpdate(HttpBody, string)
Updates the entire contents of a Binary resource. If the specified resource does not exist
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. This method can be used to update a
Binary resource either by using one of the accepted FHIR JSON content types, or as a raw
data stream. If a resource is updated with this method using the FHIR content type this
method's behavior is the same as update. If a resource type other than Binary is used in
the request it will be treated in the same way as non-FHIR data. When a non-FHIR content
type is used in the request, a Binary resource will be generated using the ID from the
resource path, and the uploaded data will be stored in the content field (DSTU2 and
STU3), or the data field (R4). The Binary resource's contentType will be filled in
using the value of the Content-Type header, and the securityContext field (not present
in DSTU2) will be populated from the X-Security-Context header if it exists. At this
time securityContext has no special behavior in the Cloud Healthcare API. Note: the limit
on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type
instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such
as exporting to
BigQuery or
Pub/Sub
notifications
with full resource content, do not support Binary resources that are larger than 10 MB. In
these cases the resource's data field will be omitted. Instead, the
"http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to
indicate that including the data is unsupported. On success, an empty 200 OK response will
be returned, or a 201 Created if the resource did not exit. The resource's ID and version
are returned in the Location header. Using Prefer: representation=resource is not allowed
for this method. The definition of the Binary REST API can be found at
https://hl7.org/fhir/binary.html#rest.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryUpdateRequest BinaryUpdate(HttpBody body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | name | Required. The name of the resource to update. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryUpdateRequest |
BinaryVread(string)
Gets the contents of a version (current or historical) of a FHIR Binary resource by version
ID. This method can be used to retrieve a Binary resource version either by using the FHIR
JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR
Accept type is used this method will return a Binary resource with the data base64-encoded,
regardless of how the resource version was created. The resource data can be retrieved in
base64-decoded form if the Accept type of the request matches the value of the resource
version's contentType field. The definition of the Binary REST API can be found at
https://hl7.org/fhir/binary.html#rest.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryVreadRequest BinaryVread(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the Binary resource version to retrieve. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryVreadRequest |
Capabilities(string)
Gets the FHIR capability statement
(STU3,
R4), or the
conformance statement in
the DSTU2 case for the store, which contains a description of functionality supported by the
server. Implements the FHIR standard capabilities interaction
(STU3,
R4), or the
conformance
interaction in the
DSTU2 case. On success, the response body contains a JSON-encoded representation of a
CapabilityStatement resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CapabilitiesRequest Capabilities(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. Name of the FHIR store to retrieve the capabilities for. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CapabilitiesRequest |
ConditionalDelete(string, string)
Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard
conditional delete interaction, limited to searching by resource identifier. If multiple
resources match, 412 Precondition Failed error will be returned. Search term for identifier
should be in the pattern identifier=system|value or identifier=value - similar to the
search method on resources with a specific identifier. Note: Unless resource versioning is
disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted
resource is moved to a history repository that can still be retrieved through vread and
related methods, unless they are removed by the purge method. For samples that show how to
call conditionalDelete, see Conditionally deleting a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalDeleteRequest ConditionalDelete(string parent, string type)Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The name of the FHIR store this resource belongs to. |
| string | type | Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalDeleteRequest |
ConditionalPatch(HttpBody, string, string)
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. Implements the FHIR standard conditional patch
interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional
patch method, but the server supports it in the same way it supports STU3. Search term for
identifier should be in the pattern identifier=system|value or identifier=value -
similar to the search method on resources with a specific identifier. If the search
criteria identify more than one match, the request returns a 412 Precondition Failed
error. The request body must contain a JSON Patch document, and the request headers must
contain Content-Type: application/json-patch+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. For samples that show how to
call conditionalPatch, see Conditionally patching a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalPatchRequest ConditionalPatch(HttpBody body, string parent, string type)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | parent | Required. The name of the FHIR store this resource belongs to. |
| string | 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). |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalPatchRequest |
ConditionalUpdate(HttpBody, string, string)
If a resource is found with the identifier specified in the query parameters, updates the
entire contents of that resource. Implements the FHIR standard conditional update
interaction, limited to searching by resource identifier. Search term for identifier should
be in the pattern identifier=system|value or identifier=value - similar to the search
method on resources with a specific identifier. 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. For samples that show how to call conditionalUpdate, see
Conditionally updating a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalUpdateRequest ConditionalUpdate(HttpBody body, string parent, string type)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | parent | Required. The name of the FHIR store this resource belongs to. |
| string | 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. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalUpdateRequest |
Create(HttpBody, string, string)
Creates a FHIR resource. Implements the FHIR standard create interaction
(DSTU2,
STU3,
R4), which creates a new
resource with a server-assigned resource ID. Also supports the FHIR standard conditional
create interaction
(DSTU2,
STU3,
R4), specified by supplying
an If-None-Exist header containing a FHIR search query, limited to searching by resource
identifier. If no resources match this search query, the server processes the create
operation as normal. When using conditional create, the search term for identifier should be
in the pattern identifier=system|value or identifier=value - similar to the search
method on resources with a specific identifier. 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 resource as it
was created on the server, including the server-assigned resource ID and 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. For samples that show how to call
create, see Creating a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CreateRequest Create(HttpBody body, string parent, string type)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | parent | Required. The name of the FHIR store this resource belongs to. |
| string | type | Required. The FHIR resource type to create, 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. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CreateRequest |
Delete(string)
Deletes a FHIR resource. Implements the FHIR standard delete interaction
(DSTU2,
STU3,
R4). Note: Unless resource
versioning is disabled by setting the disable_resource_versioning flag on the FHIR store,
the deleted resources will be moved to a history repository that can still be retrieved
through vread and related methods, unless they are removed by the purge method. For samples
that show how to call delete, see Deleting a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.DeleteRequest Delete(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the resource to delete. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.DeleteRequest |
ExecuteBundle(HttpBody, string)
Executes all the requests in the given Bundle. Implements the FHIR standard
batch/transaction interaction
(DSTU2,
STU3,
R4). Supports all
interactions within a bundle, except search. This method accepts Bundles of type batch and
transaction, processing them according to the batch processing rules
(DSTU2,
STU3,
R4) and transaction
processing rules
(DSTU2,
STU3,
R4). The request body must
contain a JSON-encoded FHIR Bundle resource, and the request headers must contain
Content-Type: application/fhir+json. For a batch bundle or a successful transaction, the
response body contains a JSON-encoded representation of a Bundle resource of type
batch-response or transaction-response containing one entry for each entry in the
request, with the outcome of processing the entry. In the case of an error for a transaction
bundle, the response body contains 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 checks permissions for each
request in the bundle. The executeBundle permission is required to call this method, but
you must also grant sufficient permissions to execute the individual requests in the bundle.
For example, if the bundle contains a request to create a FHIR resource, the caller must
also have been granted the healthcare.fhirResources.create permission. You can use audit
logs to view the permissions for executeBundle and each request in the bundle. For more
information, see Viewing Cloud Audit
logs. For samples that
show how to call executeBundle, see Managing FHIR resources using FHIR
bundles.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ExecuteBundleRequest ExecuteBundle(HttpBody body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | parent | Required. Name of the FHIR store in which this bundle will be executed. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ExecuteBundleRequest |
History(string)
Lists all the versions of a resource (including the current version and deleted versions)
from the FHIR store. Implements the per-resource form of the FHIR standard history
interaction (DSTU2,
STU3,
R4). On success, the
response body contains a JSON-encoded representation of a Bundle resource of type
history, containing the version history sorted from most recent to oldest versions. 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. For samples that show how to call
history, see Listing FHIR resource
versions.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.HistoryRequest History(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the resource to retrieve. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.HistoryRequest |
Patch(HttpBody, string)
Updates part of an existing resource by applying the operations specified in a JSON
Patch document. Implements the FHIR standard patch interaction
(STU3,
R4). DSTU2 doesn't define a
patch method, but the server supports it in the same way it supports STU3. The request body
must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+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. For samples that show how to call
patch, see Patching a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatchRequest Patch(HttpBody body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | name | Required. The name of the resource to update. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatchRequest |
PatientEverything(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 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.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatientEverythingRequest PatientEverything(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. Name of the |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatientEverythingRequest |
Read(string)
Gets the contents of a FHIR resource. Implements the FHIR standard read interaction
(DSTU2,
STU3,
R4). Also supports the FHIR
standard conditional read interaction
(DSTU2,
STU3,
R4) specified by supplying an
If-Modified-Since header with a date/time value or an If-None-Match header with an ETag
value. On success, the response body contains a JSON-encoded representation of the resource.
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. For samples that show how to
call read, see Getting a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ReadRequest Read(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the resource to retrieve. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ReadRequest |
ResourcePurge(string)
Deletes all the historical versions of a resource (excluding the current version) from the
FHIR store. To remove all versions of a resource, first delete the current version and then
call this method. This is not a FHIR standard operation. For samples that show how to call
Resource-purge, see Deleting historical versions of a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourcePurgeRequest ResourcePurge(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the resource to purge. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourcePurgeRequest |
ResourceValidate(HttpBody, string, string)
Validates an input FHIR resource's conformance to its profiles and the profiles configured
on the FHIR store. Implements the FHIR extended operation $validate
(DSTU2,
STU3, or
R4). The
request body must contain a JSON-encoded FHIR resource, and the request headers must contain
Content-Type: application/fhir+json. The Parameters input syntax is not supported. The
profile query parameter can be used to request that the resource only be validated against
a specific profile. If a profile with the given URL cannot be found in the FHIR store then
an error is returned. Errors generated by validation 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.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourceValidateRequest ResourceValidate(HttpBody body, string parent, string type)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | parent | Required. The name of the FHIR store that holds the profiles being used for validation. |
| string | type | Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index (DSTU2, STU3, or R4). Must match the resource type in the provided content. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourceValidateRequest |
Search(SearchResourcesRequest, string)
Searches for resources in the given FHIR store according to criteria specified as query
parameters. Implements the FHIR standard search interaction
(DSTU2,
STU3,
R4) using the search
semantics described in the FHIR Search specification
(DSTU2,
STU3,
R4). Supports four methods of
search defined by the specification: * GET [base]?[parameters] to search across all
resources. * GET [base]/[type]?[parameters] to search resources of a specified type. *
POST [base]/_search?[parameters] as an alternate form having the same semantics as the
GET method across all resources. * POST [base]/[type]/_search?[parameters] as an
alternate form having the same semantics as the GET method for the specified type. The
GET and POST methods do not support compartment searches. The POST method does not
support application/x-www-form-urlencoded search parameters. On success, the response body
contains a JSON-encoded representation of a Bundle resource of type searchset,
containing the results of the search. 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 server's capability statement, retrieved through capabilities,
indicates what search parameters are supported on each FHIR resource. A list of all search
parameters defined by the specification can be found in the FHIR Search Parameter Registry
(STU3,
R4). FHIR search
parameters for DSTU2 can be found on each resource's definition page. Supported search
modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below,
:[type], :not, and recurse (DSTU2 and STU3) or :iterate (R4). Supported search
result parameters: _sort, _count, _include, _revinclude, _summary=text,
_summary=data, and _elements. The maximum number of search results returned defaults to
100, which can be overridden by the _count parameter up to a maximum limit of 1000. The
server might return fewer resources than requested to prevent excessively large responses.
If there are additional results, the returned Bundle contains a link of relation "next",
which has a _page_token parameter for an opaque pagination token that can be used to
retrieve the next page. Resources with a total size larger than 5MB or a field count larger
than 50,000 might not be fully searchable as the server might trim its generated search
index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a
slight delay between the time a resource is created or changed, and the time when the change
reflects in search results. The only exception is resource identifier data, which is indexed
synchronously as a special index. As a result, searching using resource identifier is not
subject to indexing delay. To use the special synchronous index, the search term for
identifier should be in the pattern identifier=[system]|[value] or identifier=[value],
and any of the following search result parameters can be used: * _count * _include *
_revinclude * _summary * _elements If your query contains any other search parameters,
the standard asynchronous index will be used instead. Note that searching against the
special index is optimized for resolving a small number of matches. The search isn't
optimized if your identifier search criteria matches a large number (i.e. more than 2,000)
of resources. For a search query that will match a large number of resources, you can
avoiding using the special synchronous index by including an additional _sort parameter in
your query. Use _sort=-_lastUpdated if you want to keep the default sorting order. Note:
The special synchronous identifier index are currently disabled for DocumentReference and
DocumentManifest searches. For samples and detailed information, see Searching for FHIR
resources and Advanced FHIR
search features.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchRequest Search(SearchResourcesRequest body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| SearchResourcesRequest | body | The body of the request. |
| string | parent | Required. Name of the FHIR store to retrieve resources from. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchRequest |
SearchType(SearchResourcesRequest, string, string)
Searches for resources in the given FHIR store according to criteria specified as query
parameters. Implements the FHIR standard search interaction
(DSTU2,
STU3,
R4) using the search
semantics described in the FHIR Search specification
(DSTU2,
STU3,
R4). Supports four methods of
search defined by the specification: * GET [base]?[parameters] to search across all
resources. * GET [base]/[type]?[parameters] to search resources of a specified type. *
POST [base]/_search?[parameters] as an alternate form having the same semantics as the
GET method across all resources. * POST [base]/[type]/_search?[parameters] as an
alternate form having the same semantics as the GET method for the specified type. The
GET and POST methods do not support compartment searches. The POST method does not
support application/x-www-form-urlencoded search parameters. On success, the response body
contains a JSON-encoded representation of a Bundle resource of type searchset,
containing the results of the search. 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 server's capability statement, retrieved through capabilities,
indicates what search parameters are supported on each FHIR resource. A list of all search
parameters defined by the specification can be found in the FHIR Search Parameter Registry
(STU3,
R4). FHIR search
parameters for DSTU2 can be found on each resource's definition page. Supported search
modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below,
:[type], :not, and recurse (DSTU2 and STU3) or :iterate (R4). Supported search
result parameters: _sort, _count, _include, _revinclude, _summary=text,
_summary=data, and _elements. The maximum number of search results returned defaults to
100, which can be overridden by the _count parameter up to a maximum limit of 1000. The
server might return fewer resources than requested to prevent excessively large responses.
If there are additional results, the returned Bundle contains a link of relation "next",
which has a _page_token parameter for an opaque pagination token that can be used to
retrieve the next page. Resources with a total size larger than 5MB or a field count larger
than 50,000 might not be fully searchable as the server might trim its generated search
index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a
slight delay between the time a resource is created or changed, and the time when the change
reflects in search results. The only exception is resource identifier data, which is indexed
synchronously as a special index. As a result, searching using resource identifier is not
subject to indexing delay. To use the special synchronous index, the search term for
identifier should be in the pattern identifier=[system]|[value] or identifier=[value],
and any of the following search result parameters can be used: * _count * _include *
_revinclude * _summary * _elements If your query contains any other search parameters,
the standard asynchronous index will be used instead. Note that searching against the
special index is optimized for resolving a small number of matches. The search isn't
optimized if your identifier search criteria matches a large number (i.e. more than 2,000)
of resources. For a search query that will match a large number of resources, you can
avoiding using the special synchronous index by including an additional _sort parameter in
your query. Use _sort=-_lastUpdated if you want to keep the default sorting order. Note:
The special synchronous identifier index are currently disabled for DocumentReference and
DocumentManifest searches. For samples and detailed information, see Searching for FHIR
resources and Advanced FHIR
search features.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchTypeRequest SearchType(SearchResourcesRequest body, string parent, string resourceType)Parameters
| Type | Name | Description |
|---|---|---|
| SearchResourcesRequest | body | The body of the request. |
| string | parent | Required. Name of the FHIR store to retrieve resources from. |
| string | resourceType | Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchTypeRequest |
Update(HttpBody, string)
Updates the entire contents of a resource. Implements the FHIR standard update interaction
(DSTU2,
STU3,
R4). If the specified
resource does not exist 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. The request body must
contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The resource must contain an id element having an identical value
to the ID in the REST path of the request. 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. For samples that show how to
call update, see Updating a FHIR
resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.UpdateRequest Update(HttpBody body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| string | name | Required. The name of the resource to update. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.UpdateRequest |
Vread(string)
Gets the contents of a version (current or historical) of a FHIR resource by version ID.
Implements the FHIR standard vread interaction
(DSTU2,
STU3,
R4). On success, the response
body contains a JSON-encoded representation of the resource. 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. For samples that show how to call vread, see Retrieving
a FHIR resource
version.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.VreadRequest Vread(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the resource version to retrieve. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.VreadRequest |