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 FhirResourceConstructors
FhirResource(IClientService)
Constructs a new resource.
Declaration
public FhirResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
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 will contain a JSON-encoded representation of a
CapabilityStatement resource.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CapabilitiesRequest Capabilities(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | Name of the FHIR store to retrieve the capabilities for. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CapabilitiesRequest |
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.
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 will contain 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 will 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.CreateRequest Create(HttpBody body, string parent, string type)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| System.String | parent | The name of the FHIR store this resource belongs to. |
| System.String | type | 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.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.DeleteRequest Delete(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | 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 will contain 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 will 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.ExecuteBundleRequest ExecuteBundle(HttpBody body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| System.String | parent | 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 will contain 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 will 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.HistoryRequest History(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | 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 will contain a JSON-encoded representation of the updated
resource, including the server-assigned version ID. Errors generated by the FHIR store will
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.PatchRequest Patch(HttpBody body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| System.String | name | 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 will contain a JSON-encoded representation of a Bundle
resource of type searchset, containing the results of the operation. Errors generated by
the FHIR store will 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.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatientEverythingRequest PatientEverything(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | 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 will contain a JSON-encoded representation of the resource.
Errors generated by the FHIR store will 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.ReadRequest Read(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | 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.
Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourcePurgeRequest ResourcePurge(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the resource to purge. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourcePurgeRequest |
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 three 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]/[type]/_search?[parameters]as an alternate form having the same semantics as theGETmethod.
The GET methods do not support compartment searches. The POST method does not support
application/x-www-form-urlencoded search parameters.
On success, the response body will contain a JSON-encoded representation of a Bundle
resource of type searchset, containing the results of the search. Errors generated by the
FHIR store will 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.
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. If there are additional results, the
returned Bundle will contain pagination links.
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 changes and when the change is reflected in search results.
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. |
| System.String | parent | Name of the FHIR store to retrieve resources from. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchRequest |
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.
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 will contain a JSON-encoded representation of the updated
resource, including the server-assigned version ID. Errors generated by the FHIR store will
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.UpdateRequest Update(HttpBody body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| HttpBody | body | The body of the request. |
| System.String | name | 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 will contain a JSON-encoded representation of the resource.
Errors generated by the FHIR store will 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.VreadRequest Vread(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the resource version to retrieve. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.VreadRequest |