googleapis
Version:
Google APIs Client Library for Node.js
833 lines • 668 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace healthcare_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Healthcare API
*
* Manage, store, and access healthcare data in Google Cloud Platform.
*
* @example
* ```js
* const {google} = require('googleapis');
* const healthcare = google.healthcare('v1');
* ```
*/
export class Healthcare {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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.
*/
export interface Schema$ActivateConsentRequest {
/**
* Required. The resource name of the Consent artifact that contains documentation of the user's consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consentArtifacts/{consent_artifact_id\}`. If the draft Consent had a Consent artifact, this Consent artifact overwrites it.
*/
consentArtifact?: string | null;
/**
* Timestamp in UTC of when this Consent is considered expired.
*/
expireTime?: string | null;
/**
* The time to live for this Consent from when it is marked as active.
*/
ttl?: string | null;
}
/**
* Archives the specified User data mapping.
*/
export interface Schema$ArchiveUserDataMappingRequest {
}
/**
* Archives the specified User data mapping.
*/
export interface Schema$ArchiveUserDataMappingResponse {
}
/**
* 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.
*/
export interface Schema$Attribute {
/**
* Indicates the name of an attribute defined in the consent store.
*/
attributeDefinitionId?: string | null;
/**
* Required. The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
*/
values?: string[] | null;
}
/**
* A client-defined consent attribute.
*/
export interface Schema$AttributeDefinition {
/**
* Required. Possible values for the attribute. The number of allowed values must not exceed 100. An empty list is invalid. The list can only be expanded after creation.
*/
allowedValues?: string[] | null;
/**
* Required. The category of the attribute. The value of this field cannot be changed after creation.
*/
category?: string | null;
/**
* Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
*/
consentDefaultValues?: string[] | null;
/**
* Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`.
*/
dataMappingDefaultValue?: string | null;
/**
* Optional. A description of the attribute.
*/
description?: string | null;
/**
* Resource name of the Attribute definition, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/attributeDefinitions/{attribute_definition_id\}`. Cannot be changed after creation.
*/
name?: string | null;
}
/**
* 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.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* 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.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Associates `members` with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[] | null;
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Mask a string by replacing its characters with a fixed character.
*/
export interface Schema$CharacterMaskConfig {
/**
* Character to mask the sensitive values. If not supplied, defaults to "*".
*/
maskingCharacter?: string | null;
}
/**
* Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.
*/
export interface Schema$CheckDataAccessRequest {
/**
* Optional. Specific Consents to evaluate the access request against. These Consents must have the same `user_id` as the evaluated User data mapping, must exist in the current `consent_store`, and have a `state` of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents can be provided here. If no selection is specified, the access request is evaluated against all `ACTIVE` unexpired Consents with the same `user_id` as the evaluated User data mapping.
*/
consentList?: Schema$ConsentList;
/**
* Required. The unique identifier of the resource to check access for. This identifier must correspond to a User data mapping in the given consent store.
*/
dataId?: string | null;
/**
* The values of request attributes associated with this access request.
*/
requestAttributes?: {
[key: string]: string;
} | null;
/**
* Optional. The view for CheckDataAccessResponse. If unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or `FALSE`.
*/
responseView?: string | null;
}
/**
* Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.
*/
export interface Schema$CheckDataAccessResponse {
/**
* The resource names of all evaluated Consents mapped to their evaluation.
*/
consentDetails?: {
[key: string]: Schema$ConsentEvaluation;
} | null;
/**
* Whether the requested resource is consented for the given use.
*/
consented?: boolean | null;
}
/**
* Represents a user's consent.
*/
export interface Schema$Consent {
/**
* Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consentArtifacts/{consent_artifact_id\}`.
*/
consentArtifact?: string | null;
/**
* Timestamp in UTC of when this Consent is considered expired.
*/
expireTime?: string | null;
/**
* Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* Resource name of the Consent, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`. Cannot be changed after creation.
*/
name?: string | null;
/**
* Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
*/
policies?: Schema$GoogleCloudHealthcareV1ConsentPolicy[];
/**
* Output only. The timestamp that the revision was created.
*/
revisionCreateTime?: string | null;
/**
* Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id\}` to the Consent's resource name.
*/
revisionId?: string | null;
/**
* Required. Indicates the current state of this Consent.
*/
state?: string | null;
/**
* Input only. The time to live for this Consent from when it is created.
*/
ttl?: string | null;
/**
* Required. User's UUID provided by the client.
*/
userId?: string | null;
}
/**
* Documentation of a user's consent.
*/
export interface Schema$ConsentArtifact {
/**
* Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
*/
consentContentScreenshots?: Schema$Image[];
/**
* Optional. An string indicating the version of the consent information shown to the user.
*/
consentContentVersion?: string | null;
/**
* Optional. A signature from a guardian.
*/
guardianSignature?: Schema$Signature;
/**
* Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* Resource name of the Consent artifact, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consentArtifacts/{consent_artifact_id\}`. Cannot be changed after creation.
*/
name?: string | null;
/**
* Required. User's UUID provided by the client.
*/
userId?: string | null;
/**
* Optional. User's signature.
*/
userSignature?: Schema$Signature;
/**
* Optional. A signature from a witness.
*/
witnessSignature?: Schema$Signature;
}
/**
* The detailed evaluation of a particular Consent.
*/
export interface Schema$ConsentEvaluation {
/**
* The evaluation result.
*/
evaluationResult?: string | null;
}
/**
* List of resource names of Consent resources.
*/
export interface Schema$ConsentList {
/**
* The resource names of the Consents to evaluate against, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}/consents/{consent_id\}`.
*/
consents?: string[] | null;
}
/**
* Represents a consent store.
*/
export interface Schema$ConsentStore {
/**
* Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
*/
defaultConsentTtl?: string | null;
/**
* Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`.
*/
enableConsentCreateOnUpdate?: boolean | null;
/**
* Optional. User-supplied key-value pairs used to organize consent stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll\}\p{Lo\}{0,62\}. Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll\}\p{Lo\}\p{N\}_-]{0,63\}. No more than 64 labels can be associated with a given store. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
*/
labels?: {
[key: string]: string;
} | null;
/**
* Resource name of the consent store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/consentStores/{consent_store_id\}`. Cannot be changed after creation.
*/
name?: string | null;
}
/**
* Creates a new message.
*/
export interface Schema$CreateMessageRequest {
/**
* HL7v2 message.
*/
message?: Schema$Message;
}
/**
* Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`).
*/
export interface Schema$CryptoHashConfig {
/**
* An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified.
*/
cryptoKey?: string | null;
}
/**
* 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.
*/
export interface Schema$Dataset {
/**
* Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`.
*/
name?: string | null;
/**
* The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.
*/
timeZone?: string | null;
}
/**
* Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.
*/
export interface Schema$DateShiftConfig {
/**
* An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each Deidentify operation and is used wherever crypto_key is not specified.
*/
cryptoKey?: string | null;
}
/**
* 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.
*/
export interface Schema$DeidentifyConfig {
/**
* Configures de-id of application/DICOM content.
*/
dicom?: Schema$DicomConfig;
/**
* Configures de-id of application/FHIR content.
*/
fhir?: Schema$FhirConfig;
/**
* Configures de-identification of image pixels wherever they are found in the source_dataset.
*/
image?: Schema$ImageConfig;
/**
* Configures de-identification of text wherever it is found in the source_dataset.
*/
text?: Schema$TextConfig;
}
/**
* Redacts identifying information from the specified dataset.
*/
export interface Schema$DeidentifyDatasetRequest {
/**
* Deidentify configuration.
*/
config?: Schema$DeidentifyConfig;
/**
* The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same project and location as the source dataset. De-identifying data across multiple projects or locations is not supported.
*/
destinationDataset?: string | null;
}
/**
* Creates a new DICOM store with sensitive information de-identified.
*/
export interface Schema$DeidentifyDicomStoreRequest {
/**
* De-identify configuration.
*/
config?: Schema$DeidentifyConfig;
/**
* The name of the DICOM store to create and write the redacted data to. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same project. De-identifying data across multiple projects is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store.
*/
destinationStore?: string | null;
/**
* Filter configuration.
*/
filterConfig?: Schema$DicomFilterConfig;
}
/**
* Creates a new FHIR store with sensitive information de-identified.
*/
export interface Schema$DeidentifyFhirStoreRequest {
/**
* Deidentify configuration.
*/
config?: Schema$DeidentifyConfig;
/**
* The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same project. De-identifying data across multiple projects is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store.
*/
destinationStore?: string | null;
/**
* A filter specifying the resources to include in the output. If not specified, all resources are included in the output.
*/
resourceFilter?: Schema$FhirFilter;
}
/**
* Contains a summary of the Deidentify operation.
*/
export interface Schema$DeidentifySummary {
}
/**
* Specifies the parameters needed for de-identification of DICOM stores.
*/
export interface Schema$DicomConfig {
/**
* Tag filtering profile that determines which tags to keep/remove.
*/
filterProfile?: string | null;
/**
* List of tags to keep. Remove all other tags.
*/
keepList?: Schema$TagFilterList;
/**
* List of tags to remove. Keep all other tags.
*/
removeList?: Schema$TagFilterList;
/**
* If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
*/
skipIdRedaction?: boolean | null;
}
/**
* Specifies the filter configuration for DICOM resources.
*/
export interface Schema$DicomFilterConfig {
/**
* The Cloud Storage location of the filter configuration file. The `gcs_uri` must be in the format `gs://bucket/path/to/object`. The filter configuration file must contain a list of resource paths separated by newline characters (\n or \r\n). Each resource path must be in the format "/studies/{studyUID\}[/series/{seriesUID\}[/instances/{instanceUID\}]]" The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location.
*/
resourcePathsGcsUri?: string | null;
}
/**
* Represents a DICOM store.
*/
export interface Schema$DicomStore {
/**
* User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll\}\p{Lo\}{0,62\} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll\}\p{Lo\}\p{N\}_-]{0,63\} No more than 64 labels can be associated with a given store.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Resource name of the DICOM store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`.
*/
name?: string | null;
/**
* Notification destination for new DICOM instances. Supplied by the client.
*/
notificationConfig?: Schema$NotificationConfig;
}
/**
* 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 `{\}`.
*/
export interface Schema$Empty {
}
/**
* 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.
*/
export interface Schema$EvaluateUserConsentsRequest {
/**
* Optional. Specific Consents to evaluate the access request against. These Consents must have the same `user_id` as the User data mappings being evalauted, must exist in the current `consent_store`, and must have a `state` of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents can be provided here. If unspecified, all `ACTIVE` unexpired Consents in the current `consent_store` will be evaluated.
*/
consentList?: Schema$ConsentList;
/**
* Optional. Limit on the number of User data mappings to return in a single response. If not specified, 100 is used. May not be larger than 1000.
*/
pageSize?: number | null;
/**
* Optional. Token to retrieve the next page of results, or empty to get the first page.
*/
pageToken?: string | null;
/**
* Required. The values of request attributes associated with this access request.
*/
requestAttributes?: {
[key: string]: string;
} | null;
/**
* Optional. The values of resource attributes associated with the resources being requested. If no values are specified, then all resources are queried.
*/
resourceAttributes?: {
[key: string]: string;
} | null;
/**
* Optional. The view for EvaluateUserConsentsResponse. If unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or `FALSE`.
*/
responseView?: string | null;
/**
* Required. User ID to evaluate consents for.
*/
userId?: string | null;
}
export interface Schema$EvaluateUserConsentsResponse {
/**
* 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.
*/
nextPageToken?: string | null;
/**
* The consent evaluation result for each `data_id`.
*/
results?: Schema$Result[];
}
/**
* 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.
*/
export interface Schema$ExportDicomDataRequest {
/**
* The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`.
*/
bigqueryDestination?: Schema$GoogleCloudHealthcareV1DicomBigQueryDestination;
/**
* The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location.
*/
gcsDestination?: Schema$GoogleCloudHealthcareV1DicomGcsDestination;
}
/**
* Returns additional information in regards to a completed DICOM store export.
*/
export interface Schema$ExportDicomDataResponse {
}
/**
* Request to export resources.
*/
export interface Schema$ExportResourcesRequest {
/**
* 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.
*/
bigqueryDestination?: Schema$GoogleCloudHealthcareV1FhirBigQueryDestination;
/**
* The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role 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.
*/
gcsDestination?: Schema$GoogleCloudHealthcareV1FhirGcsDestination;
}
/**
* Response when all resources export successfully. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.
*/
export interface Schema$ExportResourcesResponse {
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Specifies how to handle de-identification of a FHIR store.
*/
export interface Schema$FhirConfig {
/**
* Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions are removed in the output.
*/
fieldMetadataList?: Schema$FieldMetadata[];
}
/**
* Filter configuration.
*/
export interface Schema$FhirFilter {
/**
* List of resources to include in the output. If this list is empty or not specified, all resources are included in the output.
*/
resources?: Schema$Resources;
}
/**
* Represents a FHIR store.
*/
export interface Schema$FhirStore {
/**
* Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
*/
disableReferentialIntegrity?: boolean | null;
/**
* Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
*/
disableResourceVersioning?: boolean | null;
/**
* Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
*/
enableUpdateCreate?: boolean | null;
/**
* User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll\}\p{Lo\}{0,62\} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll\}\p{Lo\}\p{N\}_-]{0,63\} No more than 64 labels can be associated with a given store.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Resource name of the FHIR store, of the form `projects/{project_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}`.
*/
name?: string | null;
/**
* If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".
*/
notificationConfig?: Schema$NotificationConfig;
/**
* A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.
*/
streamConfigs?: Schema$StreamConfig[];
/**
* Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
*/
version?: string | null;
}
/**
* A (sub) field of a type.
*/
export interface Schema$Field {
/**
* The maximum number of times this field can be repeated. 0 or -1 means unbounded.
*/
maxOccurs?: number | null;
/**
* The minimum number of times this field must be present/repeated.
*/
minOccurs?: number | null;
/**
* The name of the field. For example, "PID-1" or just "1".
*/
name?: string | null;
/**
* The HL7v2 table this field refers to. For example, PID-15 (Patient's Primary Language) usually refers to table "0296".
*/
table?: string | null;
/**
* The type of this field. A Type with this name must be defined in an Hl7TypesConfig.
*/
type?: string | null;
}
/**
* Specifies FHIR paths to match, and how to handle de-identification of matching fields.
*/
export interface Schema$FieldMetadata {
/**
* Deidentify action for one field.
*/
action?: string | null;
/**
* List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Base64Binary is also supported, but may only be kept as-is or have all the content removed.
*/
paths?: string[] | null;
}
/**
* The Cloud Storage location for export.
*/
export interface Schema$GoogleCloudHealthcareV1ConsentGcsDestination {
/**
* URI for a Cloud Storage directory where the server writes result files, 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 and directory referenced in `uri_prefix`.
*/
uriPrefix?: string | null;
}
/**
* Represents a user's consent in terms of the resources that can be accessed and under what conditions.
*/
export interface Schema$GoogleCloudHealthcareV1ConsentPolicy {
/**
* Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`).
*/
authorizationRule?: Schema$Expr;
/**
* The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
*/
resourceAttributes?: Schema$Attribute[];
}
/**
* Contains a summary of the DeidentifyDicomStore operation.
*/
export interface Schema$GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary {
}
/**
* Contains a summary of the DeidentifyFhirStore operation.
*/
export interface Schema$GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary {
}
/**
* The BigQuery table where the server writes the output.
*/
export interface Schema$GoogleCloudHealthcareV1DicomBigQueryDestination {
/**
* If the destination table already exists and this flag is `TRUE`, the table is overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error.
*/
force?: boolean | null;
/**
* BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId`
*/
tableUri?: string | null;
}
/**
* The Cloud Storage location where the server writes the output and the export configuration.
*/
export interface Schema$GoogleCloudHealthcareV1DicomGcsDestination {
/**
* MIME types supported by DICOM spec. Each file is written in the following format: `.../{study_id\}/{series_id\}/{instance_id\}[/{frame_number\}].{extension\}` The frame_number component exists only for multi-frame instances. Supported MIME types are consistent with supported formats in DICOMweb: https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. Specifically, the following are supported: - application/dicom; transfer-syntax=1.2.840.10008.1.2.1 (uncompressed DICOM) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 (DICOM with embedded JPEG Baseline) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 (DICOM with embedded JPEG 2000 Lossless Only) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 (DICOM with embedded JPEG 2000) - application/dicom; transfer-syntax=* (DICOM with no transcoding) - application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 (raw uncompressed PixelData) - application/octet-stream; transfer-syntax=* (raw PixelData in whatever format it was uploaded in) - image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 (Consumer JPEG) - image/png The following extensions are used for output files: - application/dicom -\> .dcm - image/jpeg -\> .jpg - image/png -\> .png - application/octet-stream -\> no extension If unspecified, the instances are exported in the original DICOM format they were uploaded in.
*/
mimeType?: string | null;
/**
* The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes the result files, 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`.
*/
uriPrefix?: string | null;
}
/**
* Specifies the configuration for importing data from Cloud Storage.
*/
export interface Schema$GoogleCloudHealthcareV1DicomGcsSource {
/**
* Points to a Cloud Storage URI containing file(s) with content only. 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 .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/x*.dcm` imports all files with .dcm extensions in `my-directory/` and its sub-directories. * '?' to match 1 character. All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata.
*/
uri?: string | null;
}
/**
* The configuration for exporting to BigQuery.
*/
export interface Schema$GoogleCloudHealthcareV1FhirBigQueryDestination {
/**
* BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.
*/
datasetUri?: string | null;
/**
* If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.
*/
force?: boolean | null;
/**
* The configuration for the exported BigQuery schema.
*/
schemaConfig?: Schema$SchemaConfig;
/**
* Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.
*/
writeDisposition?: string | null;
}
/**
* The configuration for exporting to Cloud Storage.
*/
export interface Schema$GoogleCloudHealthcareV1FhirGcsDestination {
/**
* URI for a Cloud Storage directory where result files should be written, in the format of `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`.
*/
uriPrefix?: string | null;
}
/**
* Specifies the configuration for importing data from Cloud Storage.
*/
export interface Schema$GoogleCloudHealthcareV1FhirGcsSource {
/**
* 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/x*.ndjson` imports all files with `.ndjson` extensions in `my-d