google-api-python-client 2.170.0__py3-none-any.whl → 2.172.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (176) hide show
  1. {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/METADATA +14 -2
  2. {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/RECORD +176 -175
  3. {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/WHEEL +1 -1
  4. googleapiclient/discovery_cache/documents/admin.directory_v1.json +3 -3
  5. googleapiclient/discovery_cache/documents/admin.directoryv1.json +3 -3
  6. googleapiclient/discovery_cache/documents/aiplatform.v1.json +693 -17
  7. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1278 -21
  8. googleapiclient/discovery_cache/documents/alloydb.v1.json +5 -5
  9. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +20 -5
  10. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +20 -5
  11. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +296 -8
  12. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +30 -20
  13. googleapiclient/discovery_cache/documents/apigee.v1.json +4 -4
  14. googleapiclient/discovery_cache/documents/apihub.v1.json +7 -7
  15. googleapiclient/discovery_cache/documents/apim.v1alpha.json +8 -2
  16. googleapiclient/discovery_cache/documents/areainsights.v1.json +2 -2
  17. googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +117 -9
  18. googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +117 -9
  19. googleapiclient/discovery_cache/documents/backupdr.v1.json +3 -3
  20. googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +3 -3
  21. googleapiclient/discovery_cache/documents/batch.v1.json +13 -1
  22. googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +114 -3
  23. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +92 -1
  24. googleapiclient/discovery_cache/documents/blogger.v2.json +3 -1
  25. googleapiclient/discovery_cache/documents/blogger.v3.json +3 -1
  26. googleapiclient/discovery_cache/documents/chat.v1.json +6 -9
  27. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +51 -5
  28. googleapiclient/discovery_cache/documents/classroom.v1.json +48 -2
  29. googleapiclient/discovery_cache/documents/cloudbuild.v1.json +8 -4
  30. googleapiclient/discovery_cache/documents/cloudkms.v1.json +321 -10
  31. googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +149 -3
  32. googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +10 -5
  33. googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +10 -5
  34. googleapiclient/discovery_cache/documents/cloudsupport.v2.json +6 -6
  35. googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +6 -6
  36. googleapiclient/discovery_cache/documents/cloudtrace.v1.json +2 -2
  37. googleapiclient/discovery_cache/documents/composer.v1.json +35 -1
  38. googleapiclient/discovery_cache/documents/composer.v1beta1.json +2 -2
  39. googleapiclient/discovery_cache/documents/compute.alpha.json +3280 -1209
  40. googleapiclient/discovery_cache/documents/compute.beta.json +858 -193
  41. googleapiclient/discovery_cache/documents/compute.v1.json +627 -5
  42. googleapiclient/discovery_cache/documents/config.v1.json +4 -4
  43. googleapiclient/discovery_cache/documents/connectors.v1.json +11 -66
  44. googleapiclient/discovery_cache/documents/connectors.v2.json +7 -1
  45. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +1429 -306
  46. googleapiclient/discovery_cache/documents/container.v1.json +53 -1
  47. googleapiclient/discovery_cache/documents/container.v1beta1.json +53 -1
  48. googleapiclient/discovery_cache/documents/containeranalysis.v1.json +24 -2
  49. googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +27 -2
  50. googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +24 -2
  51. googleapiclient/discovery_cache/documents/content.v2.1.json +5 -1
  52. googleapiclient/discovery_cache/documents/css.v1.json +2 -2
  53. googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
  54. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +108 -1
  55. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +5 -1
  56. googleapiclient/discovery_cache/documents/datamigration.v1.json +18 -2
  57. googleapiclient/discovery_cache/documents/dataplex.v1.json +153 -58
  58. googleapiclient/discovery_cache/documents/dataportability.v1.json +10 -1
  59. googleapiclient/discovery_cache/documents/dataportability.v1beta.json +10 -1
  60. googleapiclient/discovery_cache/documents/dataproc.v1.json +96 -300
  61. googleapiclient/discovery_cache/documents/datastream.v1.json +44 -2
  62. googleapiclient/discovery_cache/documents/developerconnect.v1.json +426 -1
  63. googleapiclient/discovery_cache/documents/dfareporting.v4.json +8 -3
  64. googleapiclient/discovery_cache/documents/dialogflow.v2.json +3 -3
  65. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +3 -3
  66. googleapiclient/discovery_cache/documents/dialogflow.v3.json +287 -3
  67. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +3 -3
  68. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +329 -32
  69. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +396 -28
  70. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +329 -32
  71. googleapiclient/discovery_cache/documents/displayvideo.v2.json +3 -3
  72. googleapiclient/discovery_cache/documents/displayvideo.v3.json +3 -3
  73. googleapiclient/discovery_cache/documents/displayvideo.v4.json +3 -3
  74. googleapiclient/discovery_cache/documents/dlp.v2.json +33 -1
  75. googleapiclient/discovery_cache/documents/documentai.v1.json +9 -11
  76. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +9 -11
  77. googleapiclient/discovery_cache/documents/driveactivity.v2.json +2 -2
  78. googleapiclient/discovery_cache/documents/drivelabels.v2.json +96 -1
  79. googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +96 -1
  80. googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +3 -2
  81. googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +51 -1
  82. googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +51 -1
  83. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +372 -8
  84. googleapiclient/discovery_cache/documents/gkebackup.v1.json +41 -3
  85. googleapiclient/discovery_cache/documents/gkehub.v1.json +1 -3
  86. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +1 -5
  87. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +1 -3
  88. googleapiclient/discovery_cache/documents/gkehub.v2.json +1 -3
  89. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +1 -3
  90. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +1 -3
  91. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +24 -1
  92. googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +1 -1
  93. googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +1 -1
  94. googleapiclient/discovery_cache/documents/healthcare.v1.json +36 -34
  95. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +46 -889
  96. googleapiclient/discovery_cache/documents/iam.v1.json +7 -7
  97. googleapiclient/discovery_cache/documents/iap.v1.json +12 -5
  98. googleapiclient/discovery_cache/documents/integrations.v1.json +67 -1
  99. googleapiclient/discovery_cache/documents/kmsinventory.v1.json +10 -6
  100. googleapiclient/discovery_cache/documents/language.v1.json +13 -1
  101. googleapiclient/discovery_cache/documents/language.v1beta2.json +13 -1
  102. googleapiclient/discovery_cache/documents/language.v2.json +13 -1
  103. googleapiclient/discovery_cache/documents/logging.v2.json +15 -13
  104. googleapiclient/discovery_cache/documents/managedkafka.v1.json +51 -1
  105. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +893 -63
  106. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +3 -3
  107. googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +250 -1
  108. googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +3 -3
  109. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +42 -42
  110. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +4 -54
  111. googleapiclient/discovery_cache/documents/monitoring.v1.json +51 -1
  112. googleapiclient/discovery_cache/documents/monitoring.v3.json +2 -2
  113. googleapiclient/discovery_cache/documents/netapp.v1.json +26 -14
  114. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +101 -20
  115. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +20 -15
  116. googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +2 -2
  117. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +40 -11
  118. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +289 -5
  119. googleapiclient/discovery_cache/documents/networksecurity.v1.json +20 -4
  120. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +564 -4
  121. googleapiclient/discovery_cache/documents/networkservices.v1.json +2 -2
  122. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +6 -2
  123. googleapiclient/discovery_cache/documents/notebooks.v2.json +3 -3
  124. googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +23 -1
  125. googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +23 -1
  126. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +2 -2
  127. googleapiclient/discovery_cache/documents/oslogin.v1.json +4 -4
  128. googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +9 -9
  129. googleapiclient/discovery_cache/documents/oslogin.v1beta.json +6 -6
  130. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +7 -5
  131. googleapiclient/discovery_cache/documents/playintegrity.v1.json +110 -1
  132. googleapiclient/discovery_cache/documents/policysimulator.v1.json +570 -1
  133. googleapiclient/discovery_cache/documents/privateca.v1.json +65 -1
  134. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +9 -2
  135. googleapiclient/discovery_cache/documents/redis.v1.json +5 -4
  136. googleapiclient/discovery_cache/documents/redis.v1beta1.json +5 -4
  137. googleapiclient/discovery_cache/documents/retail.v2.json +23 -1
  138. googleapiclient/discovery_cache/documents/retail.v2alpha.json +59 -4
  139. googleapiclient/discovery_cache/documents/retail.v2beta.json +23 -1
  140. googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +3294 -0
  141. googleapiclient/discovery_cache/documents/safebrowsing.v5.json +393 -1
  142. googleapiclient/discovery_cache/documents/script.v1.json +1 -107
  143. googleapiclient/discovery_cache/documents/securitycenter.v1.json +337 -11
  144. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +337 -11
  145. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +337 -11
  146. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +100 -1
  147. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +112 -1
  148. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +104 -1
  149. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +114 -15
  150. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +105 -6
  151. googleapiclient/discovery_cache/documents/serviceusage.v1.json +100 -1
  152. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +100 -1
  153. googleapiclient/discovery_cache/documents/sheets.v4.json +7 -2
  154. googleapiclient/discovery_cache/documents/spanner.v1.json +57 -17
  155. googleapiclient/discovery_cache/documents/sqladmin.v1.json +37 -3
  156. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +37 -3
  157. googleapiclient/discovery_cache/documents/storage.v1.json +20 -2
  158. googleapiclient/discovery_cache/documents/storagetransfer.v1.json +5 -5
  159. googleapiclient/discovery_cache/documents/sts.v1.json +2 -2
  160. googleapiclient/discovery_cache/documents/sts.v1beta.json +2 -2
  161. googleapiclient/discovery_cache/documents/tasks.v1.json +2 -2
  162. googleapiclient/discovery_cache/documents/trafficdirector.v3.json +5 -5
  163. googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +82 -5
  164. googleapiclient/discovery_cache/documents/vault.v1.json +18 -1
  165. googleapiclient/discovery_cache/documents/versionhistory.v1.json +2 -2
  166. googleapiclient/discovery_cache/documents/videointelligence.v1.json +156 -1
  167. googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +156 -1
  168. googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +156 -1
  169. googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +156 -1
  170. googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +156 -1
  171. googleapiclient/discovery_cache/documents/vmmigration.v1.json +70 -3
  172. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +70 -3
  173. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +335 -139
  174. googleapiclient/version.py +1 -1
  175. {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info/licenses}/LICENSE +0 -0
  176. {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/top_level.txt +0 -0
@@ -234,7 +234,7 @@
234
234
  ],
235
235
  "parameters": {
236
236
  "sourceDataset": {
237
- "description": "Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.",
237
+ "description": "Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. R5 FHIR stores are not supported and will be skipped.",
238
238
  "location": "path",
239
239
  "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
240
240
  "required": true,
@@ -471,150 +471,6 @@
471
471
  "resources": {
472
472
  "annotationStores": {
473
473
  "methods": {
474
- "create": {
475
- "description": "Creates a new Annotation store within the parent dataset.",
476
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores",
477
- "httpMethod": "POST",
478
- "id": "healthcare.projects.locations.datasets.annotationStores.create",
479
- "parameterOrder": [
480
- "parent"
481
- ],
482
- "parameters": {
483
- "annotationStoreId": {
484
- "description": "Required. The ID of the Annotation store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.",
485
- "location": "query",
486
- "type": "string"
487
- },
488
- "parent": {
489
- "description": "Required. The name of the dataset this Annotation store belongs to.",
490
- "location": "path",
491
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
492
- "required": true,
493
- "type": "string"
494
- }
495
- },
496
- "path": "v1beta1/{+parent}/annotationStores",
497
- "request": {
498
- "$ref": "AnnotationStore"
499
- },
500
- "response": {
501
- "$ref": "AnnotationStore"
502
- },
503
- "scopes": [
504
- "https://www.googleapis.com/auth/cloud-healthcare",
505
- "https://www.googleapis.com/auth/cloud-platform"
506
- ]
507
- },
508
- "delete": {
509
- "description": "Deletes the specified Annotation store and removes all annotations that are contained within it.",
510
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}",
511
- "httpMethod": "DELETE",
512
- "id": "healthcare.projects.locations.datasets.annotationStores.delete",
513
- "parameterOrder": [
514
- "name"
515
- ],
516
- "parameters": {
517
- "name": {
518
- "description": "Required. The resource name of the Annotation store to delete.",
519
- "location": "path",
520
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
521
- "required": true,
522
- "type": "string"
523
- }
524
- },
525
- "path": "v1beta1/{+name}",
526
- "response": {
527
- "$ref": "Empty"
528
- },
529
- "scopes": [
530
- "https://www.googleapis.com/auth/cloud-healthcare",
531
- "https://www.googleapis.com/auth/cloud-platform"
532
- ]
533
- },
534
- "evaluate": {
535
- "description": "Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type EvaluateAnnotationStoreResponse, contained in the response. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).",
536
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:evaluate",
537
- "httpMethod": "POST",
538
- "id": "healthcare.projects.locations.datasets.annotationStores.evaluate",
539
- "parameterOrder": [
540
- "name"
541
- ],
542
- "parameters": {
543
- "name": {
544
- "description": "Required. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.",
545
- "location": "path",
546
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
547
- "required": true,
548
- "type": "string"
549
- }
550
- },
551
- "path": "v1beta1/{+name}:evaluate",
552
- "request": {
553
- "$ref": "EvaluateAnnotationStoreRequest"
554
- },
555
- "response": {
556
- "$ref": "Operation"
557
- },
558
- "scopes": [
559
- "https://www.googleapis.com/auth/cloud-healthcare",
560
- "https://www.googleapis.com/auth/cloud-platform"
561
- ]
562
- },
563
- "export": {
564
- "description": "Export Annotations from the Annotation store. If the request is successful, a detailed response is returned of type ExportAnnotationsResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).",
565
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:export",
566
- "httpMethod": "POST",
567
- "id": "healthcare.projects.locations.datasets.annotationStores.export",
568
- "parameterOrder": [
569
- "name"
570
- ],
571
- "parameters": {
572
- "name": {
573
- "description": "Required. The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.",
574
- "location": "path",
575
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
576
- "required": true,
577
- "type": "string"
578
- }
579
- },
580
- "path": "v1beta1/{+name}:export",
581
- "request": {
582
- "$ref": "ExportAnnotationsRequest"
583
- },
584
- "response": {
585
- "$ref": "Operation"
586
- },
587
- "scopes": [
588
- "https://www.googleapis.com/auth/cloud-healthcare",
589
- "https://www.googleapis.com/auth/cloud-platform"
590
- ]
591
- },
592
- "get": {
593
- "description": "Gets the specified Annotation store or returns NOT_FOUND if it does not exist.",
594
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}",
595
- "httpMethod": "GET",
596
- "id": "healthcare.projects.locations.datasets.annotationStores.get",
597
- "parameterOrder": [
598
- "name"
599
- ],
600
- "parameters": {
601
- "name": {
602
- "description": "Required. The resource name of the Annotation store to get.",
603
- "location": "path",
604
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
605
- "required": true,
606
- "type": "string"
607
- }
608
- },
609
- "path": "v1beta1/{+name}",
610
- "response": {
611
- "$ref": "AnnotationStore"
612
- },
613
- "scopes": [
614
- "https://www.googleapis.com/auth/cloud-healthcare",
615
- "https://www.googleapis.com/auth/cloud-platform"
616
- ]
617
- },
618
474
  "getIamPolicy": {
619
475
  "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
620
476
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:getIamPolicy",
@@ -647,112 +503,6 @@
647
503
  "https://www.googleapis.com/auth/cloud-platform"
648
504
  ]
649
505
  },
650
- "import": {
651
- "description": "Import Annotations to the Annotation store by loading data from the specified sources. If the request is successful, a detailed response is returned as of type ImportAnnotationsResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).",
652
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:import",
653
- "httpMethod": "POST",
654
- "id": "healthcare.projects.locations.datasets.annotationStores.import",
655
- "parameterOrder": [
656
- "name"
657
- ],
658
- "parameters": {
659
- "name": {
660
- "description": "Required. The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.",
661
- "location": "path",
662
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
663
- "required": true,
664
- "type": "string"
665
- }
666
- },
667
- "path": "v1beta1/{+name}:import",
668
- "request": {
669
- "$ref": "ImportAnnotationsRequest"
670
- },
671
- "response": {
672
- "$ref": "Operation"
673
- },
674
- "scopes": [
675
- "https://www.googleapis.com/auth/cloud-healthcare",
676
- "https://www.googleapis.com/auth/cloud-platform"
677
- ]
678
- },
679
- "list": {
680
- "description": "Lists the Annotation stores in the given dataset for a source store.",
681
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores",
682
- "httpMethod": "GET",
683
- "id": "healthcare.projects.locations.datasets.annotationStores.list",
684
- "parameterOrder": [
685
- "parent"
686
- ],
687
- "parameters": {
688
- "filter": {
689
- "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`.",
690
- "location": "query",
691
- "type": "string"
692
- },
693
- "pageSize": {
694
- "description": "Limit on the number of Annotation stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.",
695
- "format": "int32",
696
- "location": "query",
697
- "type": "integer"
698
- },
699
- "pageToken": {
700
- "description": "The next_page_token value returned from the previous List request, if any.",
701
- "location": "query",
702
- "type": "string"
703
- },
704
- "parent": {
705
- "description": "Required. Name of the dataset.",
706
- "location": "path",
707
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
708
- "required": true,
709
- "type": "string"
710
- }
711
- },
712
- "path": "v1beta1/{+parent}/annotationStores",
713
- "response": {
714
- "$ref": "ListAnnotationStoresResponse"
715
- },
716
- "scopes": [
717
- "https://www.googleapis.com/auth/cloud-healthcare",
718
- "https://www.googleapis.com/auth/cloud-platform"
719
- ]
720
- },
721
- "patch": {
722
- "description": "Updates the specified Annotation store.",
723
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}",
724
- "httpMethod": "PATCH",
725
- "id": "healthcare.projects.locations.datasets.annotationStores.patch",
726
- "parameterOrder": [
727
- "name"
728
- ],
729
- "parameters": {
730
- "name": {
731
- "description": "Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.",
732
- "location": "path",
733
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
734
- "required": true,
735
- "type": "string"
736
- },
737
- "updateMask": {
738
- "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
739
- "format": "google-fieldmask",
740
- "location": "query",
741
- "type": "string"
742
- }
743
- },
744
- "path": "v1beta1/{+name}",
745
- "request": {
746
- "$ref": "AnnotationStore"
747
- },
748
- "response": {
749
- "$ref": "AnnotationStore"
750
- },
751
- "scopes": [
752
- "https://www.googleapis.com/auth/cloud-healthcare",
753
- "https://www.googleapis.com/auth/cloud-platform"
754
- ]
755
- },
756
506
  "setIamPolicy": {
757
507
  "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
758
508
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:setIamPolicy",
@@ -801,187 +551,10 @@
801
551
  },
802
552
  "path": "v1beta1/{+resource}:testIamPermissions",
803
553
  "request": {
804
- "$ref": "TestIamPermissionsRequest"
805
- },
806
- "response": {
807
- "$ref": "TestIamPermissionsResponse"
808
- },
809
- "scopes": [
810
- "https://www.googleapis.com/auth/cloud-healthcare",
811
- "https://www.googleapis.com/auth/cloud-platform"
812
- ]
813
- }
814
- },
815
- "resources": {
816
- "annotations": {
817
- "methods": {
818
- "create": {
819
- "description": "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.",
820
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations",
821
- "httpMethod": "POST",
822
- "id": "healthcare.projects.locations.datasets.annotationStores.annotations.create",
823
- "parameterOrder": [
824
- "parent"
825
- ],
826
- "parameters": {
827
- "parent": {
828
- "description": "Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`.",
829
- "location": "path",
830
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
831
- "required": true,
832
- "type": "string"
833
- }
834
- },
835
- "path": "v1beta1/{+parent}/annotations",
836
- "request": {
837
- "$ref": "Annotation"
838
- },
839
- "response": {
840
- "$ref": "Annotation"
841
- },
842
- "scopes": [
843
- "https://www.googleapis.com/auth/cloud-healthcare",
844
- "https://www.googleapis.com/auth/cloud-platform"
845
- ]
846
- },
847
- "delete": {
848
- "description": "Deletes an Annotation or returns NOT_FOUND if it does not exist.",
849
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations/{annotationsId}",
850
- "httpMethod": "DELETE",
851
- "id": "healthcare.projects.locations.datasets.annotationStores.annotations.delete",
852
- "parameterOrder": [
853
- "name"
854
- ],
855
- "parameters": {
856
- "name": {
857
- "description": "Required. The resource name of the Annotation to delete.",
858
- "location": "path",
859
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$",
860
- "required": true,
861
- "type": "string"
862
- }
863
- },
864
- "path": "v1beta1/{+name}",
865
- "response": {
866
- "$ref": "Empty"
867
- },
868
- "scopes": [
869
- "https://www.googleapis.com/auth/cloud-healthcare",
870
- "https://www.googleapis.com/auth/cloud-platform"
871
- ]
872
- },
873
- "get": {
874
- "description": "Gets an Annotation.",
875
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations/{annotationsId}",
876
- "httpMethod": "GET",
877
- "id": "healthcare.projects.locations.datasets.annotationStores.annotations.get",
878
- "parameterOrder": [
879
- "name"
880
- ],
881
- "parameters": {
882
- "name": {
883
- "description": "Required. The resource name of the Annotation to retrieve.",
884
- "location": "path",
885
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$",
886
- "required": true,
887
- "type": "string"
888
- }
889
- },
890
- "path": "v1beta1/{+name}",
891
- "response": {
892
- "$ref": "Annotation"
893
- },
894
- "scopes": [
895
- "https://www.googleapis.com/auth/cloud-healthcare",
896
- "https://www.googleapis.com/auth/cloud-platform"
897
- ]
898
- },
899
- "list": {
900
- "description": "Lists the Annotations in the given Annotation store for a source resource.",
901
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations",
902
- "httpMethod": "GET",
903
- "id": "healthcare.projects.locations.datasets.annotationStores.annotations.list",
904
- "parameterOrder": [
905
- "parent"
906
- ],
907
- "parameters": {
908
- "filter": {
909
- "description": "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`.",
910
- "location": "query",
911
- "type": "string"
912
- },
913
- "pageSize": {
914
- "description": "Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.",
915
- "format": "int32",
916
- "location": "query",
917
- "type": "integer"
918
- },
919
- "pageToken": {
920
- "description": "The next_page_token value returned from the previous List request, if any.",
921
- "location": "query",
922
- "type": "string"
923
- },
924
- "parent": {
925
- "description": "Required. Name of the Annotation store to retrieve Annotations from.",
926
- "location": "path",
927
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$",
928
- "required": true,
929
- "type": "string"
930
- },
931
- "view": {
932
- "description": "Controls which fields are populated in the response.",
933
- "enum": [
934
- "ANNOTATION_VIEW_UNSPECIFIED",
935
- "ANNOTATION_VIEW_BASIC",
936
- "ANNOTATION_VIEW_FULL"
937
- ],
938
- "enumDescriptions": [
939
- "Same as BASIC.",
940
- "Only `name`, `annotation_source` and `custom_data` fields are populated.",
941
- "All fields are populated."
942
- ],
943
- "location": "query",
944
- "type": "string"
945
- }
946
- },
947
- "path": "v1beta1/{+parent}/annotations",
948
- "response": {
949
- "$ref": "ListAnnotationsResponse"
950
- },
951
- "scopes": [
952
- "https://www.googleapis.com/auth/cloud-healthcare",
953
- "https://www.googleapis.com/auth/cloud-platform"
954
- ]
955
- },
956
- "patch": {
957
- "description": "Updates the Annotation.",
958
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations/{annotationsId}",
959
- "httpMethod": "PATCH",
960
- "id": "healthcare.projects.locations.datasets.annotationStores.annotations.patch",
961
- "parameterOrder": [
962
- "name"
963
- ],
964
- "parameters": {
965
- "name": {
966
- "description": "Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.",
967
- "location": "path",
968
- "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$",
969
- "required": true,
970
- "type": "string"
971
- },
972
- "updateMask": {
973
- "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
974
- "format": "google-fieldmask",
975
- "location": "query",
976
- "type": "string"
977
- }
978
- },
979
- "path": "v1beta1/{+name}",
980
- "request": {
981
- "$ref": "Annotation"
554
+ "$ref": "TestIamPermissionsRequest"
982
555
  },
983
556
  "response": {
984
- "$ref": "Annotation"
557
+ "$ref": "TestIamPermissionsResponse"
985
558
  },
986
559
  "scopes": [
987
560
  "https://www.googleapis.com/auth/cloud-healthcare",
@@ -989,8 +562,6 @@
989
562
  ]
990
563
  }
991
564
  }
992
- }
993
- }
994
565
  },
995
566
  "consentStores": {
996
567
  "methods": {
@@ -3520,7 +3091,7 @@
3520
3091
  "fhirStores": {
3521
3092
  "methods": {
3522
3093
  "applyAdminConsents": {
3523
- "description": "Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the `consent_config.enforced_admin_consents` field of the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the `consent_config.enforced_admin_consents` field will be unchanged. To enforce a consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore.",
3094
+ "description": "Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the `consent_config.enforced_admin_consents` field of the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the `consent_config.enforced_admin_consents` field will be unchanged. To enforce a consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.",
3524
3095
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyAdminConsents",
3525
3096
  "httpMethod": "POST",
3526
3097
  "id": "healthcare.projects.locations.datasets.fhirStores.applyAdminConsents",
@@ -3549,7 +3120,7 @@
3549
3120
  ]
3550
3121
  },
3551
3122
  "applyConsents": {
3552
- "description": "Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To enforce consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore.",
3123
+ "description": "Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To enforce consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore. FHIR Consent is not supported in DSTU2 or R5.",
3553
3124
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyConsents",
3554
3125
  "httpMethod": "POST",
3555
3126
  "id": "healthcare.projects.locations.datasets.fhirStores.applyConsents",
@@ -3696,7 +3267,7 @@
3696
3267
  ],
3697
3268
  "parameters": {
3698
3269
  "sourceStore": {
3699
- "description": "Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.",
3270
+ "description": "Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. R5 stores are not supported.",
3700
3271
  "location": "path",
3701
3272
  "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$",
3702
3273
  "required": true,
@@ -3742,7 +3313,7 @@
3742
3313
  ]
3743
3314
  },
3744
3315
  "explainDataAccess": {
3745
- "description": "Explains all the permitted/denied actor, purpose and environment for a given resource.",
3316
+ "description": "Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not supported in DSTU2 or R5.",
3746
3317
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:explainDataAccess",
3747
3318
  "httpMethod": "GET",
3748
3319
  "id": "healthcare.projects.locations.datasets.fhirStores.explainDataAccess",
@@ -4141,7 +3712,7 @@
4141
3712
  "fhir": {
4142
3713
  "methods": {
4143
3714
  "Binary-create": {
4144
- "description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 1 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
3715
+ "description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4` and `R5`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 1 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
4145
3716
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary",
4146
3717
  "httpMethod": "POST",
4147
3718
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create",
@@ -4196,7 +3767,7 @@
4196
3767
  ]
4197
3768
  },
4198
3769
  "Binary-update": {
4199
- "description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
3770
+ "description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4` and `R5`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
4200
3771
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}",
4201
3772
  "httpMethod": "PUT",
4202
3773
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update",
@@ -4251,7 +3822,7 @@
4251
3822
  ]
4252
3823
  },
4253
3824
  "ConceptMap-search-translate": {
4254
- "description": "Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
3825
+ "description": "Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html), [R5](https://www.hl7.org/fhir/R5/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
4255
3826
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/$translate",
4256
3827
  "httpMethod": "GET",
4257
3828
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate",
@@ -4307,7 +3878,7 @@
4307
3878
  ]
4308
3879
  },
4309
3880
  "ConceptMap-translate": {
4310
- "description": "Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
3881
+ "description": "Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)), [R5](https://www.hl7.org/fhir/R5/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
4311
3882
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/{ConceptMapId}/$translate",
4312
3883
  "httpMethod": "GET",
4313
3884
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-translate",
@@ -4374,7 +3945,7 @@
4374
3945
  ]
4375
3946
  },
4376
3947
  "Encounter-everything": {
4377
- "description": "Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](https://hl7.org/fhir/DSTU2/encounter-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the \"http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\" extension.",
3948
+ "description": "Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](https://hl7.org/fhir/DSTU2/encounter-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/encounter-operations.html#everything), [R4](https://hl7.org/fhir/R4/encounter-operation-everything.html), or [R5](https://hl7.org/fhir/R5/encounter-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html), [R5](http://hl7.org/fhir/R5/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the \"http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\" extension.",
4378
3949
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Encounter/{EncounterId}/$everything",
4379
3950
  "httpMethod": "GET",
4380
3951
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Encounter-everything",
@@ -4421,7 +3992,7 @@
4421
3992
  ]
4422
3993
  },
4423
3994
  "Observation-lastn": {
4424
- "description": "Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
3995
+ "description": "Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html), [R5](https://hl7.org/fhir/R5/observation-operation-lastn.html)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
4425
3996
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Observation/$lastn",
4426
3997
  "httpMethod": "GET",
4427
3998
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn",
@@ -4484,7 +4055,7 @@
4484
4055
  ]
4485
4056
  },
4486
4057
  "Patient-everything": {
4487
- "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).",
4058
+ "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html), [R5](https://hl7.org/fhir/R5/patient-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html), [R5](http://hl7.org/fhir/R5/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).",
4488
4059
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything",
4489
4060
  "httpMethod": "GET",
4490
4061
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything",
@@ -4619,7 +4190,7 @@
4619
4190
  ]
4620
4191
  },
4621
4192
  "Resource-validate": {
4622
- "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), or [R4](https://hl7.org/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
4193
+ "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), [R4](https://hl7.org/fhir/R4/resource-operation-validate.html), or [R5](https://hl7.org/fhir/R5/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.",
4623
4194
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate",
4624
4195
  "httpMethod": "POST",
4625
4196
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate",
@@ -4641,7 +4212,7 @@
4641
4212
  "type": "string"
4642
4213
  },
4643
4214
  "type": {
4644
- "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), or [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.",
4215
+ "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), or [R5](https://hl7.org/fhir/R5/resourcelist.html)). Must match the resource type in the provided content.",
4645
4216
  "location": "path",
4646
4217
  "pattern": "^[^/]+$",
4647
4218
  "required": true,
@@ -4702,7 +4273,7 @@
4702
4273
  ]
4703
4274
  },
4704
4275
  "capabilities": {
4705
- "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.",
4276
+ "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html), [R5](https://hl7.org/fhir/R5/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities), [R5](https://hl7.org/fhir/R5/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.",
4706
4277
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata",
4707
4278
  "httpMethod": "GET",
4708
4279
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities",
@@ -4728,7 +4299,7 @@
4728
4299
  ]
4729
4300
  },
4730
4301
  "conditionalDelete": {
4731
- "description": "Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).",
4302
+ "description": "Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/fhir/R4/http.html#3.1.0.7.1), [R5](https://hl7.org/fhir/R5/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).",
4732
4303
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
4733
4304
  "httpMethod": "DELETE",
4734
4305
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete",
@@ -4745,7 +4316,7 @@
4745
4316
  "type": "string"
4746
4317
  },
4747
4318
  "type": {
4748
- "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).",
4319
+ "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).",
4749
4320
  "location": "path",
4750
4321
  "pattern": "^[^/]+$",
4751
4322
  "required": true,
@@ -4762,7 +4333,7 @@
4762
4333
  ]
4763
4334
  },
4764
4335
  "conditionalPatch": {
4765
- "description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).",
4336
+ "description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).",
4766
4337
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
4767
4338
  "httpMethod": "PATCH",
4768
4339
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch",
@@ -4779,7 +4350,7 @@
4779
4350
  "type": "string"
4780
4351
  },
4781
4352
  "type": {
4782
- "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).",
4353
+ "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).",
4783
4354
  "location": "path",
4784
4355
  "pattern": "^[^/]+$",
4785
4356
  "required": true,
@@ -4799,7 +4370,7 @@
4799
4370
  ]
4800
4371
  },
4801
4372
  "conditionalUpdate": {
4802
- "description": "If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).",
4373
+ "description": "If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/fhir/R4/http.html#cond-update), [R5](https://hl7.org/fhir/R5/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).",
4803
4374
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
4804
4375
  "httpMethod": "PUT",
4805
4376
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate",
@@ -4816,7 +4387,7 @@
4816
4387
  "type": "string"
4817
4388
  },
4818
4389
  "type": {
4819
- "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.",
4390
+ "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)). Must match the resource type in the provided content.",
4820
4391
  "location": "path",
4821
4392
  "pattern": "^[^/]+$",
4822
4393
  "required": true,
@@ -4836,7 +4407,7 @@
4836
4407
  ]
4837
4408
  },
4838
4409
  "create": {
4839
- "description": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).",
4410
+ "description": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), [R5](https://hl7.org/fhir/R5/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/fhir/R4/http.html#ccreate)), [R5](https://hl7.org/fhir/R5/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).",
4840
4411
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
4841
4412
  "httpMethod": "POST",
4842
4413
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.create",
@@ -4853,7 +4424,7 @@
4853
4424
  "type": "string"
4854
4425
  },
4855
4426
  "type": {
4856
- "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.",
4427
+ "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)). Must match the resource type in the provided content.",
4857
4428
  "location": "path",
4858
4429
  "pattern": "^[^/]+$",
4859
4430
  "required": true,
@@ -4873,7 +4444,7 @@
4873
4444
  ]
4874
4445
  },
4875
4446
  "delete": {
4876
- "description": "Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).",
4447
+ "description": "Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete), [R5](https://hl7.org/fhir/R5/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).",
4877
4448
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
4878
4449
  "httpMethod": "DELETE",
4879
4450
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.delete",
@@ -4899,7 +4470,7 @@
4899
4470
  ]
4900
4471
  },
4901
4472
  "executeBundle": {
4902
- "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).",
4473
+ "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction), [R5](https://hl7.org/fhir/R5/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules), [R5](https://hl7.org/fhir/R5/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules), [R5](https://hl7.org/fhir/R5/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).",
4903
4474
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir",
4904
4475
  "httpMethod": "POST",
4905
4476
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle",
@@ -4928,7 +4499,7 @@
4928
4499
  ]
4929
4500
  },
4930
4501
  "history": {
4931
- "description": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).",
4502
+ "description": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history), [R5](https://hl7.org/fhir/R5/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).",
4932
4503
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history",
4933
4504
  "httpMethod": "GET",
4934
4505
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.history",
@@ -4975,7 +4546,7 @@
4975
4546
  ]
4976
4547
  },
4977
4548
  "patch": {
4978
- "description": "Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).",
4549
+ "description": "Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).",
4979
4550
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
4980
4551
  "httpMethod": "PATCH",
4981
4552
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.patch",
@@ -5004,7 +4575,7 @@
5004
4575
  ]
5005
4576
  },
5006
4577
  "read": {
5007
- "description": "Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).",
4578
+ "description": "Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)), [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)), [R5](https://hl7.org/fhir/R5/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).",
5008
4579
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
5009
4580
  "httpMethod": "GET",
5010
4581
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.read",
@@ -5030,7 +4601,7 @@
5030
4601
  ]
5031
4602
  },
5032
4603
  "search": {
5033
- "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).",
4604
+ "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).",
5034
4605
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search",
5035
4606
  "httpMethod": "POST",
5036
4607
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search",
@@ -5059,7 +4630,7 @@
5059
4630
  ]
5060
4631
  },
5061
4632
  "search-type": {
5062
- "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).",
4633
+ "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).",
5063
4634
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search",
5064
4635
  "httpMethod": "POST",
5065
4636
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type",
@@ -5076,7 +4647,7 @@
5076
4647
  "type": "string"
5077
4648
  },
5078
4649
  "resourceType": {
5079
- "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).",
4650
+ "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).",
5080
4651
  "location": "path",
5081
4652
  "required": true,
5082
4653
  "type": "string"
@@ -5095,7 +4666,7 @@
5095
4666
  ]
5096
4667
  },
5097
4668
  "update": {
5098
- "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).",
4669
+ "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).",
5099
4670
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
5100
4671
  "httpMethod": "PUT",
5101
4672
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.update",
@@ -5124,7 +4695,7 @@
5124
4695
  ]
5125
4696
  },
5126
4697
  "vread": {
5127
- "description": "Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).",
4698
+ "description": "Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.org/fhir/R5/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).",
5128
4699
  "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history/{_historyId}",
5129
4700
  "httpMethod": "GET",
5130
4701
  "id": "healthcare.projects.locations.datasets.fhirStores.fhir.vread",
@@ -6017,7 +5588,7 @@
6017
5588
  }
6018
5589
  }
6019
5590
  },
6020
- "revision": "20250430",
5591
+ "revision": "20250526",
6021
5592
  "rootUrl": "https://healthcare.googleapis.com/",
6022
5593
  "schemas": {
6023
5594
  "AccessDeterminationLogConfig": {
@@ -6196,84 +5767,6 @@
6196
5767
  },
6197
5768
  "type": "object"
6198
5769
  },
6199
- "Annotation": {
6200
- "description": "An annotation record.",
6201
- "id": "Annotation",
6202
- "properties": {
6203
- "annotationSource": {
6204
- "$ref": "AnnotationSource",
6205
- "description": "Required. Details of the source."
6206
- },
6207
- "customData": {
6208
- "additionalProperties": {
6209
- "type": "string"
6210
- },
6211
- "description": "Additional information for this annotation record, such as annotator and verifier information or study campaign.",
6212
- "type": "object"
6213
- },
6214
- "imageAnnotation": {
6215
- "$ref": "ImageAnnotation",
6216
- "description": "Annotations for images. For example, bounding polygons."
6217
- },
6218
- "name": {
6219
- "description": "Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.",
6220
- "type": "string"
6221
- },
6222
- "resourceAnnotation": {
6223
- "$ref": "ResourceAnnotation",
6224
- "description": "Annotations for resource. For example, classification tags."
6225
- },
6226
- "textAnnotation": {
6227
- "$ref": "SensitiveTextAnnotation",
6228
- "description": "Annotations for sensitive texts. For example, a range that describes the location of sensitive text."
6229
- }
6230
- },
6231
- "type": "object"
6232
- },
6233
- "AnnotationConfig": {
6234
- "description": "Specifies how to store annotations during de-identification operation.",
6235
- "id": "AnnotationConfig",
6236
- "properties": {
6237
- "annotationStoreName": {
6238
- "description": "The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store.",
6239
- "type": "string"
6240
- },
6241
- "storeQuote": {
6242
- "description": "If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.",
6243
- "type": "boolean"
6244
- }
6245
- },
6246
- "type": "object"
6247
- },
6248
- "AnnotationSource": {
6249
- "description": "AnnotationSource holds the source information of the annotation.",
6250
- "id": "AnnotationSource",
6251
- "properties": {
6252
- "cloudHealthcareSource": {
6253
- "$ref": "CloudHealthcareSource",
6254
- "description": "Cloud Healthcare API resource."
6255
- }
6256
- },
6257
- "type": "object"
6258
- },
6259
- "AnnotationStore": {
6260
- "description": "An Annotation store that can store annotation resources such as labels and tags for text, image and audio.",
6261
- "id": "AnnotationStore",
6262
- "properties": {
6263
- "labels": {
6264
- "additionalProperties": {
6265
- "type": "string"
6266
- },
6267
- "description": "Optional. User-supplied key-value pairs used to organize Annotation stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.",
6268
- "type": "object"
6269
- },
6270
- "name": {
6271
- "description": "Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.",
6272
- "type": "string"
6273
- }
6274
- },
6275
- "type": "object"
6276
- },
6277
5770
  "ApplyAdminConsentsErrorDetail": {
6278
5771
  "description": "Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources.",
6279
5772
  "id": "ApplyAdminConsentsErrorDetail",
@@ -6597,24 +6090,6 @@
6597
6090
  },
6598
6091
  "type": "object"
6599
6092
  },
6600
- "BoundingPoly": {
6601
- "description": "A bounding polygon for the detected image annotation.",
6602
- "id": "BoundingPoly",
6603
- "properties": {
6604
- "label": {
6605
- "description": "A description of this polygon.",
6606
- "type": "string"
6607
- },
6608
- "vertices": {
6609
- "description": "List of the vertices of this polygon.",
6610
- "items": {
6611
- "$ref": "Vertex"
6612
- },
6613
- "type": "array"
6614
- }
6615
- },
6616
- "type": "object"
6617
- },
6618
6093
  "BulkExportGcsDestination": {
6619
6094
  "description": "The configuration for exporting to Cloud Storage using the bulk export API.",
6620
6095
  "id": "BulkExportGcsDestination",
@@ -6721,17 +6196,6 @@
6721
6196
  "properties": {},
6722
6197
  "type": "object"
6723
6198
  },
6724
- "CloudHealthcareSource": {
6725
- "description": "Cloud Healthcare API resource.",
6726
- "id": "CloudHealthcareSource",
6727
- "properties": {
6728
- "name": {
6729
- "description": "Full path of a Cloud Healthcare API resource.",
6730
- "type": "string"
6731
- }
6732
- },
6733
- "type": "object"
6734
- },
6735
6199
  "ConfigureSearchRequest": {
6736
6200
  "description": "Request to configure the search parameters for the specified FHIR store.",
6737
6201
  "id": "ConfigureSearchRequest",
@@ -7138,10 +6602,6 @@
7138
6602
  "description": "Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime.",
7139
6603
  "id": "DeidentifyConfig",
7140
6604
  "properties": {
7141
- "annotation": {
7142
- "$ref": "AnnotationConfig",
7143
- "description": "Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created."
7144
- },
7145
6605
  "dicom": {
7146
6606
  "$ref": "DicomConfig",
7147
6607
  "deprecated": true,
@@ -7272,19 +6732,6 @@
7272
6732
  "properties": {},
7273
6733
  "type": "object"
7274
6734
  },
7275
- "Detail": {
7276
- "description": "Contains multiple sensitive information findings for each resource slice.",
7277
- "id": "Detail",
7278
- "properties": {
7279
- "findings": {
7280
- "items": {
7281
- "$ref": "Finding"
7282
- },
7283
- "type": "array"
7284
- }
7285
- },
7286
- "type": "object"
7287
- },
7288
6735
  "DicomConfig": {
7289
6736
  "description": "Specifies the parameters needed for de-identification of DICOM stores.",
7290
6737
  "id": "DicomConfig",
@@ -7543,44 +6990,6 @@
7543
6990
  },
7544
6991
  "type": "object"
7545
6992
  },
7546
- "EvaluateAnnotationStoreRequest": {
7547
- "description": "Request to evaluate an Annotation store against a ground truth [Annotation store].",
7548
- "id": "EvaluateAnnotationStoreRequest",
7549
- "properties": {
7550
- "bigqueryDestination": {
7551
- "$ref": "GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination",
7552
- "description": "The BigQuery table where the server writes the output. BigQueryDestination requires the `roles/bigquery.dataEditor` and `roles/bigquery.jobUser` Cloud IAM roles."
7553
- },
7554
- "evalInfoTypeMapping": {
7555
- "additionalProperties": {
7556
- "type": "string"
7557
- },
7558
- "description": "Optional. InfoType mapping for `eval_store`. Different resources can map to the same infoType. For example, `PERSON_NAME`, `PERSON`, `NAME`, and `HUMAN` are different. To map all of these into a single infoType (such as `PERSON_NAME`), specify the following mapping: ``` info_type_mapping[\"PERSON\"] = \"PERSON_NAME\" info_type_mapping[\"NAME\"] = \"PERSON_NAME\" info_type_mapping[\"HUMAN\"] = \"PERSON_NAME\" ``` Unmentioned infoTypes, such as `DATE`, are treated as identity mapping. For example: ``` info_type_mapping[\"DATE\"] = \"DATE\" ``` InfoTypes are case-insensitive.",
7559
- "type": "object"
7560
- },
7561
- "goldenInfoTypeMapping": {
7562
- "additionalProperties": {
7563
- "type": "string"
7564
- },
7565
- "description": "Optional. Similar to `eval_info_type_mapping`, infoType mapping for `golden_store`.",
7566
- "type": "object"
7567
- },
7568
- "goldenStore": {
7569
- "description": "Required. The Annotation store to use as ground truth, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.",
7570
- "type": "string"
7571
- },
7572
- "infoTypeConfig": {
7573
- "$ref": "InfoTypeConfig"
7574
- }
7575
- },
7576
- "type": "object"
7577
- },
7578
- "EvaluateAnnotationStoreResponse": {
7579
- "description": "Response for successful Annotation store evaluation operations. This structure is included in the response upon operation completion.",
7580
- "id": "EvaluateAnnotationStoreResponse",
7581
- "properties": {},
7582
- "type": "object"
7583
- },
7584
6993
  "EvaluateUserConsentsRequest": {
7585
6994
  "description": "Evaluate a user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, causing slight delays between the time mappings are created or updated and when they are included in EvaluateUserConsents results.",
7586
6995
  "id": "EvaluateUserConsentsRequest",
@@ -7772,27 +7181,6 @@
7772
7181
  },
7773
7182
  "type": "object"
7774
7183
  },
7775
- "ExportAnnotationsRequest": {
7776
- "description": "Request to export Annotations. The export operation is not atomic. If a failure occurs, any annotations already exported are not removed.",
7777
- "id": "ExportAnnotationsRequest",
7778
- "properties": {
7779
- "bigqueryDestination": {
7780
- "$ref": "GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination",
7781
- "description": "The BigQuery output destination, which requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`."
7782
- },
7783
- "gcsDestination": {
7784
- "$ref": "GoogleCloudHealthcareV1beta1AnnotationGcsDestination",
7785
- "description": "The Cloud Storage destination, which requires the `roles/storage.objectAdmin` Cloud IAM role."
7786
- }
7787
- },
7788
- "type": "object"
7789
- },
7790
- "ExportAnnotationsResponse": {
7791
- "description": "Response for successful annotation export operations. This structure is included in response upon operation completion.",
7792
- "id": "ExportAnnotationsResponse",
7793
- "properties": {},
7794
- "type": "object"
7795
- },
7796
7184
  "ExportDicomDataRequest": {
7797
7185
  "description": "Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted.",
7798
7186
  "id": "ExportDicomDataRequest",
@@ -8041,7 +7429,7 @@
8041
7429
  "description": "Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination."
8042
7430
  },
8043
7431
  "complexDataTypeReferenceParsing": {
8044
- "description": "Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.",
7432
+ "description": "Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. Cannot be disabled in R5.",
8045
7433
  "enum": [
8046
7434
  "COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED",
8047
7435
  "DISABLED",
@@ -8056,7 +7444,7 @@
8056
7444
  },
8057
7445
  "consentConfig": {
8058
7446
  "$ref": "ConsentConfig",
8059
- "description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources."
7447
+ "description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. Not supported for R5 FHIR version."
8060
7448
  },
8061
7449
  "defaultSearchHandlingStrict": {
8062
7450
  "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.",
@@ -8092,7 +7480,7 @@
8092
7480
  "notificationConfig": {
8093
7481
  "$ref": "NotificationConfig",
8094
7482
  "deprecated": true,
8095
- "description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"."
7483
+ "description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\". Not supported in R5. Use `notification_configs` instead."
8096
7484
  },
8097
7485
  "notificationConfigs": {
8098
7486
  "description": "Specifies where and whether to send notifications upon changes to a Fhir store.",
@@ -8122,13 +7510,15 @@
8122
7510
  "VERSION_UNSPECIFIED",
8123
7511
  "DSTU2",
8124
7512
  "STU3",
8125
- "R4"
7513
+ "R4",
7514
+ "R5"
8126
7515
  ],
8127
7516
  "enumDescriptions": [
8128
7517
  "VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores.",
8129
7518
  "Draft Standard for Trial Use, [Release 2](https://www.hl7.org/fhir/DSTU2)",
8130
7519
  "Standard for Trial Use, [Release 3](https://www.hl7.org/fhir/STU3)",
8131
- "[Release 4](https://www.hl7.org/fhir/R4)"
7520
+ "[Release 4](https://www.hl7.org/fhir/R4)",
7521
+ "[Release 5](https://www.hl7.org/fhir/R5)"
8132
7522
  ],
8133
7523
  "type": "string"
8134
7524
  }
@@ -8218,7 +7608,7 @@
8218
7608
  "enumDescriptions": [
8219
7609
  "No action specified.",
8220
7610
  "Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field.",
8221
- "Inspect and transform any found PHI. When `AnnotationConfig` is provided, annotations of PHI will be generated, except for Date and Datetime.",
7611
+ "Inspect and transform any found PHI.",
8222
7612
  "Do not transform."
8223
7613
  ],
8224
7614
  "type": "string"
@@ -8233,44 +7623,6 @@
8233
7623
  },
8234
7624
  "type": "object"
8235
7625
  },
8236
- "FilterList": {
8237
- "description": "List of infoTypes to be filtered.",
8238
- "id": "FilterList",
8239
- "properties": {
8240
- "infoTypes": {
8241
- "description": "These infoTypes are based on after the `eval_info_type_mapping` and `golden_info_type_mapping`.",
8242
- "items": {
8243
- "type": "string"
8244
- },
8245
- "type": "array"
8246
- }
8247
- },
8248
- "type": "object"
8249
- },
8250
- "Finding": {
8251
- "id": "Finding",
8252
- "properties": {
8253
- "end": {
8254
- "description": "Zero-based ending index of the found text, exclusively.",
8255
- "format": "int64",
8256
- "type": "string"
8257
- },
8258
- "infoType": {
8259
- "description": "The type of information stored in this text range. For example, HumanName, BirthDate, or Address.",
8260
- "type": "string"
8261
- },
8262
- "quote": {
8263
- "description": "The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.",
8264
- "type": "string"
8265
- },
8266
- "start": {
8267
- "description": "Zero-based starting index of the found text, inclusively.",
8268
- "format": "int64",
8269
- "type": "string"
8270
- }
8271
- },
8272
- "type": "object"
8273
- },
8274
7626
  "GcsDestination": {
8275
7627
  "description": "The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location.",
8276
7628
  "id": "GcsDestination",
@@ -8325,71 +7677,6 @@
8325
7677
  },
8326
7678
  "type": "object"
8327
7679
  },
8328
- "GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination": {
8329
- "description": "The BigQuery table for export.",
8330
- "id": "GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination",
8331
- "properties": {
8332
- "force": {
8333
- "description": "Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.",
8334
- "type": "boolean"
8335
- },
8336
- "schemaType": {
8337
- "description": "Specifies the schema format to export.",
8338
- "enum": [
8339
- "SCHEMA_TYPE_UNSPECIFIED",
8340
- "SIMPLE"
8341
- ],
8342
- "enumDescriptions": [
8343
- "Same as SIMPLE.",
8344
- "A flatterned version of Annotation."
8345
- ],
8346
- "type": "string"
8347
- },
8348
- "tableUri": {
8349
- "description": "BigQuery URI to a table, up to 2000 characters long, must be of the form bq://projectId.bqDatasetId.tableId.",
8350
- "type": "string"
8351
- },
8352
- "writeDisposition": {
8353
- "description": "Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.",
8354
- "enum": [
8355
- "WRITE_DISPOSITION_UNSPECIFIED",
8356
- "WRITE_EMPTY",
8357
- "WRITE_TRUNCATE",
8358
- "WRITE_APPEND"
8359
- ],
8360
- "enumDescriptions": [
8361
- "Default behavior is the same as WRITE_EMPTY.",
8362
- "Only export data if the destination table is empty.",
8363
- "Erase all existing data in a table before writing the instances.",
8364
- "Append data to the existing table."
8365
- ],
8366
- "type": "string"
8367
- }
8368
- },
8369
- "type": "object"
8370
- },
8371
- "GoogleCloudHealthcareV1beta1AnnotationGcsDestination": {
8372
- "description": "The Cloud Storage location for export.",
8373
- "id": "GoogleCloudHealthcareV1beta1AnnotationGcsDestination",
8374
- "properties": {
8375
- "uriPrefix": {
8376
- "description": "The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`.",
8377
- "type": "string"
8378
- }
8379
- },
8380
- "type": "object"
8381
- },
8382
- "GoogleCloudHealthcareV1beta1AnnotationGcsSource": {
8383
- "description": "Specifies the configuration for importing data from Cloud Storage.",
8384
- "id": "GoogleCloudHealthcareV1beta1AnnotationGcsSource",
8385
- "properties": {
8386
- "uri": {
8387
- "description": "Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.json` imports all files with .json extensions in `my-directory/` and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata.",
8388
- "type": "string"
8389
- }
8390
- },
8391
- "type": "object"
8392
- },
8393
7680
  "GoogleCloudHealthcareV1beta1ConsentGcsDestination": {
8394
7681
  "description": "The Cloud Storage location for export.",
8395
7682
  "id": "GoogleCloudHealthcareV1beta1ConsentGcsDestination",
@@ -8858,25 +8145,6 @@
8858
8145
  },
8859
8146
  "type": "object"
8860
8147
  },
8861
- "ImageAnnotation": {
8862
- "description": "Image annotation.",
8863
- "id": "ImageAnnotation",
8864
- "properties": {
8865
- "boundingPolys": {
8866
- "description": "The list of polygons outlining the sensitive regions in the image.",
8867
- "items": {
8868
- "$ref": "BoundingPoly"
8869
- },
8870
- "type": "array"
8871
- },
8872
- "frameIndex": {
8873
- "description": "0-based index of the image frame. For example, an image frame in a DICOM instance.",
8874
- "format": "int32",
8875
- "type": "integer"
8876
- }
8877
- },
8878
- "type": "object"
8879
- },
8880
8148
  "ImageConfig": {
8881
8149
  "description": "Specifies how to handle de-identification of image pixels.",
8882
8150
  "id": "ImageConfig",
@@ -8916,22 +8184,6 @@
8916
8184
  },
8917
8185
  "type": "object"
8918
8186
  },
8919
- "ImportAnnotationsRequest": {
8920
- "description": "Request to import Annotations. The Annotations to be imported must have client-supplied resource names which indicate the annotation resource. The import operation is not atomic. If a failure occurs, any annotations already imported are not removed.",
8921
- "id": "ImportAnnotationsRequest",
8922
- "properties": {
8923
- "gcsSource": {
8924
- "$ref": "GoogleCloudHealthcareV1beta1AnnotationGcsSource"
8925
- }
8926
- },
8927
- "type": "object"
8928
- },
8929
- "ImportAnnotationsResponse": {
8930
- "description": "Final response of importing Annotations in successful case. This structure is included in the response. It is only included when the operation finishes.",
8931
- "id": "ImportAnnotationsResponse",
8932
- "properties": {},
8933
- "type": "object"
8934
- },
8935
8187
  "ImportDicomDataRequest": {
8936
8188
  "description": "Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.",
8937
8189
  "id": "ImportDicomDataRequest",
@@ -9033,23 +8285,6 @@
9033
8285
  },
9034
8286
  "type": "object"
9035
8287
  },
9036
- "InfoTypeConfig": {
9037
- "description": "Specifies how to use infoTypes for evaluation. For example, a user might only want to evaluate `PERSON`, `LOCATION`, and `AGE`.",
9038
- "id": "InfoTypeConfig",
9039
- "properties": {
9040
- "evaluateList": {
9041
- "$ref": "FilterList"
9042
- },
9043
- "ignoreList": {
9044
- "$ref": "FilterList"
9045
- },
9046
- "strictMatching": {
9047
- "description": "If `TRUE`, infoTypes described by `filter` are used for evaluation. Otherwise, infoTypes are not considered for evaluation. For example: * Annotated text: \"Toronto is a location\" * Finding 1: `{\"infoType\": \"PERSON\", \"quote\": \"Toronto\", \"start\": 0, \"end\": 7}` * Finding 2: `{\"infoType\": \"CITY\", \"quote\": \"Toronto\", \"start\": 0, \"end\": 7}` * Finding 3: `{}` * Ground truth: `{\"infoType\": \"LOCATION\", \"quote\": \"Toronto\", \"start\": 0, \"end\": 7}` When `strict_matching` is `TRUE`: * Finding 1: 1 false positive * Finding 2: 1 false positive * Finding 3: 1 false negative When `strict_matching` is `FALSE`: * Finding 1: 1 true positive * Finding 2: 1 true positive * Finding 3: 1 false negative",
9048
- "type": "boolean"
9049
- }
9050
- },
9051
- "type": "object"
9052
- },
9053
8288
  "InfoTypeTransformation": {
9054
8289
  "description": "A transformation to apply to text that is identified as a specific info_type.",
9055
8290
  "id": "InfoTypeTransformation",
@@ -9156,42 +8391,6 @@
9156
8391
  },
9157
8392
  "type": "object"
9158
8393
  },
9159
- "ListAnnotationStoresResponse": {
9160
- "description": "Lists the Annotation stores in the given dataset.",
9161
- "id": "ListAnnotationStoresResponse",
9162
- "properties": {
9163
- "annotationStores": {
9164
- "description": "The returned Annotation stores. Won't be more Annotation stores than the value of page_size in the request.",
9165
- "items": {
9166
- "$ref": "AnnotationStore"
9167
- },
9168
- "type": "array"
9169
- },
9170
- "nextPageToken": {
9171
- "description": "Token to retrieve the next page of results or empty if there are no more results in the list.",
9172
- "type": "string"
9173
- }
9174
- },
9175
- "type": "object"
9176
- },
9177
- "ListAnnotationsResponse": {
9178
- "description": "Lists the Annotations in the specified Annotation store.",
9179
- "id": "ListAnnotationsResponse",
9180
- "properties": {
9181
- "annotations": {
9182
- "description": "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.",
9183
- "items": {
9184
- "$ref": "Annotation"
9185
- },
9186
- "type": "array"
9187
- },
9188
- "nextPageToken": {
9189
- "description": "Token to retrieve the next page of results or empty if there are no more results in the list.",
9190
- "type": "string"
9191
- }
9192
- },
9193
- "type": "object"
9194
- },
9195
8394
  "ListAttributeDefinitionsResponse": {
9196
8395
  "id": "ListAttributeDefinitionsResponse",
9197
8396
  "properties": {
@@ -9868,17 +9067,6 @@
9868
9067
  "properties": {},
9869
9068
  "type": "object"
9870
9069
  },
9871
- "ResourceAnnotation": {
9872
- "description": "Resource level annotation.",
9873
- "id": "ResourceAnnotation",
9874
- "properties": {
9875
- "label": {
9876
- "description": "A description of the annotation record.",
9877
- "type": "string"
9878
- }
9879
- },
9880
- "type": "object"
9881
- },
9882
9070
  "Resources": {
9883
9071
  "description": "A list of FHIR resources.",
9884
9072
  "id": "Resources",
@@ -10278,7 +9466,7 @@
10278
9466
  "id": "SearchResourcesRequest",
10279
9467
  "properties": {
10280
9468
  "resourceType": {
10281
- "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).",
9469
+ "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).",
10282
9470
  "type": "string"
10283
9471
  }
10284
9472
  },
@@ -10306,20 +9494,6 @@
10306
9494
  },
10307
9495
  "type": "object"
10308
9496
  },
10309
- "SensitiveTextAnnotation": {
10310
- "description": "A TextAnnotation specifies a text range that includes sensitive information.",
10311
- "id": "SensitiveTextAnnotation",
10312
- "properties": {
10313
- "details": {
10314
- "additionalProperties": {
10315
- "$ref": "Detail"
10316
- },
10317
- "description": "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}",
10318
- "type": "object"
10319
- }
10320
- },
10321
- "type": "object"
10322
- },
10323
9497
  "SeriesMetrics": {
10324
9498
  "description": "SeriesMetrics contains metrics describing a DICOM series.",
10325
9499
  "id": "SeriesMetrics",
@@ -10466,7 +9640,7 @@
10466
9640
  },
10467
9641
  "deidentifiedStoreDestination": {
10468
9642
  "$ref": "DeidentifiedStoreDestination",
10469
- "description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))."
9643
+ "description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Not supported for R5 stores."
10470
9644
  },
10471
9645
  "resourceTypes": {
10472
9646
  "description": "Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.",
@@ -10782,23 +9956,6 @@
10782
9956
  }
10783
9957
  },
10784
9958
  "type": "object"
10785
- },
10786
- "Vertex": {
10787
- "description": "A 2D coordinate in an image. The origin is the top-left.",
10788
- "id": "Vertex",
10789
- "properties": {
10790
- "x": {
10791
- "description": "X coordinate.",
10792
- "format": "float",
10793
- "type": "number"
10794
- },
10795
- "y": {
10796
- "description": "Y coordinate.",
10797
- "format": "float",
10798
- "type": "number"
10799
- }
10800
- },
10801
- "type": "object"
10802
9959
  }
10803
9960
  },
10804
9961
  "servicePath": "",