Method: fhir.capabilities

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.

Implements the FHIR standard capabilities interaction (STU3, R4, R5), or the conformance interaction in the DSTU2 case.

On success, the response body contains a JSON-encoded representation of a CapabilityStatement resource.

HTTP request

GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/metadata

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the FHIR store to retrieve the capabilities for.

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

  • healthcare.fhirStores.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.