Method: fhir.ConceptMap-search-translate

Full name: projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate

Translates a code from one value set to another by searching for appropriate concept maps.

Implements the FHIR standard $translate operation (DSTU2, STU3, R4).

On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/ConceptMap/$translate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The name for the FHIR store containing the concept map(s) to use for the translation.

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

  • healthcare.fhirResources.translateConceptMap

Query parameters

Parameters
url

string

The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps.

code

string

The code to translate.

system

string

The system for the code to be translated.

source

string

The source value set of the concept map to be used. If unset, target is used to search for concept maps.

target

string

The target value set of the concept map to be used. If unset, source is used to search for concept maps.

conceptMapVersion

string

The version of the concept map to use. If unset, the most current version is used.

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.