googleapis.healthcare.v1 library

Classes

AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Binding
Associates members with a role.
CancelOperationRequest
The request message for Operations.CancelOperation.
CharacterMaskConfig
Mask a string by replacing its characters with a fixed character.
CreateMessageRequest
Creates a new message.
CryptoHashConfig
Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=).
Dataset
A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data.
DateShiftConfig
Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.
DeidentifyConfig
Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime.
DeidentifyDatasetRequest
Redacts identifying information from the specified dataset.
DeidentifyDicomStoreRequest
Creates a new DICOM store with sensitive information de-identified.
DeidentifyFhirStoreRequest
Creates a new FHIR store with sensitive information de-identified.
DeidentifySummary
Contains a summary of the Deidentify operation.
DicomConfig
Specifies the parameters needed for de-identification of DICOM stores.
DicomFilterConfig
Specifies the filter configuration for DICOM resources.
DicomStore
Represents a DICOM store.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
ExportDicomDataRequest
Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted.
ExportDicomDataResponse
Returns additional information in regards to a completed DICOM store export.
ExportResourcesRequest
Request to export resources.
ExportResourcesResponse
Response when all resources export successfully. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
FhirConfig
Specifies how to handle de-identification of a FHIR store.
FhirFilter
Filter configuration.
FhirStore
Represents a FHIR store.
FieldMetadata
Specifies FHIR paths to match, and how to handle de-identification of matching fields.
GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary
Contains a summary of the DeidentifyDicomStore operation.
GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary
Contains a summary of the DeidentifyFhirStore operation.
GoogleCloudHealthcareV1DicomBigQueryDestination
The BigQuery table where the server writes the output.
GoogleCloudHealthcareV1DicomGcsDestination
The Cloud Storage location where the server writes the output and the export configuration.
GoogleCloudHealthcareV1DicomGcsSource
Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1FhirBigQueryDestination
The configuration for exporting to BigQuery.
GoogleCloudHealthcareV1FhirGcsDestination
The configuration for exporting to Cloud Storage.
GoogleCloudHealthcareV1FhirGcsSource
Specifies the configuration for importing data from Cloud Storage.
HealthcareApi
Manage, store, and access healthcare data in Google Cloud Platform.
Hl7V2NotificationConfig
Specifies where and whether to send notifications upon changes to a data store.
Hl7V2Store
Represents an HL7v2 store.
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 request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(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.
ImageConfig
Specifies how to handle de-identification of image pixels.
ImportDicomDataRequest
Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.
ImportDicomDataResponse
Returns additional information in regards to a completed DICOM store import.
ImportResourcesRequest
Request to import resources.
ImportResourcesResponse
Final response of importing resources. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.
InfoTypeTransformation
A transformation to apply to text that is identified as a specific info_type.
IngestMessageRequest
Ingests a message into the specified HL7v2 store.
IngestMessageResponse
Acknowledges that a message has been ingested into the specified HL7v2 store.
ListDatasetsResponse
Lists the available datasets.
ListDicomStoresResponse
Lists the DICOM stores in the given dataset.
ListFhirStoresResponse
Lists the FHIR stores in the given dataset.
ListHl7V2StoresResponse
Lists the HL7v2 stores in the given dataset.
ListLocationsResponse
The response message for Locations.ListLocations.
ListMessagesResponse
Lists the messages in the specified HL7v2 store.
ListOperationsResponse
The response message for Operations.ListOperations.
Location
A resource that represents Google Cloud Platform location.
Message
A complete HL7v2 message. See Introduction to HL7 Standards (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
NotificationConfig
Specifies where to send notifications upon changes to a data store.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationMetadata
OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.
ParsedData
The content of a HL7v2 message in a structured format.
ParserConfig
The configuration for the parser. It determines how the server parses the messages.
PatientId
A patient identifier and associated type.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" }, { "role": "roles/resourcemanager.organizationViewer", "members": "user:eve@example.com" , "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.
ProgressCounter
ProgressCounter provides counters to describe an operation's progress.
ProjectsLocationsDatasetsDicomStoresResourceApi
ProjectsLocationsDatasetsDicomStoresStudiesResourceApi
ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesResourceApi
ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesResourceApi
ProjectsLocationsDatasetsDicomStoresStudiesSeriesResourceApi
ProjectsLocationsDatasetsFhirStoresFhirResourceApi
ProjectsLocationsDatasetsFhirStoresResourceApi
ProjectsLocationsDatasetsHl7V2StoresMessagesResourceApi
ProjectsLocationsDatasetsHl7V2StoresResourceApi
ProjectsLocationsDatasetsOperationsResourceApi
ProjectsLocationsDatasetsResourceApi
ProjectsLocationsResourceApi
ProjectsResourceApi
RedactConfig
Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jane." becomes "My name is ."
ReplaceWithInfoTypeConfig
When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jane" becomes "My name is PERSON_NAME." The TRANSFORM action is equivalent to redacting.
Resources
A list of FHIR resources.
SchemaConfig
Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.
SearchResourcesRequest
Request to search the resources in the specified FHIR store.
Segment
A segment in a structured format.
SetIamPolicyRequest
Request message for SetIamPolicy method.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
StreamConfig
Contains configuration for streaming FHIR export.
TagFilterList
List of tags to be filtered.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
TextConfig

Constants

USER_AGENT → const String
'dart-api-client healthcare/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.