View Source API Reference google_api_health_care v0.50.1

API client metadata for GoogleApi.HealthCare.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.HealthCare.V1.

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.

The request to analyze healthcare entities in a document.

Includes recognized entity mentions and relationships between them.

Archives the specified User data mapping.

Archives the specified User data mapping.

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.

A client-defined consent attribute.

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.

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.

Associates members, or principals, with a role.

The request message for Operations.CancelOperation.

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

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

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

Represents a user's consent.

Documentation of a user's consent.

The detailed evaluation of a particular Consent.

List of resource names of Consent resources.

Represents a consent store.

Creates a new message.

Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=).

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.

Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.

Contains configuration for streaming de-identified FHIR export.

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.

Redacts identifying information from the specified dataset.

Creates a new DICOM store with sensitive information de-identified.

Creates a new FHIR store with sensitive information de-identified.

Contains a summary of the Deidentify operation.

Specifies the parameters needed for de-identification of DICOM stores.

Specifies the filter configuration for DICOM resources.

Represents a DICOM store.

DicomStoreMetrics contains metrics describing a DICOM store.

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 candidate entities that an entity mention could link to.

An entity mention in the document.

Defines directed relationship from one entity mention to another.

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.

Attributes

• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list. This token is valid for 72 hours after it is created.
• results (type: list(GoogleApi.HealthCare.V1.Model.Result.t), default: nil) - The consent evaluation result for each data_id.

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.

Returns additional information in regards to a completed DICOM store export.

Request to schedule an export.

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

Request to export resources.

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

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.

A feature of an entity mention.

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

Filter configuration.

Contains the configuration for FHIR notifications.

Represents a FHIR store.

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

List of metrics for a given FHIR store.

A (sub) field of a type.

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

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

Specifies the configuration for importing data from Cloud Storage.

The Cloud Storage location for export.

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

Contains a summary of the DeidentifyDicomStore operation.

Contains a summary of the DeidentifyFhirStore operation.

The BigQuery table where the server writes the output.

The Cloud Storage location where the server writes the output and the export configuration.

Specifies the configuration for importing data from Cloud Storage.

StreamConfig specifies configuration for a streaming DICOM export.

The configuration for exporting to BigQuery.

The configuration for exporting to Cloud Storage.

Specifies the configuration for importing data from Cloud Storage.

Construct representing a logical group or a segment.

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.

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

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

Represents an HL7v2 store.

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

List of metrics for a given HL7v2 store.

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.

Raw bytes representing consent artifact content.

Specifies how to handle de-identification of image pixels.

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.

Returns additional information in regards to a completed DICOM store import.

Request to import messages.

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.

Request to import resources.

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

A transformation to apply to text that is identified as a specific info_type.

Ingests a message into the specified HL7v2 store.

Acknowledges that a message has been ingested into the specified HL7v2 store.

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

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

Attributes

• attributeDefinitions (type: list(GoogleApi.HealthCare.V1.Model.AttributeDefinition.t), default: nil) - The returned Attribute definitions. The maximum number of attributes returned is determined by the value of page_size in the ListAttributeDefinitionsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consentArtifacts (type: list(GoogleApi.HealthCare.V1.Model.ConsentArtifact.t), default: nil) - The returned Consent artifacts. The maximum number of artifacts returned is determined by the value of page_size in the ListConsentArtifactsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consents (type: list(GoogleApi.HealthCare.V1.Model.Consent.t), default: nil) - The returned Consent revisions. The maximum number of revisions returned is determined by the value of page_size in the ListConsentRevisionsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consentStores (type: list(GoogleApi.HealthCare.V1.Model.ConsentStore.t), default: nil) - The returned consent stores. The maximum number of stores returned is determined by the value of page_size in the ListConsentStoresRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consents (type: list(GoogleApi.HealthCare.V1.Model.Consent.t), default: nil) - The returned Consents. The maximum number of Consents returned is determined by the value of page_size in the ListConsentsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Lists the available datasets.

Lists the DICOM stores in the given dataset.

Lists the FHIR stores in the given dataset.

Lists the HL7v2 stores in the given dataset.

The response message for Locations.ListLocations.

Lists the messages in the specified HL7v2 store.

The response message for Operations.ListOperations.

Attributes

• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.
• userDataMappings (type: list(GoogleApi.HealthCare.V1.Model.UserDataMapping.t), default: nil) - The returned User data mappings. The maximum number of User data mappings returned is determined by the value of page_size in the ListUserDataMappingsRequest.

A resource that represents a Google Cloud location.

A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.

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

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.

The content of a HL7v2 message in a structured format.

The configuration for the parser. It determines how the server parses the messages.

A patient identifier and associated type.

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 < 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 provides counters to describe an operation's progress.

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

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

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

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

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.

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.

A list of FHIR resources.

The consent evaluation result for a single data_id.

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.

Attributes

• metadataFilter (type: String.t, default: nil) - Optional. A filter expression that matches data in the Resource.meta element. Supports all filters in AIP-160 except the "has" (:) operator. Supports the following custom functions: tag("") = "" for tag filtering. extension_value_ts("") = for filtering extensions with a timestamp, where ` is a Unix timestamp. Supports the>,<,<=,>=, and!=comparison operators. *operationIds(*type:*list(String.t), *default:*nil`) - Optional. A list of operation IDs to roll back.

Attributes

• changeType (type: String.t, default: nil) - Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type.
• excludeRollbacks (type: boolean(), default: nil) - Optional. Specifies whether to exclude earlier rollbacks.
• filteringFields (type: GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields.t, default: nil) - Optional. Parameters for filtering resources
• force (type: boolean(), default: nil) - Optional. When enabled, changes will be reverted without explicit confirmation
• inputGcsObject (type: String.t, default: nil) - Optional. Cloud Storage object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted
• resultGcsBucket (type: String.t, default: nil) - Required. Bucket to deposit result
• rollbackTime (type: DateTime.t, default: nil) - Required. Time point to rollback to.
• type (type: list(String.t), default: nil) - Optional. If specified, revert only resources of these types

Final response of rollback FIHR resources request.

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

An HL7v2 logical group construct.

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

An HL7v2 Segment.

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

Request to search the resources in the specified FHIR store.

A segment in a structured format.

SeriesMetrics contains metrics describing a DICOM series.

Request message for SetIamPolicy method.

User signature.

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.

Contains configuration for streaming FHIR export.

StudyMetrics contains metrics describing a DICOM study.

List of tags to be filtered.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Attributes

• additionalTransformations (type: list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t), default: nil) - Transformations to apply to the detected data, overridden by exclude_info_types.
• excludeInfoTypes (type: list(String.t), default: nil) - InfoTypes to skip transforming, overriding additional_transformations.
• transformations (type: list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t), default: nil) - The transformations to apply to the detected data. Deprecated. Use additional_transformations instead.

A span of text in the provided document.

Configuration for FHIR BigQuery time-partitioned tables.

A type definition for some HL7v2 type (incl. Segments and Datatypes).

Maps a resource to the associated user and Attributes.

Contains the configuration for FHIR profiles and validation.

Describes a selector for extracting and matching an MSH field to a value.

API client metadata for GoogleApi.HealthCare.V1beta1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.HealthCare.V1beta1.

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.

Specifies a selection of tags and an Action to apply to each one.

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.

List of admin Consent resources to be applied.

The request to analyze healthcare entities in a document.

Includes recognized entity mentions and relationships between them.

An annotation record.

Specifies how to store annotations during de-identification operation.

AnnotationSource holds the source information of the annotation.

An Annotation store that can store annotation resources such as labels and tags for text, image and audio.

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

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.

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

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.

Archives the specified User data mapping.

Archives the specified User data mapping.

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.

A client-defined consent attribute.

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.

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.

Gets multiple messages in a specified HL7v2 store.

Associates members, or principals, with a role.

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.

Settings for data stored in Blob storage.

A bounding polygon for the detected image annotation.

The request message for Operations.CancelOperation.

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

Replace field value with masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.

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

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

This option is based on the DICOM Standard's Clean Descriptors Option, and the CleanText Action is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the Basic Profile. These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection.

Inspect text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.

Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS

Cloud Healthcare API resource.

Request to configure the search parameters for the specified FHIR store.

Represents a user's consent.

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

Documentation of a user's consent.

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

The detailed evaluation of a particular Consent.

How the server handles the consent header.

List of resource names of Consent resources.

Represents a consent store.

Fields that don't match a KeepField or CleanTextField action in the BASIC profile are collected into a contextual phrase list. For fields that match a CleanTextField action in FieldMetadata or ProfileType, the process attempts to transform phrases matching these contextual entries. These contextual phrases are replaced with the token "[CTX]". This feature uses an additional InfoType during inspection.

Creates a new message.

Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=.

Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.

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.

Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.

Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.

Contains configuration for streaming de-identified FHIR export.

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.

Redacts identifying information from the specified dataset.

Creates a new DICOM store with sensitive information de-identified.

Creates a new FHIR store with sensitive information de-identified.

Details about the work the de-identify operation performed.

Contains a detailed summary of the Deidentify operation.

Delete tag.

Contains multiple sensitive information findings for each resource slice.

Specifies the parameters needed for de-identification of DICOM stores.

Specifies the filter configuration for DICOM resources.

Represents a DICOM store.

DicomStoreMetrics contains metrics describing a DICOM store.

Specifies the parameters needed for the de-identification of DICOM stores.

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 candidate entities that an entity mention could link to.

An entity mention in the document.

Defines directed relationship from one entity mention to another.

Request to evaluate an Annotation store against a ground truth [Annotation store].

Response for successful Annotation store evaluation operations. This structure is included in the response upon operation completion.

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.

Attributes

• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list. This token is valid for 72 hours after it is created.
• results (type: list(GoogleApi.HealthCare.V1beta1.Model.Result.t), default: nil) - The consent evaluation result for each data_id.

The enforcing consent's metadata.

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.

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

Request to export Annotations. The export operation is not atomic. If a failure occurs, any annotations already exported are not removed.

Response for successful annotation export operations. This structure is included in response upon operation completion.

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.

Returns additional information in regards to a completed DICOM store export.

Request to schedule an export.

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

Request to export resources.

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.

A feature of an entity mention.

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

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

Filter configuration.

Contains the configuration for FHIR notifications.

Details about the FHIR store to write the output to.

Represents a FHIR store.

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

List of metrics for a given FHIR store.

A (sub) field of a type.

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

List of infoTypes to be filtered.

Attributes

• end (type: String.t, default: nil) - Zero-based ending index of the found text, exclusively.
• infoType (type: String.t, default: nil) - The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
• quote (type: String.t, default: nil) - The snippet of the sensitive text. This field is only populated during deidentification if store_quote is set to true in DeidentifyConfig.
• start (type: String.t, default: nil) - Zero-based starting index of the found text, inclusively.

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

Specifies the configuration for importing data from Cloud Storage.

The BigQuery table for export.

The Cloud Storage location for export.

Specifies the configuration for importing data from Cloud Storage.

The Cloud Storage location for export.

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

Contains a summary of the DeidentifyDicomStore operation.

Contains a summary of the DeidentifyFhirStore operation.

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

Specifies additional options to apply to the base ProfileType.

The BigQuery table where the server writes output.

The Cloud Storage location where the server writes the output and the export configuration.

Specifies the configuration for importing data from Cloud Storage.

StreamConfig specifies configuration for a streaming DICOM export.

The configuration for exporting to BigQuery.

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

The configuration for exporting to Cloud Storage.

Specifies the configuration for importing data from Cloud Storage.

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

Construct representing a logical group or a segment.

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.

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

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

Represents an HL7v2 store.

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

List of metrics for a given HL7v2 store.

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.

Raw bytes representing consent artifact content.

Image annotation.

Specifies how to handle de-identification of image pixels.

Request to import Annotations. The Annotations to be imported must have client-supplied resource names which indicate the annotation resource. The import operation is not atomic. If a failure occurs, any annotations already imported are not removed.

Final response of importing Annotations in successful case. This structure is included in the response. It is only included when the operation finishes.

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.

Returns additional information in regards to a completed DICOM store import.

Request to import messages.

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.

Request to import resources.

Specifies how to use infoTypes for evaluation. For example, a user might only want to evaluate PERSON, LOCATION, and AGE.

A transformation to apply to text that is identified as a specific info_type.

Ingests a message into the specified HL7v2 store.

Acknowledges that a message has been ingested into the specified HL7v2 store.

The behavior for handling FHIR extensions that aren't otherwise specified for de-identification. If provided, all extensions are preserved during de-identification by default. If unspecified, all extensions are removed during de-identification by default.

Keep field unchanged.

Keep tag unchanged.

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

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

Lists the Annotation stores in the given dataset.

Lists the Annotations in the specified Annotation store.

Attributes

• attributeDefinitions (type: list(GoogleApi.HealthCare.V1beta1.Model.AttributeDefinition.t), default: nil) - The returned Attribute definitions. The maximum number of attributes returned is determined by the value of page_size in the ListAttributeDefinitionsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consentArtifacts (type: list(GoogleApi.HealthCare.V1beta1.Model.ConsentArtifact.t), default: nil) - The returned Consent artifacts. The maximum number of artifacts returned is determined by the value of page_size in the ListConsentArtifactsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consents (type: list(GoogleApi.HealthCare.V1beta1.Model.Consent.t), default: nil) - The returned Consent revisions. The maximum number of revisions returned is determined by the value of page_size in the ListConsentRevisionsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consentStores (type: list(GoogleApi.HealthCare.V1beta1.Model.ConsentStore.t), default: nil) - The returned consent stores. The maximum number of stores returned is determined by the value of page_size in the ListConsentStoresRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

• consents (type: list(GoogleApi.HealthCare.V1beta1.Model.Consent.t), default: nil) - The returned Consents. The maximum number of Consents returned is determined by the value of page_size in the ListConsentsRequest.
• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Lists the available datasets.

Lists the DICOM stores in the given dataset.

Lists the FHIR stores in the given dataset.

Lists the HL7v2 stores in the given dataset.

The response message for Locations.ListLocations.

Lists the messages in the specified HL7v2 store.

The response message for Operations.ListOperations.

Attributes

• nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.
• userDataMappings (type: list(GoogleApi.HealthCare.V1beta1.Model.UserDataMapping.t), default: nil) - The returned User data mappings. The maximum number of User data mappings returned is determined by the value of page_size in the ListUserDataMappingsRequest.

A resource that represents a Google Cloud location.

A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.

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

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.

Specifies additional options to apply to the base profile.

The content of an HL7v2 message in a structured format.

The configuration for the parser. It determines how the server parses the messages.

A patient identifier and associated type.

Apply consents given by a list of patients.

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 < 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 provides counters to describe an operation's progress.

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

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

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

Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ

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

Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI

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.

Remove field.

Replace with empty tag.

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.

Reset tag to a placeholder value.

Resource level annotation.

A list of FHIR resources.

The consent evaluation result for a single data_id.

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.

Filters to select resources that need to be rolled back.

Request to roll back resources.

Final response of rollback FHIR resources request.

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

An HL7v2 logical group construct.

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

An HL7v2 Segment.

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

Contains the configuration for FHIR search.

Contains the versioned name and the URL for one SearchParameter.

Request to search the resources in the specified FHIR store.

A segment in a structured format.

A TextAnnotation specifies a text range that includes sensitive information.

SeriesMetrics contains metrics describing a DICOM series.

Request message for SetBlobStorageSettings method.

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

Request message for SetIamPolicy method.

User signature.

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 encapsulates all the storage info of a resource.

Contains configuration for streaming FHIR export.

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

StudyMetrics contains metrics describing a DICOM study.

List of tags to be filtered.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Configures how to transform sensitive text InfoTypes.

A span of text in the provided document.

Configuration for FHIR BigQuery time-partitioned tables.

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.

A type definition for some HL7v2 type (incl. Segments and Datatypes).

Maps a resource to the associated user and Attributes.

Contains the configuration for FHIR profiles and validation.

Describes a selector for extracting and matching an MSH field to a value.

A 2D coordinate in an image. The origin is the top-left.