$translate

Concept Translation

draftFHIR Core package4.3.0operation13 inputs3 outputs

Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server.

One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated.

The operation returns a set of parameters including a 'result' for whether there is an acceptable match, and a list of possible matches. Note that the list of matches may include notes of codes for which mapping is specifically excluded, so implementers have to check the match.equivalence for each match

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/OperationDefinition/ConceptMap-translate
Code
$translate
Kind
operation
Affects State
No
Publisher
HL7 (FHIR Project)

Invocation Context

Can be invoked at:
Type LevelInstance Level
Target Resources:
ConceptMap
Affects State:No

Input Parameters (13)

NameTypeCard.Description
urluri0..1A canonical URL for a concept map. The server must know the concept map (e.g. it is defined explicitly in the server's concept maps, or it is defined implicitly by some code system known to the server.
conceptMapConceptMap0..1The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion.
conceptMapVersionstring0..1The identifier that is used to identify a specific version of the concept map to be used for the translation. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.
codecode0..1The code that is to be translated. If a code is provided, a system must be provided
systemuri0..1The system for the code that is to be translated
versionstring0..1The version of the system, if one was provided in the source data
sourceuri0..1Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. The source value set is an optional parameter because in some cases, the client cannot know what the source value set is. However, without a source value set, the server may be unable to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note that servers may be able to identify an appropriate concept map without a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention
codingCoding0..1A coding to translate
codeableConceptCodeableConcept0..1A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses
targeturi0..1Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If there's no target specified, the server should return all known translations, along with their source
targetsystemuri0..1identifies a target code system in which a mapping is sought. This parameter is an alternative to the target parameter - only one is required. Searching for any translation to a target code system irrespective of the context (e.g. target valueset) may lead to unsafe results, and it is at the discretion of the server to decide when to support this operation
dependencyany0..*Another element that may help produce the correct mapping
reverseboolean0..1if this is true, then the operation should return all the codes that might be mapped to this code. This parameter reverses the meaning of the source and target parameters

Output Parameters (3)

NameTypeCard.Description
resultboolean1..1True if the concept could be translated successfully. The value can only be true if at least one returned match has an equivalence which is not unmatched or disjoint
messagestring0..1Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail)
matchany0..*A concept in the target value set with an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match

Additional Information

Version
4.3.0
Date
2022-05-28T12:47:40+10:00