v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1376177324.7 KB
projects

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.

post/v1/{+name}:applyAdminConsents

Path parameters

namestring required

Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Request body

validateOnlyboolean

Optional. If true, the method only validates Consent resources to make sure they are supported. Otherwise, the method applies the aggregate consent information to update the enforcement model and reindex the FHIR resources. If all Consent resources can be applied successfully, the ApplyAdminConsentsResponse is returned containing the following fields: * consent_apply_success to indicate the number of Consent resources applied. * affected_resources to indicate the number of resources that might have had their consent access changed. If, however, one or more Consent resources are unsupported or cannot be applied, the method fails and ApplyAdminConsentsErrorDetail is is returned with details about the unsupported Consent resources.

Response

Successful response