FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.288  |  FHIR Version 1.0.2  | User: ANONYMOUS (Unknown)  

Resource "ValueSet-lookup" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Concept Look Up

OPERATION: Concept Look Up

Given a code/system, or a Coding, get additional details about the concept

URL: [base]/ValueSet/$lookup

Parameters

Use Name Cardinality Type Binding Documentation
IN code 0..1 code

The code that is to be validated. If a code is provided, a system must be provided

IN system 0..1 uri

The system for the code that is to be validated

IN version 0..1 string

The version of the system, if one was provided in the source data

IN coding 0..1 Coding

A coding to look up

IN date 0..1 dateTime

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.

OUT name 1..1 string

A display name for the code system

OUT version 0..1 string

The version that these details are based on

OUT display 1..1 string

The preferred display for this concept

OUT abstract 0..1 boolean

Whether this code is an abstract concept

OUT designation 0..*

Additional representations for this concept

OUT designation.language 0..1 code

The language this designation is defined for

OUT designation.use 0..1 Coding

A code that details how this designation would be used

OUT designation.value 1..1 string

The text value for this designation

Note that the $lookup operation is more than just a value set search - the server finds the concept, and gathers the return information from the value set and the underlying code system definitions.


<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ValueSet-lookup"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2018-09-06T12:32:37.078Z"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Concept Look Up</h2>
      <p>OPERATION: Concept Look Up</p>
      <div>
        <p>Given a code/system, or a Coding, get additional details about the concept</p> </div>
      <p>URL: [base]/ValueSet/$lookup</p>
      <p>Parameters</p>
      <table class="grid">
        <tr>
          <td>
            <b>Use</b> </td>
          <td>
            <b>Name</b> </td>
          <td>
            <b>Cardinality</b> </td>
          <td>
            <b>Type</b> </td>
          <td>
            <b>Binding</b> </td>
          <td>
            <b>Documentation</b> </td> </tr>
        <tr>
          <td>IN</td>
          <td>code</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The code that is to be validated. If a code is provided, a system must be provided</p> </div> </td> </tr>
        <tr>
          <td>IN</td>
          <td>system</td>
          <td>0..1</td>
          <td>uri</td>
          <td/>
          <td>
            <div>
              <p>The system for the code that is to be validated</p> </div> </td> </tr>
        <tr>
          <td>IN</td>
          <td>version</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The version of the system, if one was provided in the source data</p> </div> </td> </tr>
        <tr>
          <td>IN</td>
          <td>coding</td>
          <td>0..1</td>
          <td>Coding</td>
          <td/>
          <td>
            <div>
              <p>A coding to look up</p> </div> </td> </tr>
        <tr>
          <td>IN</td>
          <td>date</td>
          <td>0..1</td>
          <td>dateTime</td>
          <td/>
          <td>
            <div>
              <p>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.</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>name</td>
          <td>1..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>A display name for the code system</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>version</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The version that these details are based on</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>display</td>
          <td>1..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The preferred display for this concept</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>abstract</td>
          <td>0..1</td>
          <td>boolean</td>
          <td/>
          <td>
            <div>
              <p>Whether this code is an abstract concept</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>designation</td>
          <td>0..*</td>
          <td/>
          <td/>
          <td>
            <div>
              <p>Additional representations for this concept</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>designation.language</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>The language this designation is defined for</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>designation.use</td>
          <td>0..1</td>
          <td>Coding</td>
          <td/>
          <td>
            <div>
              <p>A code that details how this designation would be used</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>designation.value</td>
          <td>1..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The text value for this designation</p> </div> </td> </tr> </table>
      <div>
        <p>Note that the $lookup operation is more than just a value set search - the server finds the concept, and gathers the return information from the value set and the underlying code system definitions.</p> </div> </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/ValueSet-lookup"/>
  <name value="Concept Look Up"/>
  <status value="draft"/>
  <kind value="operation"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <date value="2015-10-24T07:41:03+11:00"/>
  <description value="Given a code/system, or a Coding, get additional details about the concept"/>
  <code value="lookup"/>
  <notes value="Note that the $lookup operation is more than just a value set search - the server finds the concept, and gathers the return information from the value set and the underlying code system definitions."/>
  <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"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The language this designation is defined for"/>
      <type value="code"/>
    </part>
    <part>
      <name value="use"/>
      <use value="out"/>
      <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"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The text value for this designation"/>
      <type value="string"/>
    </part>
  </parameter>
</OperationDefinition>