This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
This is the narrative for the resource. See also the XML or JSON format.
OPERATION: Concept Translation
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 outcome is an operationOutcome with hints, warnings, or errors, or the translated code in an extension
URL: [base]/ConceptMap/$Concept Translation
URL: [base]/ConceptMap/[id]/$Concept Translation
Parameters
Use | Name | Cardinality | Type | Documentation |
IN | code | 0..1 | code | The code that is to be translated. If a code is provided, a system must be provided |
IN | system | 0..1 | uri | The system for the code that is to be translated |
IN | version | 0..1 | string | The version of the system, if one was provided in the source data |
IN | valueSet | 0..1 | uri | Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location |
IN | coding | 0..1 | Coding | A coding to translate |
IN | codeableConcept | 0..1 | CodeableConcept | A full codeableConcept to validate. The server can translate any of the coding values as it chooses |
IN | target | 1..1 | uri | Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location |
OUT | result | 1..1 | boolean | True if the concept could be translated |
OUT | message | 0..1 | string | Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings |
OUT | equivalence | 0..1 | code | A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{concept-equivalence.html} |
OUT | outcome | 0..1 | Coding | The translation outcome |
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.