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.
- {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/METADATA +14 -2
- {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/RECORD +176 -175
- {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info}/WHEEL +1 -1
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +3 -3
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +3 -3
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +693 -17
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1278 -21
- googleapiclient/discovery_cache/documents/alloydb.v1.json +5 -5
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +20 -5
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +20 -5
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +296 -8
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +30 -20
- googleapiclient/discovery_cache/documents/apigee.v1.json +4 -4
- googleapiclient/discovery_cache/documents/apihub.v1.json +7 -7
- googleapiclient/discovery_cache/documents/apim.v1alpha.json +8 -2
- googleapiclient/discovery_cache/documents/areainsights.v1.json +2 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +117 -9
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +117 -9
- googleapiclient/discovery_cache/documents/backupdr.v1.json +3 -3
- googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +3 -3
- googleapiclient/discovery_cache/documents/batch.v1.json +13 -1
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +114 -3
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +92 -1
- googleapiclient/discovery_cache/documents/blogger.v2.json +3 -1
- googleapiclient/discovery_cache/documents/blogger.v3.json +3 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +6 -9
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +51 -5
- googleapiclient/discovery_cache/documents/classroom.v1.json +48 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +8 -4
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +321 -10
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +149 -3
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +10 -5
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +10 -5
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +6 -6
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +6 -6
- googleapiclient/discovery_cache/documents/cloudtrace.v1.json +2 -2
- googleapiclient/discovery_cache/documents/composer.v1.json +35 -1
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/compute.alpha.json +3280 -1209
- googleapiclient/discovery_cache/documents/compute.beta.json +858 -193
- googleapiclient/discovery_cache/documents/compute.v1.json +627 -5
- googleapiclient/discovery_cache/documents/config.v1.json +4 -4
- googleapiclient/discovery_cache/documents/connectors.v1.json +11 -66
- googleapiclient/discovery_cache/documents/connectors.v2.json +7 -1
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +1429 -306
- googleapiclient/discovery_cache/documents/container.v1.json +53 -1
- googleapiclient/discovery_cache/documents/container.v1beta1.json +53 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +24 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +27 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +24 -2
- googleapiclient/discovery_cache/documents/content.v2.1.json +5 -1
- googleapiclient/discovery_cache/documents/css.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +108 -1
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +18 -2
- googleapiclient/discovery_cache/documents/dataplex.v1.json +153 -58
- googleapiclient/discovery_cache/documents/dataportability.v1.json +10 -1
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +10 -1
- googleapiclient/discovery_cache/documents/dataproc.v1.json +96 -300
- googleapiclient/discovery_cache/documents/datastream.v1.json +44 -2
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +426 -1
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +8 -3
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +3 -3
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +3 -3
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +287 -3
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +3 -3
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +329 -32
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +396 -28
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +329 -32
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +3 -3
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +3 -3
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +3 -3
- googleapiclient/discovery_cache/documents/dlp.v2.json +33 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +9 -11
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +9 -11
- googleapiclient/discovery_cache/documents/driveactivity.v2.json +2 -2
- googleapiclient/discovery_cache/documents/drivelabels.v2.json +96 -1
- googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +96 -1
- googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +3 -2
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +51 -1
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +51 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +372 -8
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +41 -3
- googleapiclient/discovery_cache/documents/gkehub.v1.json +1 -3
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +1 -5
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +1 -3
- googleapiclient/discovery_cache/documents/gkehub.v2.json +1 -3
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +1 -3
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +1 -3
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +24 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +36 -34
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +46 -889
- googleapiclient/discovery_cache/documents/iam.v1.json +7 -7
- googleapiclient/discovery_cache/documents/iap.v1.json +12 -5
- googleapiclient/discovery_cache/documents/integrations.v1.json +67 -1
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +10 -6
- googleapiclient/discovery_cache/documents/language.v1.json +13 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +13 -1
- googleapiclient/discovery_cache/documents/language.v2.json +13 -1
- googleapiclient/discovery_cache/documents/logging.v2.json +15 -13
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +51 -1
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +893 -63
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +250 -1
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +42 -42
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +4 -54
- googleapiclient/discovery_cache/documents/monitoring.v1.json +51 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +2 -2
- googleapiclient/discovery_cache/documents/netapp.v1.json +26 -14
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +101 -20
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +20 -15
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +40 -11
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +289 -5
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +20 -4
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +564 -4
- googleapiclient/discovery_cache/documents/networkservices.v1.json +2 -2
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +6 -2
- googleapiclient/discovery_cache/documents/notebooks.v2.json +3 -3
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +23 -1
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +23 -1
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +2 -2
- googleapiclient/discovery_cache/documents/oslogin.v1.json +4 -4
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +9 -9
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +6 -6
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +7 -5
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +110 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +570 -1
- googleapiclient/discovery_cache/documents/privateca.v1.json +65 -1
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +9 -2
- googleapiclient/discovery_cache/documents/redis.v1.json +5 -4
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +5 -4
- googleapiclient/discovery_cache/documents/retail.v2.json +23 -1
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +59 -4
- googleapiclient/discovery_cache/documents/retail.v2beta.json +23 -1
- googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +3294 -0
- googleapiclient/discovery_cache/documents/safebrowsing.v5.json +393 -1
- googleapiclient/discovery_cache/documents/script.v1.json +1 -107
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +337 -11
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +337 -11
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +337 -11
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +100 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +112 -1
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +104 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +114 -15
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +105 -6
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +100 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +100 -1
- googleapiclient/discovery_cache/documents/sheets.v4.json +7 -2
- googleapiclient/discovery_cache/documents/spanner.v1.json +57 -17
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +37 -3
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +37 -3
- googleapiclient/discovery_cache/documents/storage.v1.json +20 -2
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +5 -5
- googleapiclient/discovery_cache/documents/sts.v1.json +2 -2
- googleapiclient/discovery_cache/documents/sts.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/tasks.v1.json +2 -2
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +5 -5
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +82 -5
- googleapiclient/discovery_cache/documents/vault.v1.json +18 -1
- googleapiclient/discovery_cache/documents/versionhistory.v1.json +2 -2
- googleapiclient/discovery_cache/documents/videointelligence.v1.json +156 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +156 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +156 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +156 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +156 -1
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +70 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +70 -3
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +335 -139
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.170.0.dist-info → google_api_python_client-2.172.0.dist-info/licenses}/LICENSE +0 -0
- {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,
|
|
@@ -2959,7 +2959,7 @@
|
|
|
2959
2959
|
"fhirStores": {
|
|
2960
2960
|
"methods": {
|
|
2961
2961
|
"applyAdminConsents": {
|
|
2962
|
-
"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.",
|
|
2962
|
+
"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.",
|
|
2963
2963
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyAdminConsents",
|
|
2964
2964
|
"httpMethod": "POST",
|
|
2965
2965
|
"id": "healthcare.projects.locations.datasets.fhirStores.applyAdminConsents",
|
|
@@ -2988,7 +2988,7 @@
|
|
|
2988
2988
|
]
|
|
2989
2989
|
},
|
|
2990
2990
|
"applyConsents": {
|
|
2991
|
-
"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.",
|
|
2991
|
+
"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.",
|
|
2992
2992
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyConsents",
|
|
2993
2993
|
"httpMethod": "POST",
|
|
2994
2994
|
"id": "healthcare.projects.locations.datasets.fhirStores.applyConsents",
|
|
@@ -3106,7 +3106,7 @@
|
|
|
3106
3106
|
],
|
|
3107
3107
|
"parameters": {
|
|
3108
3108
|
"sourceStore": {
|
|
3109
|
-
"description": "Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.",
|
|
3109
|
+
"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.",
|
|
3110
3110
|
"location": "path",
|
|
3111
3111
|
"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$",
|
|
3112
3112
|
"required": true,
|
|
@@ -3152,7 +3152,7 @@
|
|
|
3152
3152
|
]
|
|
3153
3153
|
},
|
|
3154
3154
|
"explainDataAccess": {
|
|
3155
|
-
"description": "Explains all the permitted/denied actor, purpose and environment for a given resource.",
|
|
3155
|
+
"description": "Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not supported in DSTU2 or R5.",
|
|
3156
3156
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:explainDataAccess",
|
|
3157
3157
|
"httpMethod": "GET",
|
|
3158
3158
|
"id": "healthcare.projects.locations.datasets.fhirStores.explainDataAccess",
|
|
@@ -3493,7 +3493,7 @@
|
|
|
3493
3493
|
"fhir": {
|
|
3494
3494
|
"methods": {
|
|
3495
3495
|
"Binary-create": {
|
|
3496
|
-
"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.",
|
|
3496
|
+
"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.",
|
|
3497
3497
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary",
|
|
3498
3498
|
"httpMethod": "POST",
|
|
3499
3499
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create",
|
|
@@ -3548,7 +3548,7 @@
|
|
|
3548
3548
|
]
|
|
3549
3549
|
},
|
|
3550
3550
|
"Binary-update": {
|
|
3551
|
-
"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.",
|
|
3551
|
+
"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.",
|
|
3552
3552
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}",
|
|
3553
3553
|
"httpMethod": "PUT",
|
|
3554
3554
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update",
|
|
@@ -3666,7 +3666,7 @@
|
|
|
3666
3666
|
]
|
|
3667
3667
|
},
|
|
3668
3668
|
"Patient-everything": {
|
|
3669
|
-
"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](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://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).",
|
|
3669
|
+
"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](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://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).",
|
|
3670
3670
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything",
|
|
3671
3671
|
"httpMethod": "GET",
|
|
3672
3672
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything",
|
|
@@ -3749,7 +3749,7 @@
|
|
|
3749
3749
|
]
|
|
3750
3750
|
},
|
|
3751
3751
|
"Resource-validate": {
|
|
3752
|
-
"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),
|
|
3752
|
+
"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.",
|
|
3753
3753
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate",
|
|
3754
3754
|
"httpMethod": "POST",
|
|
3755
3755
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate",
|
|
@@ -3771,7 +3771,7 @@
|
|
|
3771
3771
|
"type": "string"
|
|
3772
3772
|
},
|
|
3773
3773
|
"type": {
|
|
3774
|
-
"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),
|
|
3774
|
+
"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.",
|
|
3775
3775
|
"location": "path",
|
|
3776
3776
|
"pattern": "^[^/]+$",
|
|
3777
3777
|
"required": true,
|
|
@@ -3832,7 +3832,7 @@
|
|
|
3832
3832
|
]
|
|
3833
3833
|
},
|
|
3834
3834
|
"capabilities": {
|
|
3835
|
-
"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.",
|
|
3835
|
+
"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.",
|
|
3836
3836
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata",
|
|
3837
3837
|
"httpMethod": "GET",
|
|
3838
3838
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities",
|
|
@@ -3875,7 +3875,7 @@
|
|
|
3875
3875
|
"type": "string"
|
|
3876
3876
|
},
|
|
3877
3877
|
"type": {
|
|
3878
|
-
"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)).",
|
|
3878
|
+
"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)).",
|
|
3879
3879
|
"location": "path",
|
|
3880
3880
|
"pattern": "^[^/]+$",
|
|
3881
3881
|
"required": true,
|
|
@@ -3909,7 +3909,7 @@
|
|
|
3909
3909
|
"type": "string"
|
|
3910
3910
|
},
|
|
3911
3911
|
"type": {
|
|
3912
|
-
"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)).",
|
|
3912
|
+
"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)).",
|
|
3913
3913
|
"location": "path",
|
|
3914
3914
|
"pattern": "^[^/]+$",
|
|
3915
3915
|
"required": true,
|
|
@@ -3946,7 +3946,7 @@
|
|
|
3946
3946
|
"type": "string"
|
|
3947
3947
|
},
|
|
3948
3948
|
"type": {
|
|
3949
|
-
"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.",
|
|
3949
|
+
"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.",
|
|
3950
3950
|
"location": "path",
|
|
3951
3951
|
"pattern": "^[^/]+$",
|
|
3952
3952
|
"required": true,
|
|
@@ -3966,7 +3966,7 @@
|
|
|
3966
3966
|
]
|
|
3967
3967
|
},
|
|
3968
3968
|
"create": {
|
|
3969
|
-
"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, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. 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).",
|
|
3969
|
+
"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, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. 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).",
|
|
3970
3970
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
|
|
3971
3971
|
"httpMethod": "POST",
|
|
3972
3972
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.create",
|
|
@@ -3983,7 +3983,7 @@
|
|
|
3983
3983
|
"type": "string"
|
|
3984
3984
|
},
|
|
3985
3985
|
"type": {
|
|
3986
|
-
"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.",
|
|
3986
|
+
"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.",
|
|
3987
3987
|
"location": "path",
|
|
3988
3988
|
"pattern": "^[^/]+$",
|
|
3989
3989
|
"required": true,
|
|
@@ -4003,7 +4003,7 @@
|
|
|
4003
4003
|
]
|
|
4004
4004
|
},
|
|
4005
4005
|
"delete": {
|
|
4006
|
-
"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 will be 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).",
|
|
4006
|
+
"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 will be 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).",
|
|
4007
4007
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
|
|
4008
4008
|
"httpMethod": "DELETE",
|
|
4009
4009
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.delete",
|
|
@@ -4029,7 +4029,7 @@
|
|
|
4029
4029
|
]
|
|
4030
4030
|
},
|
|
4031
4031
|
"executeBundle": {
|
|
4032
|
-
"description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([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` and `transaction`, processing them 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 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. 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).",
|
|
4032
|
+
"description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([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` and `transaction`, processing them 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 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. 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).",
|
|
4033
4033
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir",
|
|
4034
4034
|
"httpMethod": "POST",
|
|
4035
4035
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle",
|
|
@@ -4058,7 +4058,7 @@
|
|
|
4058
4058
|
]
|
|
4059
4059
|
},
|
|
4060
4060
|
"history": {
|
|
4061
|
-
"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).",
|
|
4061
|
+
"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).",
|
|
4062
4062
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history",
|
|
4063
4063
|
"httpMethod": "GET",
|
|
4064
4064
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.history",
|
|
@@ -4105,7 +4105,7 @@
|
|
|
4105
4105
|
]
|
|
4106
4106
|
},
|
|
4107
4107
|
"patch": {
|
|
4108
|
-
"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).",
|
|
4108
|
+
"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).",
|
|
4109
4109
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
|
|
4110
4110
|
"httpMethod": "PATCH",
|
|
4111
4111
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.patch",
|
|
@@ -4134,7 +4134,7 @@
|
|
|
4134
4134
|
]
|
|
4135
4135
|
},
|
|
4136
4136
|
"read": {
|
|
4137
|
-
"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).",
|
|
4137
|
+
"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).",
|
|
4138
4138
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
|
|
4139
4139
|
"httpMethod": "GET",
|
|
4140
4140
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.read",
|
|
@@ -4160,7 +4160,7 @@
|
|
|
4160
4160
|
]
|
|
4161
4161
|
},
|
|
4162
4162
|
"search": {
|
|
4163
|
-
"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).",
|
|
4163
|
+
"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).",
|
|
4164
4164
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search",
|
|
4165
4165
|
"httpMethod": "POST",
|
|
4166
4166
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.search",
|
|
@@ -4189,7 +4189,7 @@
|
|
|
4189
4189
|
]
|
|
4190
4190
|
},
|
|
4191
4191
|
"search-type": {
|
|
4192
|
-
"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).",
|
|
4192
|
+
"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).",
|
|
4193
4193
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search",
|
|
4194
4194
|
"httpMethod": "POST",
|
|
4195
4195
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type",
|
|
@@ -4206,7 +4206,7 @@
|
|
|
4206
4206
|
"type": "string"
|
|
4207
4207
|
},
|
|
4208
4208
|
"resourceType": {
|
|
4209
|
-
"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)).",
|
|
4209
|
+
"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)).",
|
|
4210
4210
|
"location": "path",
|
|
4211
4211
|
"required": true,
|
|
4212
4212
|
"type": "string"
|
|
@@ -4225,7 +4225,7 @@
|
|
|
4225
4225
|
]
|
|
4226
4226
|
},
|
|
4227
4227
|
"update": {
|
|
4228
|
-
"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).",
|
|
4228
|
+
"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).",
|
|
4229
4229
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}",
|
|
4230
4230
|
"httpMethod": "PUT",
|
|
4231
4231
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.update",
|
|
@@ -4254,7 +4254,7 @@
|
|
|
4254
4254
|
]
|
|
4255
4255
|
},
|
|
4256
4256
|
"vread": {
|
|
4257
|
-
"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).",
|
|
4257
|
+
"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).",
|
|
4258
4258
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history/{_historyId}",
|
|
4259
4259
|
"httpMethod": "GET",
|
|
4260
4260
|
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.vread",
|
|
@@ -5094,7 +5094,7 @@
|
|
|
5094
5094
|
}
|
|
5095
5095
|
}
|
|
5096
5096
|
},
|
|
5097
|
-
"revision": "
|
|
5097
|
+
"revision": "20250526",
|
|
5098
5098
|
"rootUrl": "https://healthcare.googleapis.com/",
|
|
5099
5099
|
"schemas": {
|
|
5100
5100
|
"AccessDeterminationLogConfig": {
|
|
@@ -6673,7 +6673,7 @@
|
|
|
6673
6673
|
"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."
|
|
6674
6674
|
},
|
|
6675
6675
|
"complexDataTypeReferenceParsing": {
|
|
6676
|
-
"description": "Optional. 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.",
|
|
6676
|
+
"description": "Optional. 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.",
|
|
6677
6677
|
"enum": [
|
|
6678
6678
|
"COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED",
|
|
6679
6679
|
"DISABLED",
|
|
@@ -6688,7 +6688,7 @@
|
|
|
6688
6688
|
},
|
|
6689
6689
|
"consentConfig": {
|
|
6690
6690
|
"$ref": "ConsentConfig",
|
|
6691
|
-
"description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources."
|
|
6691
|
+
"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."
|
|
6692
6692
|
},
|
|
6693
6693
|
"defaultSearchHandlingStrict": {
|
|
6694
6694
|
"description": "Optional. 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.",
|
|
@@ -6720,7 +6720,7 @@
|
|
|
6720
6720
|
"notificationConfig": {
|
|
6721
6721
|
"$ref": "NotificationConfig",
|
|
6722
6722
|
"deprecated": true,
|
|
6723
|
-
"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\"."
|
|
6723
|
+
"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."
|
|
6724
6724
|
},
|
|
6725
6725
|
"notificationConfigs": {
|
|
6726
6726
|
"description": "Optional. Specifies where and whether to send notifications upon changes to a FHIR store.",
|
|
@@ -6746,13 +6746,15 @@
|
|
|
6746
6746
|
"VERSION_UNSPECIFIED",
|
|
6747
6747
|
"DSTU2",
|
|
6748
6748
|
"STU3",
|
|
6749
|
-
"R4"
|
|
6749
|
+
"R4",
|
|
6750
|
+
"R5"
|
|
6750
6751
|
],
|
|
6751
6752
|
"enumDescriptions": [
|
|
6752
6753
|
"Users must specify a version on store creation or an error is returned.",
|
|
6753
6754
|
"Draft Standard for Trial Use, [Release 2](https://www.hl7.org/fhir/DSTU2)",
|
|
6754
6755
|
"Standard for Trial Use, [Release 3](https://www.hl7.org/fhir/STU3)",
|
|
6755
|
-
"[Release 4](https://www.hl7.org/fhir/R4)"
|
|
6756
|
+
"[Release 4](https://www.hl7.org/fhir/R4)",
|
|
6757
|
+
"[Release 5](https://www.hl7.org/fhir/R5)"
|
|
6756
6758
|
],
|
|
6757
6759
|
"type": "string"
|
|
6758
6760
|
}
|
|
@@ -8424,7 +8426,7 @@
|
|
|
8424
8426
|
"id": "SearchResourcesRequest",
|
|
8425
8427
|
"properties": {
|
|
8426
8428
|
"resourceType": {
|
|
8427
|
-
"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)).",
|
|
8429
|
+
"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)).",
|
|
8428
8430
|
"type": "string"
|
|
8429
8431
|
}
|
|
8430
8432
|
},
|
|
@@ -8598,7 +8600,7 @@
|
|
|
8598
8600
|
},
|
|
8599
8601
|
"deidentifiedStoreDestination": {
|
|
8600
8602
|
"$ref": "DeidentifiedStoreDestination",
|
|
8601
|
-
"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))."
|
|
8603
|
+
"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."
|
|
8602
8604
|
},
|
|
8603
8605
|
"resourceTypes": {
|
|
8604
8606
|
"description": "Optional. 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.",
|