Stay organized with collections
Save and categorize content based on your preferences.
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/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Consent/*}/$consent-enforcement-status
Required. The name of the consent resource to find enforcement status, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Consent/{consent_id}
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-23 UTC."],[[["\u003cp\u003eThis API endpoint retrieves the consent enforcement status of a specific FHIR Consent resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses a \u003ccode\u003eGET\u003c/code\u003e method with a URL that specifies the consent resource's path, including project, location, dataset, FHIR store, and consent ID.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires the \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permission on the specified consent resource.\u003c/p\u003e\n"],["\u003cp\u003eThe API returns a \u003ccode\u003eParameters\u003c/code\u003e FHIR resource in JSON format that represents the current consent enforcement status.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be empty.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.Consent-enforcement-status\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.Consent-enforcement-status\n\nReturns the consent enforcement status of a single consent resource.\n\nOn success, the response body contains a JSON-encoded representation of a `Parameters` (\u003chttp://hl7.org/fhir/parameters.html\u003e) FHIR resource, containing the current enforcement status. Does not support DSTU2.\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Consent/*}/$consent-enforcement-status`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
