Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.fhir.capabilities
Gets the FHIR capability statement (STU3, R4, R5), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server.
[[["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 FHIR capability statement or conformance statement for a specified FHIR store, detailing the server's supported functionality.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint uses a GET request to a specific URL structure that includes project, location, dataset, and FHIR store identifiers.\u003c/p\u003e\n"],["\u003cp\u003eTo authorize the request, the user must have the \u003ccode\u003ehealthcare.fhirStores.get\u003c/code\u003e IAM permission and provide an appropriate OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns a JSON-encoded representation of a \u003ccode\u003eCapabilityStatement\u003c/code\u003e resource in the response body.\u003c/p\u003e\n"],["\u003cp\u003eThe request body is required to be empty.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.capabilities\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.capabilities\n\nGets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html), [R5](https://hl7.org/fhir/R5/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server.\n\nImplements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities), [R5](https://hl7.org/fhir/R5/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case.\n\nOn success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/metadata`\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)."]]
