1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.annotationStores.html">annotationStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.annotationStores.annotations.html">annotations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an Annotation or returns NOT_FOUND if it does not exist.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets an Annotation.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the Annotations in the given Annotation store for a source resource.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates the Annotation.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service. 107 108Args: 109 parent: string, The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # An annotation record. 114 "annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source. 115 "cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource. 116 "name": "A String", # Full path of a Cloud Healthcare API resource. 117 }, 118 }, 119 "customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign. 120 "a_key": "A String", 121 }, 122 "imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons. 123 "boundingPolys": [ # The list of polygons outlining the sensitive regions in the image. 124 { # A bounding polygon for the detected image annotation. 125 "label": "A String", # A description of this polygon. 126 "vertices": [ # List of the vertices of this polygon. 127 { # A 2D coordinate in an image. The origin is the top-left. 128 "x": 3.14, # X coordinate. 129 "y": 3.14, # Y coordinate. 130 }, 131 ], 132 }, 133 ], 134 "frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance. 135 }, 136 "name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. 137 "resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags. 138 "label": "A String", # A description of the annotation record. 139 }, 140 "textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text. 141 "details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} 142 "a_key": { # Contains multiple sensitive information findings for each resource slice. 143 "findings": [ 144 { 145 "end": "A String", # Zero-based ending index of the found text, exclusively. 146 "infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address. 147 "quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. 148 "start": "A String", # Zero-based starting index of the found text, inclusively. 149 }, 150 ], 151 }, 152 }, 153 }, 154} 155 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # An annotation record. 165 "annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source. 166 "cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource. 167 "name": "A String", # Full path of a Cloud Healthcare API resource. 168 }, 169 }, 170 "customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign. 171 "a_key": "A String", 172 }, 173 "imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons. 174 "boundingPolys": [ # The list of polygons outlining the sensitive regions in the image. 175 { # A bounding polygon for the detected image annotation. 176 "label": "A String", # A description of this polygon. 177 "vertices": [ # List of the vertices of this polygon. 178 { # A 2D coordinate in an image. The origin is the top-left. 179 "x": 3.14, # X coordinate. 180 "y": 3.14, # Y coordinate. 181 }, 182 ], 183 }, 184 ], 185 "frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance. 186 }, 187 "name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. 188 "resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags. 189 "label": "A String", # A description of the annotation record. 190 }, 191 "textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text. 192 "details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} 193 "a_key": { # Contains multiple sensitive information findings for each resource slice. 194 "findings": [ 195 { 196 "end": "A String", # Zero-based ending index of the found text, exclusively. 197 "infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address. 198 "quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. 199 "start": "A String", # Zero-based starting index of the found text, inclusively. 200 }, 201 ], 202 }, 203 }, 204 }, 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 210 <pre>Deletes an Annotation or returns NOT_FOUND if it does not exist. 211 212Args: 213 name: string, The resource name of the Annotation to delete. (required) 214 x__xgafv: string, V1 error format. 215 Allowed values 216 1 - v1 error format 217 2 - v2 error format 218 219Returns: 220 An object of the form: 221 222 { # 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 `{}`. 223}</pre> 224</div> 225 226<div class="method"> 227 <code class="details" id="get">get(name, x__xgafv=None)</code> 228 <pre>Gets an Annotation. 229 230Args: 231 name: string, The resource name of the Annotation to retrieve. (required) 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # An annotation record. 241 "annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source. 242 "cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource. 243 "name": "A String", # Full path of a Cloud Healthcare API resource. 244 }, 245 }, 246 "customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign. 247 "a_key": "A String", 248 }, 249 "imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons. 250 "boundingPolys": [ # The list of polygons outlining the sensitive regions in the image. 251 { # A bounding polygon for the detected image annotation. 252 "label": "A String", # A description of this polygon. 253 "vertices": [ # List of the vertices of this polygon. 254 { # A 2D coordinate in an image. The origin is the top-left. 255 "x": 3.14, # X coordinate. 256 "y": 3.14, # Y coordinate. 257 }, 258 ], 259 }, 260 ], 261 "frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance. 262 }, 263 "name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. 264 "resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags. 265 "label": "A String", # A description of the annotation record. 266 }, 267 "textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text. 268 "details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} 269 "a_key": { # Contains multiple sensitive information findings for each resource slice. 270 "findings": [ 271 { 272 "end": "A String", # Zero-based ending index of the found text, exclusively. 273 "infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address. 274 "quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. 275 "start": "A String", # Zero-based starting index of the found text, inclusively. 276 }, 277 ], 278 }, 279 }, 280 }, 281}</pre> 282</div> 283 284<div class="method"> 285 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 286 <pre>Lists the Annotations in the given Annotation store for a source resource. 287 288Args: 289 parent: string, Name of the Annotation store to retrieve Annotations from. (required) 290 filter: string, Restricts Annotations returned to those matching a filter. Functions available for filtering are: - `matches("annotation_source.cloud_healthcare_source.name", substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches("annotation_source.cloud_healthcare_source.name", "some source")`. - `matches("annotation", substring)`. Filter on all fields of annotation. For example: `matches("annotation", "some-content")`. - `type("text")`, `type("image")`, `type("resource")`. Filter on the type of annotation `data`. 291 pageSize: integer, Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000. 292 pageToken: string, The next_page_token value returned from the previous List request, if any. 293 view: string, Controls which fields are populated in the response. 294 Allowed values 295 ANNOTATION_VIEW_UNSPECIFIED - Same as BASIC. 296 ANNOTATION_VIEW_BASIC - Only `name`, `annotation_source` and `custom_data` fields are populated. 297 ANNOTATION_VIEW_FULL - All fields are populated. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { # Lists the Annotations in the specified Annotation store. 307 "annotations": [ # The returned Annotations. Won't be more values than the value of page_size in the request. See `AnnotationView` in the request for populated fields. 308 { # An annotation record. 309 "annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source. 310 "cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource. 311 "name": "A String", # Full path of a Cloud Healthcare API resource. 312 }, 313 }, 314 "customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign. 315 "a_key": "A String", 316 }, 317 "imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons. 318 "boundingPolys": [ # The list of polygons outlining the sensitive regions in the image. 319 { # A bounding polygon for the detected image annotation. 320 "label": "A String", # A description of this polygon. 321 "vertices": [ # List of the vertices of this polygon. 322 { # A 2D coordinate in an image. The origin is the top-left. 323 "x": 3.14, # X coordinate. 324 "y": 3.14, # Y coordinate. 325 }, 326 ], 327 }, 328 ], 329 "frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance. 330 }, 331 "name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. 332 "resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags. 333 "label": "A String", # A description of the annotation record. 334 }, 335 "textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text. 336 "details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} 337 "a_key": { # Contains multiple sensitive information findings for each resource slice. 338 "findings": [ 339 { 340 "end": "A String", # Zero-based ending index of the found text, exclusively. 341 "infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address. 342 "quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. 343 "start": "A String", # Zero-based starting index of the found text, inclusively. 344 }, 345 ], 346 }, 347 }, 348 }, 349 }, 350 ], 351 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. 352}</pre> 353</div> 354 355<div class="method"> 356 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 357 <pre>Retrieves the next page of results. 358 359Args: 360 previous_request: The request for the previous page. (required) 361 previous_response: The response from the request for the previous page. (required) 362 363Returns: 364 A request object that you can call 'execute()' on to request the next 365 page. Returns None if there are no more items in the collection. 366 </pre> 367</div> 368 369<div class="method"> 370 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 371 <pre>Updates the Annotation. 372 373Args: 374 name: string, Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. (required) 375 body: object, The request body. 376 The object takes the form of: 377 378{ # An annotation record. 379 "annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source. 380 "cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource. 381 "name": "A String", # Full path of a Cloud Healthcare API resource. 382 }, 383 }, 384 "customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign. 385 "a_key": "A String", 386 }, 387 "imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons. 388 "boundingPolys": [ # The list of polygons outlining the sensitive regions in the image. 389 { # A bounding polygon for the detected image annotation. 390 "label": "A String", # A description of this polygon. 391 "vertices": [ # List of the vertices of this polygon. 392 { # A 2D coordinate in an image. The origin is the top-left. 393 "x": 3.14, # X coordinate. 394 "y": 3.14, # Y coordinate. 395 }, 396 ], 397 }, 398 ], 399 "frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance. 400 }, 401 "name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. 402 "resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags. 403 "label": "A String", # A description of the annotation record. 404 }, 405 "textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text. 406 "details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} 407 "a_key": { # Contains multiple sensitive information findings for each resource slice. 408 "findings": [ 409 { 410 "end": "A String", # Zero-based ending index of the found text, exclusively. 411 "infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address. 412 "quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. 413 "start": "A String", # Zero-based starting index of the found text, inclusively. 414 }, 415 ], 416 }, 417 }, 418 }, 419} 420 421 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 422 x__xgafv: string, V1 error format. 423 Allowed values 424 1 - v1 error format 425 2 - v2 error format 426 427Returns: 428 An object of the form: 429 430 { # An annotation record. 431 "annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source. 432 "cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource. 433 "name": "A String", # Full path of a Cloud Healthcare API resource. 434 }, 435 }, 436 "customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign. 437 "a_key": "A String", 438 }, 439 "imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons. 440 "boundingPolys": [ # The list of polygons outlining the sensitive regions in the image. 441 { # A bounding polygon for the detected image annotation. 442 "label": "A String", # A description of this polygon. 443 "vertices": [ # List of the vertices of this polygon. 444 { # A 2D coordinate in an image. The origin is the top-left. 445 "x": 3.14, # X coordinate. 446 "y": 3.14, # Y coordinate. 447 }, 448 ], 449 }, 450 ], 451 "frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance. 452 }, 453 "name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. 454 "resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags. 455 "label": "A String", # A description of the annotation record. 456 }, 457 "textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text. 458 "details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} 459 "a_key": { # Contains multiple sensitive information findings for each resource slice. 460 "findings": [ 461 { 462 "end": "A String", # Zero-based ending index of the found text, exclusively. 463 "infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address. 464 "quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. 465 "start": "A String", # Zero-based starting index of the found text, inclusively. 466 }, 467 ], 468 }, 469 }, 470 }, 471}</pre> 472</div> 473 474</body></html>