Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.fhir.Patient-consent-enforcement-status
Returns the consent enforcement status of all consent resources for a patient.
On success, the response body contains a JSON-encoded representation of a bundle of Parameters (http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2.
HTTP request
GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$consent-enforcement-status
Required. The name of the patient to find enforcement statuses, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Patient/{patientId}
Authorization requires the following IAM permission on the specified resource name:
healthcare.fhirResources.get
Query parameters
Parameters
_count
integer
Optional. The maximum number of results on a page. If not specified, 100 is used. May not be larger than 1000.
_page_token
string
Optional. Used to retrieve the first, previous, next, or last page of consent enforcement statuses when using pagination. Value should be set to the value of _page_token set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where link.relation is "previous" or "next".
Omit _page_token if no previous request has been made.
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-06-27 UTC."],[[["This API endpoint, `projects.locations.datasets.fhirStores.fhir.Patient-consent-enforcement-status`, retrieves the consent enforcement status for all consent resources linked to a specific patient."],["The response, upon success, is a JSON-encoded bundle of FHIR `Parameters` resources, each indicating the current enforcement status of a patient's consent resource and this endpoint does not support DSTU2."],["The `name` parameter, which specifies the patient's identifier, is required and formatted as `projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Patient/{patientId}`, requiring `healthcare.fhirResources.get` IAM permissions."],["Pagination is supported using the optional query parameters `_count` to limit results per page (up to 1000) and `_page_token` to navigate through the pages."],["The API requires either the `https://www.googleapis.com/auth/cloud-healthcare` or `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
