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."],[[["\u003cp\u003eThis API endpoint, \u003ccode\u003eprojects.locations.datasets.fhirStores.fhir.Patient-consent-enforcement-status\u003c/code\u003e, retrieves the consent enforcement status for all consent resources linked to a specific patient.\u003c/p\u003e\n"],["\u003cp\u003eThe response, upon success, is a JSON-encoded bundle of FHIR \u003ccode\u003eParameters\u003c/code\u003e resources, each indicating the current enforcement status of a patient's consent resource and this endpoint does not support DSTU2.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e parameter, which specifies the patient's identifier, is required and formatted as \u003ccode\u003eprojects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Patient/{patientId}\u003c/code\u003e, requiring \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permissions.\u003c/p\u003e\n"],["\u003cp\u003ePagination is supported using the optional query parameters \u003ccode\u003e_count\u003c/code\u003e to limit results per page (up to 1000) and \u003ccode\u003e_page_token\u003c/code\u003e to navigate through the pages.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,[]]
