Operation-valueset-lookup.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ValueSet-lookup"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/ValueSet-lookup"/>
  <name value="Concept Look Up"/>
  <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="Given a code/system, or a Coding, get additional details about the concept"/>
  <status value="draft"/>
  <date value="2015-04-03T14:24:32+11:00"/>
  <kind value="operation"/>
  <code value="lookup"/>
  <system value="false"/>
  <type value="ValueSet"/>
  <instance value="false"/>
  <parameter>
    <name value="code"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The code that is to be validated. 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 validated"/>
    <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="coding"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A coding to look up"/>
    <type value="Coding"/>
  </parameter>
  <parameter>
    <name value="date"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The date for which the information should be returned. Normally, this is the current conditions
     (which is the default value) but under some circumstances, systems need to acccess this
     information as it would have been in the past. A typical example of this would be where
     code selection is constrained to the set of codes that were available when the patient
     was treated, not when the record is being edited. Note that which date is appropriate
     is a matter for implementation policy."/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="name"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="A display name for the code system"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="version"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The version that these details are based on"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="display"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The preferred display for this concept"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="abstract"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Whether this code is an abstract concept"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="designation"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Additional representations for this concept"/>
    <part>
      <name value="language"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The language this designation is defined for"/>
      <type value="code"/>
    </part>
    <part>
      <name value="use"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="A code that details how this designation would be used"/>
      <type value="Coding"/>
    </part>
    <part>
      <name value="value"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The text value for this designation"/>
      <type value="string"/>
    </part>
  </parameter>
</OperationDefinition>