Operation-conceptmap-batch.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ConceptMap-batch"/>
  <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-batch"/>
  <name value="Batch Mode 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 set of concepts 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"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <kind value="operation"/>
  <code value="batch"/>
  <system value="false"/>
  <type value="ConceptMap"/>
  <instance value="false"/>
  <parameter>
    <name value="item"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="An item to be translated"/>
    <part>
      <name value="concept"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="A codeable concept to be translated. If the source is a coding, or a code/system pair,
       wrap it in a CodeableConcept"/>
      <type value="CodeableConcept"/>
    </part>
    <part>
      <name value="target"/>
      <min value="1"/>
      <max value="*"/>
      <documentation value="Identifies the value set in which a translation is sought. May be a logical id, or an
       absolute or relative location. If more than one is provided, multiple translations are
       requested for the concept"/>
      <type value="uri"/>
    </part>
    <part>
      <name value="map"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="A specific concept map to use for the translation. If none is provided, the server chooses
       which concept map to use"/>
      <type value="Reference(ConceptMap)"/>
    </part>
  </parameter>
  <parameter>
    <name value="item"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="The outcome of validating an item. There must be an entry for every item in the same order"/>
    <part>
      <name value="result"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="True if the concept could be translated"/>
      <type value="boolean"/>
    </part>
    <part>
      <name value="message"/>
      <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"/>
    </part>
    <part>
      <name value="equivalence"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{conc
      ept-equivalence.html}. TODO: what about multiple translations?"/>
      <type value="code"/>
    </part>
    <part>
      <name value="outcome"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The translation outcome - a CodeableConcept to allow for multiple translations"/>
      <type value="CodeableConcept"/>
    </part>
  </parameter>
</OperationDefinition>