Operation-conceptmap-translate.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ConceptMap-translate"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/ConceptMap-translate"/>
  <name value="Concept Translation"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="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"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <kind value="operation"/>
  <code value="translate"/>
  <system value="false"/>
  <type value="ConceptMap"/>
  <instance value="true"/>
  <parameter>
    <name value="code"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The code that is to be translated. If a code is provided, a system must be provided"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="system"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The system for the code that is to be translated"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The version of the system, if one was provided in the source data"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="valueSet"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Identifies the value set used when the concept (system/code pair) was chosen. May be a
     logical id, or an absolute or relative location"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="coding"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A coding to translate"/>
    <type value="Coding"/>
  </parameter>
  <parameter>
    <name value="codeableConcept"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A full codeableConcept to validate. The server can translate any of the coding values
     as it chooses"/>
    <type value="CodeableConcept"/>
  </parameter>
  <parameter>
    <name value="target"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Identifies the value set in which a translation is sought. May be a logical id, or an
     absolute or relative location"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="result"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="True if the concept could be translated"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="message"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Error details, if result = false. If this is provided when result = true, the message
     carries hints and wanrings"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="equivalence"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{conc
    ept-equivalence.html}"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="outcome"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The translation outcome"/>
    <type value="Coding"/>
  </parameter>
</OperationDefinition>