Namespace Google.Apis.CloudHealthcare.v1.Data

Classes

AccessDeterminationLogConfig

Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be enabled. The consent-related logs are included as part of protoPayload.metadata.

ActivateConsentRequest

Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the given Consent is in the ACTIVE state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in the REJECTED or REVOKED state.

AdminConsents

List of admin Consent resources to be applied.

AnalyzeEntitiesRequest

The request to analyze healthcare entities in a document.

AnalyzeEntitiesResponse

Includes recognized entity mentions and relationships between them.

ApplyAdminConsentsErrorDetail

Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources.

ApplyAdminConsentsRequest

Request to apply the admin Consent resources for the specified FHIR store.

ApplyAdminConsentsResponse

Response when all admin Consent resources in scope were processed and all affected resources were reindexed successfully. This structure will be included in the response when the operation finishes successfully.

ApplyConsentsRequest

Request to apply the Consent resources for the specified FHIR store.

ApplyConsentsResponse

Response when all Consent resources in scope were processed and all affected resources were reindexed successfully. This structure is included in the response when the operation finishes successfully.

ArchiveUserDataMappingRequest

Archives the specified User data mapping.

ArchiveUserDataMappingResponse

Archives the specified User data mapping.

Attribute

An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.

AttributeDefinition

A client-defined consent attribute.

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, or principals, with a role.

BlobStorageInfo

BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will only be populated for DICOM resources.

BlobStorageSettings

Settings for data stored in Blob storage.

BulkExportGcsDestination

The configuration for exporting to Cloud Storage using the bulk export API.

CancelOperationRequest

The request message for Operations.CancelOperation.

CharacterMaskConfig

Mask a string by replacing its characters with a fixed character.

CheckDataAccessRequest

Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

CheckDataAccessResponse

Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

Consent

Represents a user's consent.

ConsentAccessorScope

The accessor scope that describes who can access, for what purpose, in which environment.

ConsentArtifact

Documentation of a user's consent.

ConsentConfig

Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.

ConsentErrors

The Consent resource name and error.

ConsentEvaluation

The detailed evaluation of a particular Consent.

ConsentHeaderHandling

How the server handles the consent header.

ConsentList

List of resource names of Consent resources.

ConsentStore

Represents a consent store.

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.

DeidentifiedStoreDestination

Contains configuration for streaming de-identified FHIR export.

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.

DicomStoreMetrics

DicomStoreMetrics contains metrics describing 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); }

EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a resource.

Entity

The candidate entities that an entity mention could link to.

EntityMention

An entity mention in the document.

EntityMentionRelationship

Defines directed relationship from one entity mention to another.

EvaluateUserConsentsRequest

Evaluate a user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, causing slight delays between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

EvaluateUserConsentsResponse

ExplainDataAccessConsentInfo

The enforcing consent's metadata.

ExplainDataAccessConsentScope

A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent.

ExplainDataAccessResponse

List of consent scopes that are applicable to the explained access on a given resource.

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.

ExportMessagesRequest

Request to schedule an export.

ExportMessagesResponse

Final response for the export operation. This structure is included in the response to describe the detailed outcome.

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.

Feature

A feature of an entity mention.

FhirConfig

Specifies how to handle de-identification of a FHIR store.

FhirFilter

Filter configuration.

FhirNotificationConfig

Contains the configuration for FHIR notifications.

FhirStore

Represents a FHIR store.

FhirStoreMetric

Count of resources and total storage size by type for a given FHIR store.

FhirStoreMetrics

List of metrics for a given FHIR store.

Field

A (sub) field of a type.

FieldMetadata

Specifies FHIR paths to match, and how to handle de-identification of matching fields.

GcsDestination

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

GcsSource

Specifies the configuration for importing data from Cloud Storage.

GoogleCloudHealthcareV1ConsentGcsDestination

The Cloud Storage location for export.

GoogleCloudHealthcareV1ConsentPolicy

Represents a user's consent in terms of the resources that can be accessed and under what conditions.

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.

GoogleCloudHealthcareV1DicomStreamConfig

StreamConfig specifies configuration for a streaming DICOM export.

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.

GroupOrSegment

Construct representing a logical group or a segment.

Hl7SchemaConfig

Root config message for HL7v2 schema. This contains a schema structure of groups and segments, and filters that determine which messages to apply the schema structure to.

Hl7TypesConfig

Root config for HL7v2 datatype definitions for a specific HL7v2 version.

Hl7V2NotificationConfig

Specifies where and whether to send notifications upon changes to a data store.

Hl7V2Store

Represents an HL7v2 store.

Hl7V2StoreMetric

Count of messages and total storage size by type for a given HL7 store.

Hl7V2StoreMetrics

List of metrics for a given 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.

Image

Raw bytes representing consent artifact content.

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.

ImportMessagesRequest

Request to import messages.

ImportMessagesResponse

Final response of importing messages. This structure is included in the response to describe the detailed outcome. It is only included when the operation finishes successfully.

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.

KmsWrappedCryptoKey

Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. The key must grant the Cloud IAM permission cloudkms.cryptoKeyVersions.useToDecrypt to the project's Cloud Healthcare Service Agent service account. For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key).

LinkedEntity

EntityMentions can be linked to multiple entities using a LinkedEntity message lets us add other fields, e.g. confidence.

ListAttributeDefinitionsResponse

ListConsentArtifactsResponse

ListConsentRevisionsResponse

ListConsentStoresResponse

ListConsentsResponse

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.

ListUserDataMappingsResponse

Location

A resource that represents a Google Cloud 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.

PatientScope

Apply consents given by a list of patients.

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, or principals, to a single role. Principals 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
&lt; 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 &lt;
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.

PubsubDestination

The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the roles/pubsub.publisher Cloud IAM role on the Pub/Sub topic.

QueryAccessibleDataRequest

Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry).

QueryAccessibleDataResponse

Response for successful QueryAccessibleData operations. This structure is included in the response upon operation completion.

RedactConfig

Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jane." becomes "My name is ."

RejectConsentRequest

Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the given Consent is in the REJECTED state, no new revision is committed.

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.

Result

The consent evaluation result for a single data_id.

RevokeConsentRequest

Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the given Consent is in the REVOKED state, no new revision is committed.

RollbackFhirResourceFilteringFields

RollbackFhirResourcesRequest

RollbackFhirResourcesResponse

Final response of rollback FIHR resources request.

RollbackHL7MessagesFilteringFields

Filtering fields for an HL7v2 rollback. Currently only supports a list of operation ids to roll back.

RollbackHl7V2MessagesRequest

Point in time recovery rollback request.

RollbackHl7V2MessagesResponse

Final response of rollback HL7v2 messages request.

SchemaConfig

Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.

SchemaGroup

An HL7v2 logical group construct.

SchemaPackage

A schema package contains a set of schemas and type definitions.

SchemaSegment

An HL7v2 Segment.

SchematizedData

The content of an HL7v2 message in a structured format as specified by a schema.

SearchResourcesRequest

Request to search the resources in the specified FHIR store.

Segment

A segment in a structured format.

SeriesMetrics

SeriesMetrics contains metrics describing a DICOM series.

SetBlobStorageSettingsRequest

Request message for SetBlobStorageSettings method.

SetBlobStorageSettingsResponse

Returns additional info in regards to a completed set blob storage settings API.

SetIamPolicyRequest

Request message for SetIamPolicy method.

Signature

User signature.

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.

StorageInfo

StorageInfo encapsulates all the storage info of a resource.

StreamConfig

Contains configuration for streaming FHIR export.

StructuredStorageInfo

StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.

StudyMetrics

StudyMetrics contains metrics describing a DICOM study.

TagFilterList

List of tags to be filtered.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

TextConfig

TextSpan

A span of text in the provided document.

TimePartitioning

Configuration for FHIR BigQuery time-partitioned tables.

TimeRange

Apply consents given by patients whose most recent consent changes are in the time range. Note that after identifying these patients, the server applies all Consent resources given by those patients, not just the Consent resources within the timestamp in the range.