Console
    Contact Us Start free

    Package google.cloud.healthcare.v1.dataset

    Index

    DatasetService

    A service for manipulating health datasets.

    CreateDataset

    rpc CreateDataset( CreateDatasetRequest ) returns ( Operation )

    Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error . The metadata field type is OperationMetadata .

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    DeidentifyDataset

    rpc DeidentifyDataset( DeidentifyDatasetRequest ) returns ( Operation )

    Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata . If the request is successful, the response field type is DeidentifySummary . If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata . Error details are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging .

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    DeleteDataset

    rpc DeleteDataset( DeleteDatasetRequest ) returns ( Empty )

    Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    GetDataset

    rpc GetDataset( GetDatasetRequest ) returns ( Dataset )

    Gets any metadata associated with a dataset.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    ListDatasets

    rpc ListDatasets( ListDatasetsRequest ) returns ( ListDatasetsResponse )

    Lists the health datasets in the current project.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    UpdateDataset

    rpc UpdateDataset( UpdateDatasetRequest ) returns ( Dataset )

    Updates dataset metadata.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    CreateDatasetRequest

    Creates a new dataset.

    Fields
    parent

    string

    Required. The name of the project where the server creates the dataset. For example, projects/{project_id}/locations/{location_id} .

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

    • healthcare.datasets.create
    dataset_id

    string

    Required. The ID of the dataset that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256} .

    dataset

    Dataset

    The dataset that is being created.

    Dataset

    A message representing a health dataset.

    A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data.

    Fields
    name

    string

    Identifier. Resource name of the dataset, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id} .
    time_zone

    string

    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.

    DeidentifyDatasetRequest

    Redacts identifying information from the specified dataset.

    Fields
    source_dataset

    string

    Required. Source dataset resource name. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id} .

    destination_dataset

    string

    Required. 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 location as the source dataset. De-identifying data across multiple locations is not supported.
    config

    DeidentifyConfig

    Deidentify configuration. Only one of config and gcs_config_uri can be specified.

    gcs_config_uri

    string

    Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form gs://{bucket_id}/path/to/object . The Cloud Storage location must grant the Cloud IAM role roles/storage.objectViewer to the project's Cloud Healthcare Service Agent service account. Only one of config and gcs_config_uri can be specified.

    DeleteDatasetRequest

    Deletes the specified dataset. Fails if the dataset contains any resources.

    Fields
    name

    string

    Required. The name of the dataset to delete. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id} .

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

    • healthcare.datasets.delete

    GetDatasetRequest

    Gets any metadata associated with a dataset.

    Fields
    name

    string

    Required. The name of the dataset to read. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id} .

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

    • healthcare.datasets.get

    ListDatasetsRequest

    Lists the available datasets.

    Fields
    parent

    string

    Required. The name of the project whose datasets should be listed. For example, projects/{project_id}/locations/{location_id} .

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

    • healthcare.datasets.list
    page_size

    int32

    The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000.

    page_token

    string

    The next_page_token value returned from a previous List request, if any.

    ListDatasetsResponse

    Lists the available datasets.

    Fields
    datasets[]

    Dataset

    The first page of datasets.
    next_page_token

    string

    Token to retrieve the next page of results, or empty if there are no more results in the list.

    UpdateDatasetRequest

    Updates dataset metadata.

    Fields
    dataset

    Dataset

    Required. The dataset resource that updates the resource on the server. Only fields listed in update_mask are applied.

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

    • healthcare.datasets.update
    update_mask

    FieldMask

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: