Operation-decisionsupportservicemodule-evaluate.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="DecisionSupportServiceModule-evaluate"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Evaluate</h2>
      <p>OPERATION: Evaluate</p>
      <div>
        <p>The evaluate operation requests clinical decision support guidance based on a specific
           decision support module</p>

      </div>
      <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>requestId</td>
          <td>0..1</td>
          <td>code</td>
          <td/>
          <td>
            <div>
              <p>An optional client-provided identifier to track the request</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>evaluateAtDateTime</td>
          <td>0..1</td>
          <td>datetime</td>
          <td/>
          <td>
            <div>
              <p>An optional date and time specifying that the evaluation should be performed as thought
                 it was the given date and time. The most direct implication of this is that references
                 to &quot;Now&quot; within the evaluation logic of the module should result in this value.
                 In addition, wherever possible, the data accessed by the module should appear as though
                 it was accessed at this time. The evaluateAtDateTime value may be any time in the past
                 or future, enabling both retrospective and prospective scenarios. If no value is provided,
                 the date and time of the request is assumed</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>inputParameters</td>
          <td>0..1</td>
          <td>Parameters</td>
          <td/>
          <td>
            <div>
              <p>The input parameters for a request, if any. These parameters are defined by the module
                 that is the target of the evaluation, and supply the input information to the module.</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>setting</td>
          <td>0..1</td>
          <td>CodeableConcept</td>
          <td/>
          <td>
            <div>
              <p>The current setting of the request (inpatient, outpatient, etc)</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>settingContext</td>
          <td>0..1</td>
          <td>CodeableConcept</td>
          <td/>
          <td>
            <div>
              <p>Additional detail about the setting of the request, if any</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>return</td>
          <td>1..1</td>
          <td>GuidanceResponse</td>
          <td/>
          <td>
            <div>
              <p>The result of the request as a GuidanceResponse resource. Output parameters, if any, will
                 be contained in the parameters element of the response</p>

            </div>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/DecisionSupportServiceModule-evaluate"/>
  <name value="Evaluate"/>
  <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-12-11T17:38:40+11:00"/>
  <description value="The evaluate operation requests clinical decision support guidance based on a specific
   decision support module"/>
  <code value="evaluate"/>
  <system value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="requestId"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="An optional client-provided identifier to track the request"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="evaluateAtDateTime"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="An optional date and time specifying that the evaluation should be performed as thought
     it was the given date and time. The most direct implication of this is that references
     to &quot;Now&quot; within the evaluation logic of the module should result in this value.
     In addition, wherever possible, the data accessed by the module should appear as though
     it was accessed at this time. The evaluateAtDateTime value may be any time in the past
     or future, enabling both retrospective and prospective scenarios. If no value is provided,
     the date and time of the request is assumed"/>
    <type value="datetime"/>
  </parameter>
  <parameter>
    <name value="inputParameters"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The input parameters for a request, if any. These parameters are defined by the module
     that is the target of the evaluation, and supply the input information to the module."/>
    <type value="Parameters"/>
  </parameter>
  <parameter>
    <name value="setting"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The current setting of the request (inpatient, outpatient, etc)"/>
    <type value="CodeableConcept"/>
  </parameter>
  <parameter>
    <name value="settingContext"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Additional detail about the setting of the request, if any"/>
    <type value="CodeableConcept"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The result of the request as a GuidanceResponse resource. Output parameters, if any, will
     be contained in the parameters element of the response"/>
    <type value="GuidanceResponse"/>
  </parameter>
</OperationDefinition>