Method: fhir.Consent-enforcement-status

Full name: projects.locations.datasets.fhirStores.fhir.Consent-enforcement-status

Returns the consent enforcement status of a single consent resource.

On success, the response body contains a JSON-encoded representation of a Parameters (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2.

HTTP request

GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Consent/*}/$consent-enforcement-status

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the consent resource to find enforcement status, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Consent/{consentId}

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirResources.get

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.