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.fhirStores.html">fhirStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html">fhir</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#Observation-lastn">Observation-lastn(parent, x__xgafv=None)</a></code></p> 79<p class="firstline">Retrieves the N most recent `Observation` resources for a subject matching</p> 80<p class="toc_element"> 81 <code><a href="#Patient-everything">Patient-everything(name, end=None, x__xgafv=None, start=None)</a></code></p> 82<p class="firstline">Retrieves all the resources in the patient compartment for a `Patient`</p> 83<p class="toc_element"> 84 <code><a href="#Resource-purge">Resource-purge(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes all the historical versions of a resource (excluding the current</p> 86<p class="toc_element"> 87 <code><a href="#capabilities">capabilities(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the FHIR [capability</p> 89<p class="toc_element"> 90 <code><a href="#conditionalDelete">conditionalDelete(parent, type, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes FHIR resources that match a search query.</p> 92<p class="toc_element"> 93 <code><a href="#conditionalPatch">conditionalPatch(parent, type, body, x__xgafv=None)</a></code></p> 94<p class="firstline">If a resource is found based on the search criteria specified in the query</p> 95<p class="toc_element"> 96 <code><a href="#conditionalUpdate">conditionalUpdate(parent, type, body, x__xgafv=None)</a></code></p> 97<p class="firstline">If a resource is found based on the search criteria specified in the query</p> 98<p class="toc_element"> 99 <code><a href="#create">create(parent, type, body, x__xgafv=None)</a></code></p> 100<p class="firstline">Creates a FHIR resource.</p> 101<p class="toc_element"> 102 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 103<p class="firstline">Deletes a FHIR resource.</p> 104<p class="toc_element"> 105 <code><a href="#executeBundle">executeBundle(parent, body, x__xgafv=None)</a></code></p> 106<p class="firstline">Executes all the requests in the given Bundle.</p> 107<p class="toc_element"> 108 <code><a href="#history">history(name, count=None, since=None, page=None, at=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Lists all the versions of a resource (including the current version and</p> 110<p class="toc_element"> 111 <code><a href="#patch">patch(name, body, x__xgafv=None)</a></code></p> 112<p class="firstline">Updates part of an existing resource by applying the operations specified</p> 113<p class="toc_element"> 114 <code><a href="#read">read(name, x__xgafv=None)</a></code></p> 115<p class="firstline">Gets the contents of a FHIR resource.</p> 116<p class="toc_element"> 117 <code><a href="#search">search(parent, body, x__xgafv=None)</a></code></p> 118<p class="firstline">Searches for resources in the given FHIR store according to criteria</p> 119<p class="toc_element"> 120 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> 121<p class="firstline">Updates the entire contents of a resource.</p> 122<p class="toc_element"> 123 <code><a href="#vread">vread(name, x__xgafv=None)</a></code></p> 124<p class="firstline">Gets the contents of a version (current or historical) of a FHIR resource</p> 125<h3>Method Details</h3> 126<div class="method"> 127 <code class="details" id="Observation-lastn">Observation-lastn(parent, x__xgafv=None)</code> 128 <pre>Retrieves the N most recent `Observation` resources for a subject matching 129search criteria specified as query parameters, grouped by 130`Observation.code`, sorted from most recent to oldest. 131 132Implements the FHIR extended operation 133[Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). 134 135Search terms are provided as query parameters following the same pattern as 136the search method. This operation accepts an additional 137query parameter `max`, which specifies N, the maximum number of 138Observations to return from each group, with a default of 1. 139 140On success, the response body will contain a JSON-encoded representation 141of a `Bundle` resource of type `searchset`, containing the results of the 142operation. 143Errors generated by the FHIR store will contain a JSON-encoded 144`OperationOutcome` resource describing the reason for the error. If the 145request cannot be mapped to a valid API method on a FHIR store, a generic 146GCP error might be returned instead. 147 148Args: 149 parent: string, Name of the FHIR store to retrieve resources from. (required) 150 x__xgafv: string, V1 error format. 151 Allowed values 152 1 - v1 error format 153 2 - v2 error format 154 155Returns: 156 An object of the form: 157 158 { # Message that represents an arbitrary HTTP body. It should only be used for 159 # payload formats that can't be represented as JSON, such as raw binary or 160 # an HTML page. 161 # 162 # 163 # This message can be used both in streaming and non-streaming API methods in 164 # the request as well as the response. 165 # 166 # It can be used as a top-level request field, which is convenient if one 167 # wants to extract parameters from either the URL or HTTP template into the 168 # request fields and also want access to the raw HTTP body. 169 # 170 # Example: 171 # 172 # message GetResourceRequest { 173 # // A unique request id. 174 # string request_id = 1; 175 # 176 # // The raw HTTP body is bound to this field. 177 # google.api.HttpBody http_body = 2; 178 # } 179 # 180 # service ResourceService { 181 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 182 # rpc UpdateResource(google.api.HttpBody) returns 183 # (google.protobuf.Empty); 184 # } 185 # 186 # Example with streaming methods: 187 # 188 # service CaldavService { 189 # rpc GetCalendar(stream google.api.HttpBody) 190 # returns (stream google.api.HttpBody); 191 # rpc UpdateCalendar(stream google.api.HttpBody) 192 # returns (stream google.api.HttpBody); 193 # } 194 # 195 # Use of this type only changes how the request and response bodies are 196 # handled, all other features will continue to work unchanged. 197 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 198 "data": "A String", # The HTTP request/response body as raw binary. 199 "extensions": [ # Application specific response metadata. Must be set in the first response 200 # for streaming APIs. 201 { 202 "a_key": "", # Properties of the object. Contains field @type with type URL. 203 }, 204 ], 205 }</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="Patient-everything">Patient-everything(name, end=None, x__xgafv=None, start=None)</code> 210 <pre>Retrieves all the resources in the patient compartment for a `Patient` 211resource. 212 213Implements the FHIR extended operation 214[Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything). 215 216On success, the response body will contain a JSON-encoded representation 217of a `Bundle` resource of type `searchset`, containing the results of the 218operation. 219Errors generated by the FHIR store will contain a JSON-encoded 220`OperationOutcome` resource describing the reason for the error. If the 221request cannot be mapped to a valid API method on a FHIR store, a generic 222GCP error might be returned instead. 223 224Args: 225 name: string, Name of the `Patient` resource for which the information is required. (required) 226 end: string, The response includes records prior to the end date. If no end date is 227provided, all records subsequent to the start date are in scope. 228 x__xgafv: string, V1 error format. 229 Allowed values 230 1 - v1 error format 231 2 - v2 error format 232 start: string, The response includes records subsequent to the start date. If no start 233date is provided, all records prior to the end date are in scope. 234 235Returns: 236 An object of the form: 237 238 { # Message that represents an arbitrary HTTP body. It should only be used for 239 # payload formats that can't be represented as JSON, such as raw binary or 240 # an HTML page. 241 # 242 # 243 # This message can be used both in streaming and non-streaming API methods in 244 # the request as well as the response. 245 # 246 # It can be used as a top-level request field, which is convenient if one 247 # wants to extract parameters from either the URL or HTTP template into the 248 # request fields and also want access to the raw HTTP body. 249 # 250 # Example: 251 # 252 # message GetResourceRequest { 253 # // A unique request id. 254 # string request_id = 1; 255 # 256 # // The raw HTTP body is bound to this field. 257 # google.api.HttpBody http_body = 2; 258 # } 259 # 260 # service ResourceService { 261 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 262 # rpc UpdateResource(google.api.HttpBody) returns 263 # (google.protobuf.Empty); 264 # } 265 # 266 # Example with streaming methods: 267 # 268 # service CaldavService { 269 # rpc GetCalendar(stream google.api.HttpBody) 270 # returns (stream google.api.HttpBody); 271 # rpc UpdateCalendar(stream google.api.HttpBody) 272 # returns (stream google.api.HttpBody); 273 # } 274 # 275 # Use of this type only changes how the request and response bodies are 276 # handled, all other features will continue to work unchanged. 277 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 278 "data": "A String", # The HTTP request/response body as raw binary. 279 "extensions": [ # Application specific response metadata. Must be set in the first response 280 # for streaming APIs. 281 { 282 "a_key": "", # Properties of the object. Contains field @type with type URL. 283 }, 284 ], 285 }</pre> 286</div> 287 288<div class="method"> 289 <code class="details" id="Resource-purge">Resource-purge(name, x__xgafv=None)</code> 290 <pre>Deletes all the historical versions of a resource (excluding the current 291version) from the FHIR store. To remove all versions of a resource, first 292delete the current version and then call this method. 293 294This is not a FHIR standard operation. 295 296Args: 297 name: string, The name of the resource to purge. (required) 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 { # A generic empty message that you can re-use to avoid defining duplicated 307 # empty messages in your APIs. A typical example is to use it as the request 308 # or the response type of an API method. For instance: 309 # 310 # service Foo { 311 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 312 # } 313 # 314 # The JSON representation for `Empty` is empty JSON object `{}`. 315 }</pre> 316</div> 317 318<div class="method"> 319 <code class="details" id="capabilities">capabilities(name, x__xgafv=None)</code> 320 <pre>Gets the FHIR [capability 321statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) 322for the store, which contains a description of functionality supported by 323the server. 324 325Implements the FHIR standard [capabilities 326interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities). 327 328On success, the response body will contain a JSON-encoded representation 329of a `CapabilityStatement` resource. 330 331Args: 332 name: string, Name of the FHIR store to retrieve the capabilities for. (required) 333 x__xgafv: string, V1 error format. 334 Allowed values 335 1 - v1 error format 336 2 - v2 error format 337 338Returns: 339 An object of the form: 340 341 { # Message that represents an arbitrary HTTP body. It should only be used for 342 # payload formats that can't be represented as JSON, such as raw binary or 343 # an HTML page. 344 # 345 # 346 # This message can be used both in streaming and non-streaming API methods in 347 # the request as well as the response. 348 # 349 # It can be used as a top-level request field, which is convenient if one 350 # wants to extract parameters from either the URL or HTTP template into the 351 # request fields and also want access to the raw HTTP body. 352 # 353 # Example: 354 # 355 # message GetResourceRequest { 356 # // A unique request id. 357 # string request_id = 1; 358 # 359 # // The raw HTTP body is bound to this field. 360 # google.api.HttpBody http_body = 2; 361 # } 362 # 363 # service ResourceService { 364 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 365 # rpc UpdateResource(google.api.HttpBody) returns 366 # (google.protobuf.Empty); 367 # } 368 # 369 # Example with streaming methods: 370 # 371 # service CaldavService { 372 # rpc GetCalendar(stream google.api.HttpBody) 373 # returns (stream google.api.HttpBody); 374 # rpc UpdateCalendar(stream google.api.HttpBody) 375 # returns (stream google.api.HttpBody); 376 # } 377 # 378 # Use of this type only changes how the request and response bodies are 379 # handled, all other features will continue to work unchanged. 380 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 381 "data": "A String", # The HTTP request/response body as raw binary. 382 "extensions": [ # Application specific response metadata. Must be set in the first response 383 # for streaming APIs. 384 { 385 "a_key": "", # Properties of the object. Contains field @type with type URL. 386 }, 387 ], 388 }</pre> 389</div> 390 391<div class="method"> 392 <code class="details" id="conditionalDelete">conditionalDelete(parent, type, x__xgafv=None)</code> 393 <pre>Deletes FHIR resources that match a search query. 394 395Implements the FHIR standard [conditional delete 396interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1). 397If multiple resources match, all of them will be deleted. 398 399Search terms are provided as query parameters following the same pattern as 400the search method. 401 402Note: Unless resource versioning is disabled by setting the 403disable_resource_versioning flag 404on the FHIR store, the deleted resources will be moved to a history 405repository that can still be retrieved through vread 406and related methods, unless they are removed by the 407purge method. 408 409Args: 410 parent: string, The name of the FHIR store this resource belongs to. (required) 411 type: string, The FHIR resource type to delete, such as Patient or Observation. For a 412complete list, see the [FHIR Resource 413Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). (required) 414 x__xgafv: string, V1 error format. 415 Allowed values 416 1 - v1 error format 417 2 - v2 error format 418 419Returns: 420 An object of the form: 421 422 { # A generic empty message that you can re-use to avoid defining duplicated 423 # empty messages in your APIs. A typical example is to use it as the request 424 # or the response type of an API method. For instance: 425 # 426 # service Foo { 427 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 428 # } 429 # 430 # The JSON representation for `Empty` is empty JSON object `{}`. 431 }</pre> 432</div> 433 434<div class="method"> 435 <code class="details" id="conditionalPatch">conditionalPatch(parent, type, body, x__xgafv=None)</code> 436 <pre>If a resource is found based on the search criteria specified in the query 437parameters, updates part of that resource by applying the operations 438specified in a [JSON Patch](http://jsonpatch.com/) document. 439 440Implements the FHIR standard [conditional patch 441interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). 442 443Search terms are provided as query parameters following the same pattern as 444the search method. 445 446If the search criteria identify more than one match, the request will 447return a `412 Precondition Failed` error. 448 449The request body must contain a JSON Patch document, and the request 450headers must contain `Content-Type: application/json-patch+json`. 451 452On success, the response body will contain a JSON-encoded representation 453of the updated resource, including the server-assigned version ID. 454Errors generated by the FHIR store will contain a JSON-encoded 455`OperationOutcome` resource describing the reason for the error. If the 456request cannot be mapped to a valid API method on a FHIR store, a generic 457GCP error might be returned instead. 458 459Args: 460 parent: string, The name of the FHIR store this resource belongs to. (required) 461 type: string, The FHIR resource type to update, such as Patient or Observation. For a 462complete list, see the [FHIR Resource 463Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). (required) 464 body: object, The request body. (required) 465 The object takes the form of: 466 467{ # Message that represents an arbitrary HTTP body. It should only be used for 468 # payload formats that can't be represented as JSON, such as raw binary or 469 # an HTML page. 470 # 471 # 472 # This message can be used both in streaming and non-streaming API methods in 473 # the request as well as the response. 474 # 475 # It can be used as a top-level request field, which is convenient if one 476 # wants to extract parameters from either the URL or HTTP template into the 477 # request fields and also want access to the raw HTTP body. 478 # 479 # Example: 480 # 481 # message GetResourceRequest { 482 # // A unique request id. 483 # string request_id = 1; 484 # 485 # // The raw HTTP body is bound to this field. 486 # google.api.HttpBody http_body = 2; 487 # } 488 # 489 # service ResourceService { 490 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 491 # rpc UpdateResource(google.api.HttpBody) returns 492 # (google.protobuf.Empty); 493 # } 494 # 495 # Example with streaming methods: 496 # 497 # service CaldavService { 498 # rpc GetCalendar(stream google.api.HttpBody) 499 # returns (stream google.api.HttpBody); 500 # rpc UpdateCalendar(stream google.api.HttpBody) 501 # returns (stream google.api.HttpBody); 502 # } 503 # 504 # Use of this type only changes how the request and response bodies are 505 # handled, all other features will continue to work unchanged. 506 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 507 "data": "A String", # The HTTP request/response body as raw binary. 508 "extensions": [ # Application specific response metadata. Must be set in the first response 509 # for streaming APIs. 510 { 511 "a_key": "", # Properties of the object. Contains field @type with type URL. 512 }, 513 ], 514 } 515 516 x__xgafv: string, V1 error format. 517 Allowed values 518 1 - v1 error format 519 2 - v2 error format 520 521Returns: 522 An object of the form: 523 524 { # Message that represents an arbitrary HTTP body. It should only be used for 525 # payload formats that can't be represented as JSON, such as raw binary or 526 # an HTML page. 527 # 528 # 529 # This message can be used both in streaming and non-streaming API methods in 530 # the request as well as the response. 531 # 532 # It can be used as a top-level request field, which is convenient if one 533 # wants to extract parameters from either the URL or HTTP template into the 534 # request fields and also want access to the raw HTTP body. 535 # 536 # Example: 537 # 538 # message GetResourceRequest { 539 # // A unique request id. 540 # string request_id = 1; 541 # 542 # // The raw HTTP body is bound to this field. 543 # google.api.HttpBody http_body = 2; 544 # } 545 # 546 # service ResourceService { 547 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 548 # rpc UpdateResource(google.api.HttpBody) returns 549 # (google.protobuf.Empty); 550 # } 551 # 552 # Example with streaming methods: 553 # 554 # service CaldavService { 555 # rpc GetCalendar(stream google.api.HttpBody) 556 # returns (stream google.api.HttpBody); 557 # rpc UpdateCalendar(stream google.api.HttpBody) 558 # returns (stream google.api.HttpBody); 559 # } 560 # 561 # Use of this type only changes how the request and response bodies are 562 # handled, all other features will continue to work unchanged. 563 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 564 "data": "A String", # The HTTP request/response body as raw binary. 565 "extensions": [ # Application specific response metadata. Must be set in the first response 566 # for streaming APIs. 567 { 568 "a_key": "", # Properties of the object. Contains field @type with type URL. 569 }, 570 ], 571 }</pre> 572</div> 573 574<div class="method"> 575 <code class="details" id="conditionalUpdate">conditionalUpdate(parent, type, body, x__xgafv=None)</code> 576 <pre>If a resource is found based on the search criteria specified in the query 577parameters, updates the entire contents of that resource. 578 579Implements the FHIR standard [conditional update 580interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update). 581 582Search terms are provided as query parameters following the same pattern as 583the search method. 584 585If the search criteria identify more than one match, the request will 586return a `412 Precondition Failed` error. 587If the search criteria identify zero matches, and the supplied resource 588body contains an `id`, and the FHIR store has 589enable_update_create set, creates the 590resource with the client-specified ID. If the search criteria identify zero 591matches, and the supplied resource body does not contain an `id`, the 592resource will be created with a server-assigned ID as per the 593create method. 594 595The request body must contain a JSON-encoded FHIR resource, and the request 596headers must contain `Content-Type: application/fhir+json`. 597 598On success, the response body will contain a JSON-encoded representation 599of the updated resource, including the server-assigned version ID. 600Errors generated by the FHIR store will contain a JSON-encoded 601`OperationOutcome` resource describing the reason for the error. If the 602request cannot be mapped to a valid API method on a FHIR store, a generic 603GCP error might be returned instead. 604 605Args: 606 parent: string, The name of the FHIR store this resource belongs to. (required) 607 type: string, The FHIR resource type to update, such as Patient or Observation. For a 608complete list, see the [FHIR Resource 609Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). 610Must match the resource type in the provided content. (required) 611 body: object, The request body. (required) 612 The object takes the form of: 613 614{ # Message that represents an arbitrary HTTP body. It should only be used for 615 # payload formats that can't be represented as JSON, such as raw binary or 616 # an HTML page. 617 # 618 # 619 # This message can be used both in streaming and non-streaming API methods in 620 # the request as well as the response. 621 # 622 # It can be used as a top-level request field, which is convenient if one 623 # wants to extract parameters from either the URL or HTTP template into the 624 # request fields and also want access to the raw HTTP body. 625 # 626 # Example: 627 # 628 # message GetResourceRequest { 629 # // A unique request id. 630 # string request_id = 1; 631 # 632 # // The raw HTTP body is bound to this field. 633 # google.api.HttpBody http_body = 2; 634 # } 635 # 636 # service ResourceService { 637 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 638 # rpc UpdateResource(google.api.HttpBody) returns 639 # (google.protobuf.Empty); 640 # } 641 # 642 # Example with streaming methods: 643 # 644 # service CaldavService { 645 # rpc GetCalendar(stream google.api.HttpBody) 646 # returns (stream google.api.HttpBody); 647 # rpc UpdateCalendar(stream google.api.HttpBody) 648 # returns (stream google.api.HttpBody); 649 # } 650 # 651 # Use of this type only changes how the request and response bodies are 652 # handled, all other features will continue to work unchanged. 653 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 654 "data": "A String", # The HTTP request/response body as raw binary. 655 "extensions": [ # Application specific response metadata. Must be set in the first response 656 # for streaming APIs. 657 { 658 "a_key": "", # Properties of the object. Contains field @type with type URL. 659 }, 660 ], 661 } 662 663 x__xgafv: string, V1 error format. 664 Allowed values 665 1 - v1 error format 666 2 - v2 error format 667 668Returns: 669 An object of the form: 670 671 { # Message that represents an arbitrary HTTP body. It should only be used for 672 # payload formats that can't be represented as JSON, such as raw binary or 673 # an HTML page. 674 # 675 # 676 # This message can be used both in streaming and non-streaming API methods in 677 # the request as well as the response. 678 # 679 # It can be used as a top-level request field, which is convenient if one 680 # wants to extract parameters from either the URL or HTTP template into the 681 # request fields and also want access to the raw HTTP body. 682 # 683 # Example: 684 # 685 # message GetResourceRequest { 686 # // A unique request id. 687 # string request_id = 1; 688 # 689 # // The raw HTTP body is bound to this field. 690 # google.api.HttpBody http_body = 2; 691 # } 692 # 693 # service ResourceService { 694 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 695 # rpc UpdateResource(google.api.HttpBody) returns 696 # (google.protobuf.Empty); 697 # } 698 # 699 # Example with streaming methods: 700 # 701 # service CaldavService { 702 # rpc GetCalendar(stream google.api.HttpBody) 703 # returns (stream google.api.HttpBody); 704 # rpc UpdateCalendar(stream google.api.HttpBody) 705 # returns (stream google.api.HttpBody); 706 # } 707 # 708 # Use of this type only changes how the request and response bodies are 709 # handled, all other features will continue to work unchanged. 710 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 711 "data": "A String", # The HTTP request/response body as raw binary. 712 "extensions": [ # Application specific response metadata. Must be set in the first response 713 # for streaming APIs. 714 { 715 "a_key": "", # Properties of the object. Contains field @type with type URL. 716 }, 717 ], 718 }</pre> 719</div> 720 721<div class="method"> 722 <code class="details" id="create">create(parent, type, body, x__xgafv=None)</code> 723 <pre>Creates a FHIR resource. 724 725Implements the FHIR standard [create 726interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create), 727which creates a new resource with a server-assigned resource ID. 728 729Also supports the FHIR standard [conditional create 730interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), 731specified by supplying an `If-None-Exist` header containing a FHIR search 732query. If no resources match this search query, the server processes the 733create operation as normal. 734 735The request body must contain a JSON-encoded FHIR resource, and the request 736headers must contain `Content-Type: application/fhir+json`. 737 738On success, the response body will contain a JSON-encoded representation 739of the resource as it was created on the server, including the 740server-assigned resource ID and version ID. 741Errors generated by the FHIR store will contain a JSON-encoded 742`OperationOutcome` resource describing the reason for the error. If the 743request cannot be mapped to a valid API method on a FHIR store, a generic 744GCP error might be returned instead. 745 746Args: 747 parent: string, The name of the FHIR store this resource belongs to. (required) 748 type: string, The FHIR resource type to create, such as Patient or Observation. For a 749complete list, see the [FHIR Resource 750Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). 751Must match the resource type in the provided content. (required) 752 body: object, The request body. (required) 753 The object takes the form of: 754 755{ # Message that represents an arbitrary HTTP body. It should only be used for 756 # payload formats that can't be represented as JSON, such as raw binary or 757 # an HTML page. 758 # 759 # 760 # This message can be used both in streaming and non-streaming API methods in 761 # the request as well as the response. 762 # 763 # It can be used as a top-level request field, which is convenient if one 764 # wants to extract parameters from either the URL or HTTP template into the 765 # request fields and also want access to the raw HTTP body. 766 # 767 # Example: 768 # 769 # message GetResourceRequest { 770 # // A unique request id. 771 # string request_id = 1; 772 # 773 # // The raw HTTP body is bound to this field. 774 # google.api.HttpBody http_body = 2; 775 # } 776 # 777 # service ResourceService { 778 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 779 # rpc UpdateResource(google.api.HttpBody) returns 780 # (google.protobuf.Empty); 781 # } 782 # 783 # Example with streaming methods: 784 # 785 # service CaldavService { 786 # rpc GetCalendar(stream google.api.HttpBody) 787 # returns (stream google.api.HttpBody); 788 # rpc UpdateCalendar(stream google.api.HttpBody) 789 # returns (stream google.api.HttpBody); 790 # } 791 # 792 # Use of this type only changes how the request and response bodies are 793 # handled, all other features will continue to work unchanged. 794 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 795 "data": "A String", # The HTTP request/response body as raw binary. 796 "extensions": [ # Application specific response metadata. Must be set in the first response 797 # for streaming APIs. 798 { 799 "a_key": "", # Properties of the object. Contains field @type with type URL. 800 }, 801 ], 802 } 803 804 x__xgafv: string, V1 error format. 805 Allowed values 806 1 - v1 error format 807 2 - v2 error format 808 809Returns: 810 An object of the form: 811 812 { # Message that represents an arbitrary HTTP body. It should only be used for 813 # payload formats that can't be represented as JSON, such as raw binary or 814 # an HTML page. 815 # 816 # 817 # This message can be used both in streaming and non-streaming API methods in 818 # the request as well as the response. 819 # 820 # It can be used as a top-level request field, which is convenient if one 821 # wants to extract parameters from either the URL or HTTP template into the 822 # request fields and also want access to the raw HTTP body. 823 # 824 # Example: 825 # 826 # message GetResourceRequest { 827 # // A unique request id. 828 # string request_id = 1; 829 # 830 # // The raw HTTP body is bound to this field. 831 # google.api.HttpBody http_body = 2; 832 # } 833 # 834 # service ResourceService { 835 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 836 # rpc UpdateResource(google.api.HttpBody) returns 837 # (google.protobuf.Empty); 838 # } 839 # 840 # Example with streaming methods: 841 # 842 # service CaldavService { 843 # rpc GetCalendar(stream google.api.HttpBody) 844 # returns (stream google.api.HttpBody); 845 # rpc UpdateCalendar(stream google.api.HttpBody) 846 # returns (stream google.api.HttpBody); 847 # } 848 # 849 # Use of this type only changes how the request and response bodies are 850 # handled, all other features will continue to work unchanged. 851 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 852 "data": "A String", # The HTTP request/response body as raw binary. 853 "extensions": [ # Application specific response metadata. Must be set in the first response 854 # for streaming APIs. 855 { 856 "a_key": "", # Properties of the object. Contains field @type with type URL. 857 }, 858 ], 859 }</pre> 860</div> 861 862<div class="method"> 863 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 864 <pre>Deletes a FHIR resource. 865 866Implements the FHIR standard [delete 867interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete). 868 869Note: Unless resource versioning is disabled by setting the 870disable_resource_versioning flag 871on the FHIR store, the deleted resources will be moved to a history 872repository that can still be retrieved through vread 873and related methods, unless they are removed by the 874purge method. 875 876Args: 877 name: string, The name of the resource to delete. (required) 878 x__xgafv: string, V1 error format. 879 Allowed values 880 1 - v1 error format 881 2 - v2 error format 882 883Returns: 884 An object of the form: 885 886 { # Message that represents an arbitrary HTTP body. It should only be used for 887 # payload formats that can't be represented as JSON, such as raw binary or 888 # an HTML page. 889 # 890 # 891 # This message can be used both in streaming and non-streaming API methods in 892 # the request as well as the response. 893 # 894 # It can be used as a top-level request field, which is convenient if one 895 # wants to extract parameters from either the URL or HTTP template into the 896 # request fields and also want access to the raw HTTP body. 897 # 898 # Example: 899 # 900 # message GetResourceRequest { 901 # // A unique request id. 902 # string request_id = 1; 903 # 904 # // The raw HTTP body is bound to this field. 905 # google.api.HttpBody http_body = 2; 906 # } 907 # 908 # service ResourceService { 909 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 910 # rpc UpdateResource(google.api.HttpBody) returns 911 # (google.protobuf.Empty); 912 # } 913 # 914 # Example with streaming methods: 915 # 916 # service CaldavService { 917 # rpc GetCalendar(stream google.api.HttpBody) 918 # returns (stream google.api.HttpBody); 919 # rpc UpdateCalendar(stream google.api.HttpBody) 920 # returns (stream google.api.HttpBody); 921 # } 922 # 923 # Use of this type only changes how the request and response bodies are 924 # handled, all other features will continue to work unchanged. 925 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 926 "data": "A String", # The HTTP request/response body as raw binary. 927 "extensions": [ # Application specific response metadata. Must be set in the first response 928 # for streaming APIs. 929 { 930 "a_key": "", # Properties of the object. Contains field @type with type URL. 931 }, 932 ], 933 }</pre> 934</div> 935 936<div class="method"> 937 <code class="details" id="executeBundle">executeBundle(parent, body, x__xgafv=None)</code> 938 <pre>Executes all the requests in the given Bundle. 939 940Implements the FHIR standard [batch/transaction 941interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction). 942 943Supports all interactions within a bundle, except search. This method 944accepts Bundles of type `batch` and `transaction`, processing them 945according to the [batch processing 946rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1) 947and [transaction processing 948rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2). 949 950The request body must contain a JSON-encoded FHIR `Bundle` resource, and 951the request headers must contain `Content-Type: application/fhir+json`. 952 953For a batch bundle or a successful transaction the response body will 954contain a JSON-encoded representation of a `Bundle` resource of type 955`batch-response` or `transaction-response` containing one entry for each 956entry in the request, with the outcome of processing the entry. In the 957case of an error for a transaction bundle, the response body will contain 958a JSON-encoded `OperationOutcome` resource describing the reason for the 959error. If the request cannot be mapped to a valid API method on a FHIR 960store, a generic GCP error might be returned instead. 961 962Args: 963 parent: string, Name of the FHIR store in which this bundle will be executed. (required) 964 body: object, The request body. (required) 965 The object takes the form of: 966 967{ # Message that represents an arbitrary HTTP body. It should only be used for 968 # payload formats that can't be represented as JSON, such as raw binary or 969 # an HTML page. 970 # 971 # 972 # This message can be used both in streaming and non-streaming API methods in 973 # the request as well as the response. 974 # 975 # It can be used as a top-level request field, which is convenient if one 976 # wants to extract parameters from either the URL or HTTP template into the 977 # request fields and also want access to the raw HTTP body. 978 # 979 # Example: 980 # 981 # message GetResourceRequest { 982 # // A unique request id. 983 # string request_id = 1; 984 # 985 # // The raw HTTP body is bound to this field. 986 # google.api.HttpBody http_body = 2; 987 # } 988 # 989 # service ResourceService { 990 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 991 # rpc UpdateResource(google.api.HttpBody) returns 992 # (google.protobuf.Empty); 993 # } 994 # 995 # Example with streaming methods: 996 # 997 # service CaldavService { 998 # rpc GetCalendar(stream google.api.HttpBody) 999 # returns (stream google.api.HttpBody); 1000 # rpc UpdateCalendar(stream google.api.HttpBody) 1001 # returns (stream google.api.HttpBody); 1002 # } 1003 # 1004 # Use of this type only changes how the request and response bodies are 1005 # handled, all other features will continue to work unchanged. 1006 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1007 "data": "A String", # The HTTP request/response body as raw binary. 1008 "extensions": [ # Application specific response metadata. Must be set in the first response 1009 # for streaming APIs. 1010 { 1011 "a_key": "", # Properties of the object. Contains field @type with type URL. 1012 }, 1013 ], 1014 } 1015 1016 x__xgafv: string, V1 error format. 1017 Allowed values 1018 1 - v1 error format 1019 2 - v2 error format 1020 1021Returns: 1022 An object of the form: 1023 1024 { # Message that represents an arbitrary HTTP body. It should only be used for 1025 # payload formats that can't be represented as JSON, such as raw binary or 1026 # an HTML page. 1027 # 1028 # 1029 # This message can be used both in streaming and non-streaming API methods in 1030 # the request as well as the response. 1031 # 1032 # It can be used as a top-level request field, which is convenient if one 1033 # wants to extract parameters from either the URL or HTTP template into the 1034 # request fields and also want access to the raw HTTP body. 1035 # 1036 # Example: 1037 # 1038 # message GetResourceRequest { 1039 # // A unique request id. 1040 # string request_id = 1; 1041 # 1042 # // The raw HTTP body is bound to this field. 1043 # google.api.HttpBody http_body = 2; 1044 # } 1045 # 1046 # service ResourceService { 1047 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1048 # rpc UpdateResource(google.api.HttpBody) returns 1049 # (google.protobuf.Empty); 1050 # } 1051 # 1052 # Example with streaming methods: 1053 # 1054 # service CaldavService { 1055 # rpc GetCalendar(stream google.api.HttpBody) 1056 # returns (stream google.api.HttpBody); 1057 # rpc UpdateCalendar(stream google.api.HttpBody) 1058 # returns (stream google.api.HttpBody); 1059 # } 1060 # 1061 # Use of this type only changes how the request and response bodies are 1062 # handled, all other features will continue to work unchanged. 1063 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1064 "data": "A String", # The HTTP request/response body as raw binary. 1065 "extensions": [ # Application specific response metadata. Must be set in the first response 1066 # for streaming APIs. 1067 { 1068 "a_key": "", # Properties of the object. Contains field @type with type URL. 1069 }, 1070 ], 1071 }</pre> 1072</div> 1073 1074<div class="method"> 1075 <code class="details" id="history">history(name, count=None, since=None, page=None, at=None, x__xgafv=None)</code> 1076 <pre>Lists all the versions of a resource (including the current version and 1077deleted versions) from the FHIR store. 1078 1079Implements the per-resource form of the FHIR standard [history 1080interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#history). 1081 1082On success, the response body will contain a JSON-encoded representation 1083of a `Bundle` resource of type `history`, containing the version history 1084sorted from most recent to oldest versions. 1085Errors generated by the FHIR store will contain a JSON-encoded 1086`OperationOutcome` resource describing the reason for the error. If the 1087request cannot be mapped to a valid API method on a FHIR store, a generic 1088GCP error might be returned instead. 1089 1090Args: 1091 name: string, The name of the resource to retrieve. (required) 1092 count: integer, The maximum number of search results on a page. Defaults to 1000. 1093 since: string, Only include resource versions that were created at or after the given 1094instant in time. The instant in time uses the format 1095YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 10962017-01-01T00:00:00Z). The time must be specified to the second and 1097include a time zone. 1098 page: string, Used to retrieve the first, previous, next, or last page of resource 1099versions when using pagination. Value should be set to the value of the 1100`link.url` field returned in the response to the previous request, where 1101`link.relation` is "first", "previous", "next" or "last". 1102 1103Omit `page` if no previous request has been made. 1104 at: string, Only include resource versions that were current at some point during the 1105time period specified in the date time value. The date parameter format is 1106yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] 1107 1108Clients may specify any of the following: 1109 1110* An entire year: `_at=2019` 1111* An entire month: `_at=2019-01` 1112* A specific day: `_at=2019-01-20` 1113* A specific second: `_at=2018-12-31T23:59:58Z` 1114 x__xgafv: string, V1 error format. 1115 Allowed values 1116 1 - v1 error format 1117 2 - v2 error format 1118 1119Returns: 1120 An object of the form: 1121 1122 { # Message that represents an arbitrary HTTP body. It should only be used for 1123 # payload formats that can't be represented as JSON, such as raw binary or 1124 # an HTML page. 1125 # 1126 # 1127 # This message can be used both in streaming and non-streaming API methods in 1128 # the request as well as the response. 1129 # 1130 # It can be used as a top-level request field, which is convenient if one 1131 # wants to extract parameters from either the URL or HTTP template into the 1132 # request fields and also want access to the raw HTTP body. 1133 # 1134 # Example: 1135 # 1136 # message GetResourceRequest { 1137 # // A unique request id. 1138 # string request_id = 1; 1139 # 1140 # // The raw HTTP body is bound to this field. 1141 # google.api.HttpBody http_body = 2; 1142 # } 1143 # 1144 # service ResourceService { 1145 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1146 # rpc UpdateResource(google.api.HttpBody) returns 1147 # (google.protobuf.Empty); 1148 # } 1149 # 1150 # Example with streaming methods: 1151 # 1152 # service CaldavService { 1153 # rpc GetCalendar(stream google.api.HttpBody) 1154 # returns (stream google.api.HttpBody); 1155 # rpc UpdateCalendar(stream google.api.HttpBody) 1156 # returns (stream google.api.HttpBody); 1157 # } 1158 # 1159 # Use of this type only changes how the request and response bodies are 1160 # handled, all other features will continue to work unchanged. 1161 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1162 "data": "A String", # The HTTP request/response body as raw binary. 1163 "extensions": [ # Application specific response metadata. Must be set in the first response 1164 # for streaming APIs. 1165 { 1166 "a_key": "", # Properties of the object. Contains field @type with type URL. 1167 }, 1168 ], 1169 }</pre> 1170</div> 1171 1172<div class="method"> 1173 <code class="details" id="patch">patch(name, body, x__xgafv=None)</code> 1174 <pre>Updates part of an existing resource by applying the operations specified 1175in a [JSON Patch](http://jsonpatch.com/) document. 1176 1177Implements the FHIR standard [patch 1178interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). 1179 1180The request body must contain a JSON Patch document, and the request 1181headers must contain `Content-Type: application/json-patch+json`. 1182 1183On success, the response body will contain a JSON-encoded representation 1184of the updated resource, including the server-assigned version ID. 1185Errors generated by the FHIR store will contain a JSON-encoded 1186`OperationOutcome` resource describing the reason for the error. If the 1187request cannot be mapped to a valid API method on a FHIR store, a generic 1188GCP error might be returned instead. 1189 1190Args: 1191 name: string, The name of the resource to update. (required) 1192 body: object, The request body. (required) 1193 The object takes the form of: 1194 1195{ # Message that represents an arbitrary HTTP body. It should only be used for 1196 # payload formats that can't be represented as JSON, such as raw binary or 1197 # an HTML page. 1198 # 1199 # 1200 # This message can be used both in streaming and non-streaming API methods in 1201 # the request as well as the response. 1202 # 1203 # It can be used as a top-level request field, which is convenient if one 1204 # wants to extract parameters from either the URL or HTTP template into the 1205 # request fields and also want access to the raw HTTP body. 1206 # 1207 # Example: 1208 # 1209 # message GetResourceRequest { 1210 # // A unique request id. 1211 # string request_id = 1; 1212 # 1213 # // The raw HTTP body is bound to this field. 1214 # google.api.HttpBody http_body = 2; 1215 # } 1216 # 1217 # service ResourceService { 1218 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1219 # rpc UpdateResource(google.api.HttpBody) returns 1220 # (google.protobuf.Empty); 1221 # } 1222 # 1223 # Example with streaming methods: 1224 # 1225 # service CaldavService { 1226 # rpc GetCalendar(stream google.api.HttpBody) 1227 # returns (stream google.api.HttpBody); 1228 # rpc UpdateCalendar(stream google.api.HttpBody) 1229 # returns (stream google.api.HttpBody); 1230 # } 1231 # 1232 # Use of this type only changes how the request and response bodies are 1233 # handled, all other features will continue to work unchanged. 1234 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1235 "data": "A String", # The HTTP request/response body as raw binary. 1236 "extensions": [ # Application specific response metadata. Must be set in the first response 1237 # for streaming APIs. 1238 { 1239 "a_key": "", # Properties of the object. Contains field @type with type URL. 1240 }, 1241 ], 1242 } 1243 1244 x__xgafv: string, V1 error format. 1245 Allowed values 1246 1 - v1 error format 1247 2 - v2 error format 1248 1249Returns: 1250 An object of the form: 1251 1252 { # Message that represents an arbitrary HTTP body. It should only be used for 1253 # payload formats that can't be represented as JSON, such as raw binary or 1254 # an HTML page. 1255 # 1256 # 1257 # This message can be used both in streaming and non-streaming API methods in 1258 # the request as well as the response. 1259 # 1260 # It can be used as a top-level request field, which is convenient if one 1261 # wants to extract parameters from either the URL or HTTP template into the 1262 # request fields and also want access to the raw HTTP body. 1263 # 1264 # Example: 1265 # 1266 # message GetResourceRequest { 1267 # // A unique request id. 1268 # string request_id = 1; 1269 # 1270 # // The raw HTTP body is bound to this field. 1271 # google.api.HttpBody http_body = 2; 1272 # } 1273 # 1274 # service ResourceService { 1275 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1276 # rpc UpdateResource(google.api.HttpBody) returns 1277 # (google.protobuf.Empty); 1278 # } 1279 # 1280 # Example with streaming methods: 1281 # 1282 # service CaldavService { 1283 # rpc GetCalendar(stream google.api.HttpBody) 1284 # returns (stream google.api.HttpBody); 1285 # rpc UpdateCalendar(stream google.api.HttpBody) 1286 # returns (stream google.api.HttpBody); 1287 # } 1288 # 1289 # Use of this type only changes how the request and response bodies are 1290 # handled, all other features will continue to work unchanged. 1291 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1292 "data": "A String", # The HTTP request/response body as raw binary. 1293 "extensions": [ # Application specific response metadata. Must be set in the first response 1294 # for streaming APIs. 1295 { 1296 "a_key": "", # Properties of the object. Contains field @type with type URL. 1297 }, 1298 ], 1299 }</pre> 1300</div> 1301 1302<div class="method"> 1303 <code class="details" id="read">read(name, x__xgafv=None)</code> 1304 <pre>Gets the contents of a FHIR resource. 1305 1306Implements the FHIR standard [read 1307interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read). 1308 1309Also supports the FHIR standard [conditional read 1310interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread) 1311specified by supplying an `If-Modified-Since` header with a date/time value 1312or an `If-None-Match` header with an ETag value. 1313 1314On success, the response body will contain a JSON-encoded representation 1315of the resource. 1316Errors generated by the FHIR store will contain a JSON-encoded 1317`OperationOutcome` resource describing the reason for the error. If the 1318request cannot be mapped to a valid API method on a FHIR store, a generic 1319GCP error might be returned instead. 1320 1321Args: 1322 name: string, The name of the resource to retrieve. (required) 1323 x__xgafv: string, V1 error format. 1324 Allowed values 1325 1 - v1 error format 1326 2 - v2 error format 1327 1328Returns: 1329 An object of the form: 1330 1331 { # Message that represents an arbitrary HTTP body. It should only be used for 1332 # payload formats that can't be represented as JSON, such as raw binary or 1333 # an HTML page. 1334 # 1335 # 1336 # This message can be used both in streaming and non-streaming API methods in 1337 # the request as well as the response. 1338 # 1339 # It can be used as a top-level request field, which is convenient if one 1340 # wants to extract parameters from either the URL or HTTP template into the 1341 # request fields and also want access to the raw HTTP body. 1342 # 1343 # Example: 1344 # 1345 # message GetResourceRequest { 1346 # // A unique request id. 1347 # string request_id = 1; 1348 # 1349 # // The raw HTTP body is bound to this field. 1350 # google.api.HttpBody http_body = 2; 1351 # } 1352 # 1353 # service ResourceService { 1354 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1355 # rpc UpdateResource(google.api.HttpBody) returns 1356 # (google.protobuf.Empty); 1357 # } 1358 # 1359 # Example with streaming methods: 1360 # 1361 # service CaldavService { 1362 # rpc GetCalendar(stream google.api.HttpBody) 1363 # returns (stream google.api.HttpBody); 1364 # rpc UpdateCalendar(stream google.api.HttpBody) 1365 # returns (stream google.api.HttpBody); 1366 # } 1367 # 1368 # Use of this type only changes how the request and response bodies are 1369 # handled, all other features will continue to work unchanged. 1370 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1371 "data": "A String", # The HTTP request/response body as raw binary. 1372 "extensions": [ # Application specific response metadata. Must be set in the first response 1373 # for streaming APIs. 1374 { 1375 "a_key": "", # Properties of the object. Contains field @type with type URL. 1376 }, 1377 ], 1378 }</pre> 1379</div> 1380 1381<div class="method"> 1382 <code class="details" id="search">search(parent, body, x__xgafv=None)</code> 1383 <pre>Searches for resources in the given FHIR store according to criteria 1384specified as query parameters. 1385 1386Implements the FHIR standard [search 1387interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) 1388using the search semantics described in the [FHIR Search 1389specification](http://hl7.org/implement/standards/fhir/STU3/search.html). 1390 1391Supports three methods of search defined by the specification: 1392 1393* `GET [base]?[parameters]` to search across all resources. 1394* `GET [base]/[type]?[parameters]` to search resources of a specified 1395type. 1396* `POST [base]/[type]/_search?[parameters]` as an alternate form having 1397the same semantics as the `GET` method. 1398 1399The `GET` methods do not support compartment searches. The `POST` method 1400does not support `application/x-www-form-urlencoded` search parameters. 1401 1402On success, the response body will contain a JSON-encoded representation 1403of a `Bundle` resource of type `searchset`, containing the results of the 1404search. 1405Errors generated by the FHIR store will contain a JSON-encoded 1406`OperationOutcome` resource describing the reason for the error. If the 1407request cannot be mapped to a valid API method on a FHIR store, a generic 1408GCP error might be returned instead. 1409 1410The server's capability statement, retrieved through 1411capabilities, indicates what search parameters 1412are supported on each FHIR resource. A list of all search parameters 1413defined by the specification can be found in the [FHIR Search Parameter 1414Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). 1415 1416Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, 1417`:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. 1418 1419Args: 1420 parent: string, Name of the FHIR store to retrieve resources from. (required) 1421 body: object, The request body. (required) 1422 The object takes the form of: 1423 1424{ # Request to search the resources in the specified FHIR store. 1425 "resourceType": "A String", # The FHIR resource type to search, such as Patient or Observation. For a 1426 # complete list, see the [FHIR Resource 1427 # Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). 1428 } 1429 1430 x__xgafv: string, V1 error format. 1431 Allowed values 1432 1 - v1 error format 1433 2 - v2 error format 1434 1435Returns: 1436 An object of the form: 1437 1438 { # Message that represents an arbitrary HTTP body. It should only be used for 1439 # payload formats that can't be represented as JSON, such as raw binary or 1440 # an HTML page. 1441 # 1442 # 1443 # This message can be used both in streaming and non-streaming API methods in 1444 # the request as well as the response. 1445 # 1446 # It can be used as a top-level request field, which is convenient if one 1447 # wants to extract parameters from either the URL or HTTP template into the 1448 # request fields and also want access to the raw HTTP body. 1449 # 1450 # Example: 1451 # 1452 # message GetResourceRequest { 1453 # // A unique request id. 1454 # string request_id = 1; 1455 # 1456 # // The raw HTTP body is bound to this field. 1457 # google.api.HttpBody http_body = 2; 1458 # } 1459 # 1460 # service ResourceService { 1461 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1462 # rpc UpdateResource(google.api.HttpBody) returns 1463 # (google.protobuf.Empty); 1464 # } 1465 # 1466 # Example with streaming methods: 1467 # 1468 # service CaldavService { 1469 # rpc GetCalendar(stream google.api.HttpBody) 1470 # returns (stream google.api.HttpBody); 1471 # rpc UpdateCalendar(stream google.api.HttpBody) 1472 # returns (stream google.api.HttpBody); 1473 # } 1474 # 1475 # Use of this type only changes how the request and response bodies are 1476 # handled, all other features will continue to work unchanged. 1477 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1478 "data": "A String", # The HTTP request/response body as raw binary. 1479 "extensions": [ # Application specific response metadata. Must be set in the first response 1480 # for streaming APIs. 1481 { 1482 "a_key": "", # Properties of the object. Contains field @type with type URL. 1483 }, 1484 ], 1485 }</pre> 1486</div> 1487 1488<div class="method"> 1489 <code class="details" id="update">update(name, body, x__xgafv=None)</code> 1490 <pre>Updates the entire contents of a resource. 1491 1492Implements the FHIR standard [update 1493interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#update). 1494 1495If the specified resource does 1496not exist and the FHIR store has 1497enable_update_create set, creates the 1498resource with the client-specified ID. 1499 1500The request body must contain a JSON-encoded FHIR resource, and the request 1501headers must contain `Content-Type: application/fhir+json`. The resource 1502must contain an `id` element having an identical value to the ID in the 1503REST path of the request. 1504 1505On success, the response body will contain a JSON-encoded representation 1506of the updated resource, including the server-assigned version ID. 1507Errors generated by the FHIR store will contain a JSON-encoded 1508`OperationOutcome` resource describing the reason for the error. If the 1509request cannot be mapped to a valid API method on a FHIR store, a generic 1510GCP error might be returned instead. 1511 1512Args: 1513 name: string, The name of the resource to update. (required) 1514 body: object, The request body. (required) 1515 The object takes the form of: 1516 1517{ # Message that represents an arbitrary HTTP body. It should only be used for 1518 # payload formats that can't be represented as JSON, such as raw binary or 1519 # an HTML page. 1520 # 1521 # 1522 # This message can be used both in streaming and non-streaming API methods in 1523 # the request as well as the response. 1524 # 1525 # It can be used as a top-level request field, which is convenient if one 1526 # wants to extract parameters from either the URL or HTTP template into the 1527 # request fields and also want access to the raw HTTP body. 1528 # 1529 # Example: 1530 # 1531 # message GetResourceRequest { 1532 # // A unique request id. 1533 # string request_id = 1; 1534 # 1535 # // The raw HTTP body is bound to this field. 1536 # google.api.HttpBody http_body = 2; 1537 # } 1538 # 1539 # service ResourceService { 1540 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1541 # rpc UpdateResource(google.api.HttpBody) returns 1542 # (google.protobuf.Empty); 1543 # } 1544 # 1545 # Example with streaming methods: 1546 # 1547 # service CaldavService { 1548 # rpc GetCalendar(stream google.api.HttpBody) 1549 # returns (stream google.api.HttpBody); 1550 # rpc UpdateCalendar(stream google.api.HttpBody) 1551 # returns (stream google.api.HttpBody); 1552 # } 1553 # 1554 # Use of this type only changes how the request and response bodies are 1555 # handled, all other features will continue to work unchanged. 1556 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1557 "data": "A String", # The HTTP request/response body as raw binary. 1558 "extensions": [ # Application specific response metadata. Must be set in the first response 1559 # for streaming APIs. 1560 { 1561 "a_key": "", # Properties of the object. Contains field @type with type URL. 1562 }, 1563 ], 1564 } 1565 1566 x__xgafv: string, V1 error format. 1567 Allowed values 1568 1 - v1 error format 1569 2 - v2 error format 1570 1571Returns: 1572 An object of the form: 1573 1574 { # Message that represents an arbitrary HTTP body. It should only be used for 1575 # payload formats that can't be represented as JSON, such as raw binary or 1576 # an HTML page. 1577 # 1578 # 1579 # This message can be used both in streaming and non-streaming API methods in 1580 # the request as well as the response. 1581 # 1582 # It can be used as a top-level request field, which is convenient if one 1583 # wants to extract parameters from either the URL or HTTP template into the 1584 # request fields and also want access to the raw HTTP body. 1585 # 1586 # Example: 1587 # 1588 # message GetResourceRequest { 1589 # // A unique request id. 1590 # string request_id = 1; 1591 # 1592 # // The raw HTTP body is bound to this field. 1593 # google.api.HttpBody http_body = 2; 1594 # } 1595 # 1596 # service ResourceService { 1597 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1598 # rpc UpdateResource(google.api.HttpBody) returns 1599 # (google.protobuf.Empty); 1600 # } 1601 # 1602 # Example with streaming methods: 1603 # 1604 # service CaldavService { 1605 # rpc GetCalendar(stream google.api.HttpBody) 1606 # returns (stream google.api.HttpBody); 1607 # rpc UpdateCalendar(stream google.api.HttpBody) 1608 # returns (stream google.api.HttpBody); 1609 # } 1610 # 1611 # Use of this type only changes how the request and response bodies are 1612 # handled, all other features will continue to work unchanged. 1613 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1614 "data": "A String", # The HTTP request/response body as raw binary. 1615 "extensions": [ # Application specific response metadata. Must be set in the first response 1616 # for streaming APIs. 1617 { 1618 "a_key": "", # Properties of the object. Contains field @type with type URL. 1619 }, 1620 ], 1621 }</pre> 1622</div> 1623 1624<div class="method"> 1625 <code class="details" id="vread">vread(name, x__xgafv=None)</code> 1626 <pre>Gets the contents of a version (current or historical) of a FHIR resource 1627by version ID. 1628 1629Implements the FHIR standard [vread 1630interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). 1631 1632On success, the response body will contain a JSON-encoded representation 1633of the resource. 1634Errors generated by the FHIR store will contain a JSON-encoded 1635`OperationOutcome` resource describing the reason for the error. If the 1636request cannot be mapped to a valid API method on a FHIR store, a generic 1637GCP error might be returned instead. 1638 1639Args: 1640 name: string, The name of the resource version to retrieve. (required) 1641 x__xgafv: string, V1 error format. 1642 Allowed values 1643 1 - v1 error format 1644 2 - v2 error format 1645 1646Returns: 1647 An object of the form: 1648 1649 { # Message that represents an arbitrary HTTP body. It should only be used for 1650 # payload formats that can't be represented as JSON, such as raw binary or 1651 # an HTML page. 1652 # 1653 # 1654 # This message can be used both in streaming and non-streaming API methods in 1655 # the request as well as the response. 1656 # 1657 # It can be used as a top-level request field, which is convenient if one 1658 # wants to extract parameters from either the URL or HTTP template into the 1659 # request fields and also want access to the raw HTTP body. 1660 # 1661 # Example: 1662 # 1663 # message GetResourceRequest { 1664 # // A unique request id. 1665 # string request_id = 1; 1666 # 1667 # // The raw HTTP body is bound to this field. 1668 # google.api.HttpBody http_body = 2; 1669 # } 1670 # 1671 # service ResourceService { 1672 # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); 1673 # rpc UpdateResource(google.api.HttpBody) returns 1674 # (google.protobuf.Empty); 1675 # } 1676 # 1677 # Example with streaming methods: 1678 # 1679 # service CaldavService { 1680 # rpc GetCalendar(stream google.api.HttpBody) 1681 # returns (stream google.api.HttpBody); 1682 # rpc UpdateCalendar(stream google.api.HttpBody) 1683 # returns (stream google.api.HttpBody); 1684 # } 1685 # 1686 # Use of this type only changes how the request and response bodies are 1687 # handled, all other features will continue to work unchanged. 1688 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 1689 "data": "A String", # The HTTP request/response body as raw binary. 1690 "extensions": [ # Application specific response metadata. Must be set in the first response 1691 # for streaming APIs. 1692 { 1693 "a_key": "", # Properties of the object. Contains field @type with type URL. 1694 }, 1695 ], 1696 }</pre> 1697</div> 1698 1699</body></html>