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.dicomStores.html">dicomStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html">studies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html">series()</a></code> 79</p> 80<p class="firstline">Returns the series Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#delete">delete(parent, dicomWebPath, x__xgafv=None)</a></code></p> 84<p class="firstline">DeleteStudy deletes all instances within the given study. Delete requests</p> 85<p class="toc_element"> 86 <code><a href="#retrieveMetadata">retrieveMetadata(parent, dicomWebPath, x__xgafv=None)</a></code></p> 87<p class="firstline">RetrieveStudyMetadata returns instance associated with the given study</p> 88<p class="toc_element"> 89 <code><a href="#retrieveStudy">retrieveStudy(parent, dicomWebPath, x__xgafv=None)</a></code></p> 90<p class="firstline">RetrieveStudy returns all instances within the given study. See</p> 91<p class="toc_element"> 92 <code><a href="#searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</a></code></p> 93<p class="firstline">SearchForInstances returns a list of matching instances. See</p> 94<p class="toc_element"> 95 <code><a href="#searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</a></code></p> 96<p class="firstline">SearchForSeries returns a list of matching series. See</p> 97<p class="toc_element"> 98 <code><a href="#storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</a></code></p> 99<p class="firstline">StoreInstances stores DICOM instances associated with study instance unique</p> 100<h3>Method Details</h3> 101<div class="method"> 102 <code class="details" id="delete">delete(parent, dicomWebPath, x__xgafv=None)</code> 103 <pre>DeleteStudy deletes all instances within the given study. Delete requests 104are equivalent to the GET requests specified in the WADO-RS standard. 105 106Args: 107 parent: string, The name of the DICOM store that is being accessed (e.g., 108`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 109 dicomWebPath: string, The path of the DeleteStudy request (e.g., `studies/{study_id}`). (required) 110 x__xgafv: string, V1 error format. 111 Allowed values 112 1 - v1 error format 113 2 - v2 error format 114 115Returns: 116 An object of the form: 117 118 { # A generic empty message that you can re-use to avoid defining duplicated 119 # empty messages in your APIs. A typical example is to use it as the request 120 # or the response type of an API method. For instance: 121 # 122 # service Foo { 123 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 124 # } 125 # 126 # The JSON representation for `Empty` is empty JSON object `{}`. 127 }</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="retrieveMetadata">retrieveMetadata(parent, dicomWebPath, x__xgafv=None)</code> 132 <pre>RetrieveStudyMetadata returns instance associated with the given study 133presented as metadata with the bulk data removed. See 134http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. 135 136Args: 137 parent: string, The name of the DICOM store that is being accessed (e.g., 138`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 139 dicomWebPath: string, The path of the RetrieveStudyMetadata DICOMweb request (e.g., 140`studies/{study_id}/metadata`). (required) 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # Message that represents an arbitrary HTTP body. It should only be used for 150 # payload formats that can't be represented as JSON, such as raw binary or 151 # an HTML page. 152 # 153 # 154 # This message can be used both in streaming and non-streaming API methods in 155 # the request as well as the response. 156 # 157 # It can be used as a top-level request field, which is convenient if one 158 # wants to extract parameters from either the URL or HTTP template into the 159 # request fields and also want access to the raw HTTP body. 160 # 161 # Example: 162 # 163 # message GetResourceRequest { 164 # // A unique request id. 165 # string request_id = 1; 166 # 167 # // The raw HTTP body is bound to this field. 168 # google.api.HttpBody http_body = 2; 169 # } 170 # 171 # service ResourceService { 172 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 173 # rpc UpdateResource(google.api.HttpBody) returns 174 # (google.protobuf.Empty); 175 # } 176 # 177 # Example with streaming methods: 178 # 179 # service CaldavService { 180 # rpc GetCalendar(stream google.api.HttpBody) 181 # returns (stream google.api.HttpBody); 182 # rpc UpdateCalendar(stream google.api.HttpBody) 183 # returns (stream google.api.HttpBody); 184 # } 185 # 186 # Use of this type only changes how the request and response bodies are 187 # handled, all other features will continue to work unchanged. 188 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 189 "data": "A String", # The HTTP request/response body as raw binary. 190 "extensions": [ # Application specific response metadata. Must be set in the first response 191 # for streaming APIs. 192 { 193 "a_key": "", # Properties of the object. Contains field @type with type URL. 194 }, 195 ], 196 }</pre> 197</div> 198 199<div class="method"> 200 <code class="details" id="retrieveStudy">retrieveStudy(parent, dicomWebPath, x__xgafv=None)</code> 201 <pre>RetrieveStudy returns all instances within the given study. See 202http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. 203 204Args: 205 parent: string, The name of the DICOM store that is being accessed (e.g., 206`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 207 dicomWebPath: string, The path of the RetrieveStudy DICOMweb request (e.g., 208`studies/{study_id}`). (required) 209 x__xgafv: string, V1 error format. 210 Allowed values 211 1 - v1 error format 212 2 - v2 error format 213 214Returns: 215 An object of the form: 216 217 { # Message that represents an arbitrary HTTP body. It should only be used for 218 # payload formats that can't be represented as JSON, such as raw binary or 219 # an HTML page. 220 # 221 # 222 # This message can be used both in streaming and non-streaming API methods in 223 # the request as well as the response. 224 # 225 # It can be used as a top-level request field, which is convenient if one 226 # wants to extract parameters from either the URL or HTTP template into the 227 # request fields and also want access to the raw HTTP body. 228 # 229 # Example: 230 # 231 # message GetResourceRequest { 232 # // A unique request id. 233 # string request_id = 1; 234 # 235 # // The raw HTTP body is bound to this field. 236 # google.api.HttpBody http_body = 2; 237 # } 238 # 239 # service ResourceService { 240 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 241 # rpc UpdateResource(google.api.HttpBody) returns 242 # (google.protobuf.Empty); 243 # } 244 # 245 # Example with streaming methods: 246 # 247 # service CaldavService { 248 # rpc GetCalendar(stream google.api.HttpBody) 249 # returns (stream google.api.HttpBody); 250 # rpc UpdateCalendar(stream google.api.HttpBody) 251 # returns (stream google.api.HttpBody); 252 # } 253 # 254 # Use of this type only changes how the request and response bodies are 255 # handled, all other features will continue to work unchanged. 256 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 257 "data": "A String", # The HTTP request/response body as raw binary. 258 "extensions": [ # Application specific response metadata. Must be set in the first response 259 # for streaming APIs. 260 { 261 "a_key": "", # Properties of the object. Contains field @type with type URL. 262 }, 263 ], 264 }</pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</code> 269 <pre>SearchForInstances returns a list of matching instances. See 270http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. 271 272Args: 273 parent: string, The name of the DICOM store that is being accessed (e.g., 274`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 275 dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request (e.g., 276`instances` or `series/{series_uid}/instances` or 277`studies/{study_uid}/instances`). (required) 278 x__xgafv: string, V1 error format. 279 Allowed values 280 1 - v1 error format 281 2 - v2 error format 282 283Returns: 284 An object of the form: 285 286 { # Message that represents an arbitrary HTTP body. It should only be used for 287 # payload formats that can't be represented as JSON, such as raw binary or 288 # an HTML page. 289 # 290 # 291 # This message can be used both in streaming and non-streaming API methods in 292 # the request as well as the response. 293 # 294 # It can be used as a top-level request field, which is convenient if one 295 # wants to extract parameters from either the URL or HTTP template into the 296 # request fields and also want access to the raw HTTP body. 297 # 298 # Example: 299 # 300 # message GetResourceRequest { 301 # // A unique request id. 302 # string request_id = 1; 303 # 304 # // The raw HTTP body is bound to this field. 305 # google.api.HttpBody http_body = 2; 306 # } 307 # 308 # service ResourceService { 309 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 310 # rpc UpdateResource(google.api.HttpBody) returns 311 # (google.protobuf.Empty); 312 # } 313 # 314 # Example with streaming methods: 315 # 316 # service CaldavService { 317 # rpc GetCalendar(stream google.api.HttpBody) 318 # returns (stream google.api.HttpBody); 319 # rpc UpdateCalendar(stream google.api.HttpBody) 320 # returns (stream google.api.HttpBody); 321 # } 322 # 323 # Use of this type only changes how the request and response bodies are 324 # handled, all other features will continue to work unchanged. 325 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 326 "data": "A String", # The HTTP request/response body as raw binary. 327 "extensions": [ # Application specific response metadata. Must be set in the first response 328 # for streaming APIs. 329 { 330 "a_key": "", # Properties of the object. Contains field @type with type URL. 331 }, 332 ], 333 }</pre> 334</div> 335 336<div class="method"> 337 <code class="details" id="searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</code> 338 <pre>SearchForSeries returns a list of matching series. See 339http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. 340 341Args: 342 parent: string, The name of the DICOM store that is being accessed (e.g., 343`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 344 dicomWebPath: string, The path of the SearchForSeries DICOMweb request(e.g., `series` or 345`studies/{study_uid}/series`). (required) 346 x__xgafv: string, V1 error format. 347 Allowed values 348 1 - v1 error format 349 2 - v2 error format 350 351Returns: 352 An object of the form: 353 354 { # Message that represents an arbitrary HTTP body. It should only be used for 355 # payload formats that can't be represented as JSON, such as raw binary or 356 # an HTML page. 357 # 358 # 359 # This message can be used both in streaming and non-streaming API methods in 360 # the request as well as the response. 361 # 362 # It can be used as a top-level request field, which is convenient if one 363 # wants to extract parameters from either the URL or HTTP template into the 364 # request fields and also want access to the raw HTTP body. 365 # 366 # Example: 367 # 368 # message GetResourceRequest { 369 # // A unique request id. 370 # string request_id = 1; 371 # 372 # // The raw HTTP body is bound to this field. 373 # google.api.HttpBody http_body = 2; 374 # } 375 # 376 # service ResourceService { 377 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 378 # rpc UpdateResource(google.api.HttpBody) returns 379 # (google.protobuf.Empty); 380 # } 381 # 382 # Example with streaming methods: 383 # 384 # service CaldavService { 385 # rpc GetCalendar(stream google.api.HttpBody) 386 # returns (stream google.api.HttpBody); 387 # rpc UpdateCalendar(stream google.api.HttpBody) 388 # returns (stream google.api.HttpBody); 389 # } 390 # 391 # Use of this type only changes how the request and response bodies are 392 # handled, all other features will continue to work unchanged. 393 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 394 "data": "A String", # The HTTP request/response body as raw binary. 395 "extensions": [ # Application specific response metadata. Must be set in the first response 396 # for streaming APIs. 397 { 398 "a_key": "", # Properties of the object. Contains field @type with type URL. 399 }, 400 ], 401 }</pre> 402</div> 403 404<div class="method"> 405 <code class="details" id="storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</code> 406 <pre>StoreInstances stores DICOM instances associated with study instance unique 407identifiers (SUID). See 408http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. 409 410Args: 411 parent: string, The name of the DICOM store that is being accessed (e.g., 412`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 413 dicomWebPath: string, The path of the StoreInstances DICOMweb request (e.g., 414`studies/[{study_id}]`). Note that the `study_uid` is optional. (required) 415 body: object, The request body. (required) 416 The object takes the form of: 417 418{ # Message that represents an arbitrary HTTP body. It should only be used for 419 # payload formats that can't be represented as JSON, such as raw binary or 420 # an HTML page. 421 # 422 # 423 # This message can be used both in streaming and non-streaming API methods in 424 # the request as well as the response. 425 # 426 # It can be used as a top-level request field, which is convenient if one 427 # wants to extract parameters from either the URL or HTTP template into the 428 # request fields and also want access to the raw HTTP body. 429 # 430 # Example: 431 # 432 # message GetResourceRequest { 433 # // A unique request id. 434 # string request_id = 1; 435 # 436 # // The raw HTTP body is bound to this field. 437 # google.api.HttpBody http_body = 2; 438 # } 439 # 440 # service ResourceService { 441 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 442 # rpc UpdateResource(google.api.HttpBody) returns 443 # (google.protobuf.Empty); 444 # } 445 # 446 # Example with streaming methods: 447 # 448 # service CaldavService { 449 # rpc GetCalendar(stream google.api.HttpBody) 450 # returns (stream google.api.HttpBody); 451 # rpc UpdateCalendar(stream google.api.HttpBody) 452 # returns (stream google.api.HttpBody); 453 # } 454 # 455 # Use of this type only changes how the request and response bodies are 456 # handled, all other features will continue to work unchanged. 457 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 458 "data": "A String", # The HTTP request/response body as raw binary. 459 "extensions": [ # Application specific response metadata. Must be set in the first response 460 # for streaming APIs. 461 { 462 "a_key": "", # Properties of the object. Contains field @type with type URL. 463 }, 464 ], 465 } 466 467 x__xgafv: string, V1 error format. 468 Allowed values 469 1 - v1 error format 470 2 - v2 error format 471 472Returns: 473 An object of the form: 474 475 { # Message that represents an arbitrary HTTP body. It should only be used for 476 # payload formats that can't be represented as JSON, such as raw binary or 477 # an HTML page. 478 # 479 # 480 # This message can be used both in streaming and non-streaming API methods in 481 # the request as well as the response. 482 # 483 # It can be used as a top-level request field, which is convenient if one 484 # wants to extract parameters from either the URL or HTTP template into the 485 # request fields and also want access to the raw HTTP body. 486 # 487 # Example: 488 # 489 # message GetResourceRequest { 490 # // A unique request id. 491 # string request_id = 1; 492 # 493 # // The raw HTTP body is bound to this field. 494 # google.api.HttpBody http_body = 2; 495 # } 496 # 497 # service ResourceService { 498 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 499 # rpc UpdateResource(google.api.HttpBody) returns 500 # (google.protobuf.Empty); 501 # } 502 # 503 # Example with streaming methods: 504 # 505 # service CaldavService { 506 # rpc GetCalendar(stream google.api.HttpBody) 507 # returns (stream google.api.HttpBody); 508 # rpc UpdateCalendar(stream google.api.HttpBody) 509 # returns (stream google.api.HttpBody); 510 # } 511 # 512 # Use of this type only changes how the request and response bodies are 513 # handled, all other features will continue to work unchanged. 514 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 515 "data": "A String", # The HTTP request/response body as raw binary. 516 "extensions": [ # Application specific response metadata. Must be set in the first response 517 # for streaming APIs. 518 { 519 "a_key": "", # Properties of the object. Contains field @type with type URL. 520 }, 521 ], 522 }</pre> 523</div> 524 525</body></html>