Package google.cloud.healthcare.v1beta1.fhir.rest

Index

ConceptMapSearchTranslateRequest

The request to a concept map translate operation that searches for concept maps matching input query parameters.

Fields
parent

string

The name for the FHIR store containing the concept map(s) to use for the translation.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.translateConceptMap
url

string

The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps.
code

string

The code to translate.
system

string

The system for the code to be translated.
source

string

The source value set of the concept map to be used. If unset, target is used to search for concept maps.
target

string

The target value set of the concept map to be used. If unset, source is used to search for concept maps.
concept_map_version

string

The version of the concept map to use. If unset, the most current version is used.

ConceptMapTranslateRequest

The request to a concept map translate operation.

Fields
name

string

The URL for the concept map to use for the translation.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.translateConceptMap
code

string

The code to translate.
system

string

The system for the code to be translated.
concept_map_version

string

The version of the concept map to use. If unset, the most current version is used.

ConditionalDeleteResourceRequest

Deletes a resource from the specified FHIR store that matches the conditions.

Fields
parent

string

The name of the FHIR store this resource belongs to.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.delete
type

string

The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4).

ConditionalPatchResourceRequest

Request to patch the given resource.

Fields
parent

string

The name of the FHIR store this resource belongs to.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.patch
request_body

HttpBody

Raw body of the request.
type

string

The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4).

ConditionalUpdateResourceRequest

Request to update the given resource.

Fields
parent

string

The name of the FHIR store this resource belongs to.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.update
type

string

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.
request_body

HttpBody

Raw body of the request.

CreateResourceRequest

Creates a resource in the specified FHIR store.

Fields
parent

string

The name of the FHIR store this resource belongs to.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.create
type

string

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.
request_body

HttpBody

Raw body of the request.

DeleteResourceRequest

Deletes a resource from the specified FHIR store.

Fields
name

string

The name of the resource to delete.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.delete

DeleteResourceVersionsRequest

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

Fields
name

string

The name of the resource to purge.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.purge

ExecuteBundleRequest

Request to execute all included operations in a Bundle.

Fields
parent

string

Name of the FHIR store in which this bundle will be executed.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.executeBundle
request_body

HttpBody

The bundle to execute.

ExportResourcesErrorDetails

Response when errors occur while exporting resources. This structure is included in the error google.rpc.Status.error to describe the detailed outcome. It is only included when the operation finishes with errors.

Fields
fhir_store

string

The name of the FHIR store where resources have been exported, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
resource_count

int64

The total number of resources included in the export operation. This is the sum of the success and error counts.
success_count

int64

The number of resources that were exported.
error_count

int64

The number of resources that had errors.

ExportResourcesRequest

Request to export resources.

Fields
name

string

The name of the FHIR store to export resource from, in the format of projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirStores.export

Union field destination. The output destination of the export.

To enable the Cloud Healthcare API to write to resources in your project such as Cloud Storage buckets, you must give the consumer Cloud Healthcare API service account the proper permissions. The service account is: service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com. The PROJECT_NUMBER identifies the project that contains the source FHIR store. To get the project number, go to the Cloud Console Dashboard. destination can be only one of the following:
gcs_destination

GcsDestination

The Cloud Storage output destination.

The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin Cloud IAM roles on the Cloud Storage location.

The exported outputs are organized by FHIR resource types. The server creates one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource.
bigquery_destination

BigQueryDestination

The BigQuery output destination.

The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: roles/bigquery.dataEditor and roles/bigquery.jobUser.

The output is one BigQuery table per resource type.

ExportResourcesResponse

Response when all resources export successfully. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.

Fields
fhir_store

string

The name of the FHIR store where resources have been exported, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
resource_count

int64

The total number of resources exported from the requested FHIR store.

GcsDestination

The configuration for exporting to Cloud Storage.

Fields
uri_prefix

string

URI for a Cloud Storage directory where result files should be written (in the format gs://{bucket-id}/{path/to/destination/dir}). If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in uri_prefix.

GcsSource

Specifies the configuration for importing data from Cloud Storage.

Fields
uri

string

Points to a Cloud Storage URI containing file(s) to import.

The URI must be in the following format: gs://{bucket_id}/{object_id}. The URI can include wildcards in object_id and thus identify multiple files. Supported wildcards:

  • * to match 0 or more non-separator characters
  • ** to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, gs://my-bucket/my-directory/**.ndjson imports all files with .ndjson extensions in my-directory/ and its sub-directories.
  • ? to match 1 character

Files matching the wildcard are expected to contain content only, no metadata.

GetCapabilityStatementRequest

Request the capabilities of the system.

Fields
name

string

Name of the FHIR store to retrieve the capabilities for.

GetLastNObservationsRequest

Request to get most N recent observations for patient grouped by code.

Fields
parent

string

Name of the FHIR store to retrieve resources from.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirResources.search

GetPatientEverythingRequest

Request all the information related to the patient.

Fields
name

string

Name of the Patient resource for which the information is required.
start

string

The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope.
end

string

The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope.
page_token

string

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.
count

int32

Maximum number of resources in a page. Defaults to 100.
since

string

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.
type

string

String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned.

GetResourceRequest

Gets a resource from the specified FHIR store.

Fields
name

string

The name of the resource to retrieve.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.get

GetResourceVersionRequest

Gets a specific version of a resource from the specified FHIR store.

Fields
name

string

The name of the resource version to retrieve.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.get

ImportResourcesErrorDetails

Error response of importing resources. This structure is included in the error google.rpc.Status.error to describe the detailed error after the operation finishes with some failure.

Fields
fhir_store

string

The name of the FHIR store where resources have been imported, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
input_size

int64

The total number of resources included in the source data. This is the sum of the success and error counts.
success_count

int64

The number of resources that have been imported.
error_count

int64

The number of resources that had errors.

ImportResourcesRequest

Request to import resources.

Fields
name

string

The name of the FHIR store to import FHIR resources to, in the format of projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirStores.import
content_structure

ContentStructure

The content structure in the source location. If not specified, the server treats the input source files as BUNDLE.
gcs_source

GcsSource

Cloud Storage source data location and import configuration.

The Cloud Healthcare Service Agent requires the roles/storage.objectViewer Cloud IAM roles on the Cloud Storage location.

Each Cloud Storage object should be a text file that contains the format specified in ContentStructure.

ContentStructure

The content structure of the input source files.

Enums
CONTENT_STRUCTURE_UNSPECIFIED If the content structure is not specified, the default value BUNDLE is used.
BUNDLE The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a bundle that contains one or more resources. Set the bundle type to history to import resource versions.
RESOURCE The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a single resource.
BUNDLE_PRETTY The entire file is one JSON bundle. The JSON can span multiple lines.
RESOURCE_PRETTY The entire file is one JSON resource. The JSON can span multiple lines.

ImportResourcesResponse

Final response of importing resources. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.

Fields
fhir_store

string

The name of the FHIR store where the resources have been imported, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
input_size

int64

The total number of resources included in the source data.

ListResourceVersionsRequest

Lists all the versions of a resource from the specified FHIR store.

Fields
name

string

The name of the resource to retrieve.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.get
count

int32

The maximum number of search results on a page. Default value is 100. Maximum value is 1,000.
since

string

Only include resource versions that were created at or after the given instant in time. The instant in 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.
at

string

Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm]

Clients may specify any of the following:

  • An entire year: _at=2019
  • An entire month: _at=2019-01
  • A specific day: _at=2019-01-20
  • A specific second: _at=2018-12-31T23:59:58Z
page_token

string

Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of _page_token set in next or previous page links' URLs. 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.

PatchResourceRequest

Request to patch the given resource.

Fields
name

string

The name of the resource to update.
request_body

HttpBody

The request body needs to be in JSON Patch format, as detailed in http://www.jsonpatch.com

SearchResourcesRequest

Request to search the resources in the specified FHIR store.

Fields
parent

string

Name of the FHIR store to retrieve resources from.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.fhirStores.searchResources
resource_type

string

The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4).

UpdateResourceRequest

Request to update the given resource, or create it with the client-specified ID if it does not exist and the FhirStore has EnableUpdateCreate set.

Fields
name

string

The name of the resource to update.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.update
request_body

HttpBody

The updated resource to store. The entire resource is updated.