Required. The name of the Annotation store to which the server imports annotations, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}.
Authorization requires the following IAM permission on the specified resource name:
healthcare.annotationStores.import
Request body
The request body contains data with the following structure:
JSON representation
{// Union field source can be only one of the following:"gcsSource": {object(GcsSource)}// End of list of possible types for union field source.}
Fields
Union field source. The Annotation must be provided in JSON format of the Annotation. For example, an annotation might look like the following: json
{
"annotation_source": {
"cloud_healthcare_source": {
"name":
"projects/test_project/locations/test_location/datasets/test_dataset/fhirStores/test_fhir_store/resources/test_type/test_id"
}
},
"text_annotation": {
"details": {
"patient/text/div/value": {
"findings": [
{
"info_type": "PERSON_NAME",
"start": "4",
"end": "12",
"quote": "John Doe",
},
{
"info_type": "DATE",
"start": "37",
"end": "47",
"quote": "1900-12-24",
}
]
},
"patient/birth_date/value_us": {
"findings": [
{
"info_type": "DATE",
"start": "0",
"end": "10",
"quote": "1900-12-24",
}
]
}
}
}
}
Each file consists of exactly one annotation. source can be only one of the following:
Specifies the configuration for importing data from Cloud Storage.
JSON representation
{"uri": string}
Fields
uri
string
Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: gs://{bucket_id}/{objectId}. The URI can include wildcards in objectId 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/**.json imports all files with .json 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["This API imports annotations into an Annotation store from specified data sources, primarily using Cloud Storage."],["Successful import requests return a detailed response of type `ImportAnnotationsResponse` upon operation completion."],["The `name` parameter in the HTTP request specifies the target Annotation store, and importing requires the `healthcare.annotationStores.import` IAM permission."],["The request body uses the union field `source`, which supports only `gcsSource` to import data, and each file in the specified location is expected to contain exactly one annotation in JSON format."],["The `gcsSource` URI in the request must follow a specific format `gs://{bucket_id}/{objectId}`, and supports wildcards for matching multiple files in Cloud Storage."]]],[]]
