Operation-servicedefinition-evaluate.xml

Operation Definition

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

      </div> 
      <p> URL: [base]/ServiceDefinition/[id]/$evaluate</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> requestId</td> 
          <td> 0..1</td> 
          <td> id</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 though
                 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 typically supply patient-independent information
                 to the module.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> inputData</td> 
          <td> 0..*</td> 
          <td> Any</td> 
          <td/>  
          <td> 
            <div> 
              <p> The input data for the request. These data are defined by the data requirements of the
                 module and typically provide patient-dependent information.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> patient</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> The patient in context, if any.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> encounter</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> The encounter in context, if any.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> initiatingOrganization</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> The organization initiating the request.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> initiatingPerson</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> The person initiating the request.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> userType</td> 
          <td> 0..1</td> 
          <td> CodeableConcept</td> 
          <td/>  
          <td> 
            <div> 
              <p> The type of user initiating the request, e.g. patient, healthcare provider, or specific
                 type of healthcare provider (physician, nurse, etc.).</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> userLanguage</td> 
          <td> 0..1</td> 
          <td> CodeableConcept</td> 
          <td/>  
          <td> 
            <div> 
              <p> Preferred language of the person using the system.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> userTaskContext</td> 
          <td> 0..1</td> 
          <td> CodeableConcept</td> 
          <td/>  
          <td> 
            <div> 
              <p> The task the system user is performing, e.g. laboratory results review, medication list
                 review, etc. This information can be used to tailor decision support outputs, such as
                 recommended information resources.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> receivingOrganization</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> The organization that will receive the response.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> receivingPerson</td> 
          <td> 0..1</td> 
          <td> Reference</td> 
          <td/>  
          <td> 
            <div> 
              <p> The person in the receiving organization that will receive the response.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> recipientType</td> 
          <td> 0..1</td> 
          <td> CodeableConcept</td> 
          <td/>  
          <td> 
            <div> 
              <p> The type of individual that will consume the response content. This may be different from
                 the requesting user type (e.g. if a clinician is getting disease management guidance for
                 provision to a patient). E.g. patient, healthcare provider or specific type of healthcare
                 provider (physician, nurse, etc.).</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> recipientLanguage</td> 
          <td> 0..1</td> 
          <td> CodeableConcept</td> 
          <td/>  
          <td> 
            <div> 
              <p> Preferred language of the person that will consume the content.</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.</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div/>  
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/OperationDefinition/ServiceDefinition-evaluate"/> 
  <name value="Evaluate"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2017-12-20T15:52:34+11:00"/> 
  <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="The evaluate operation requests clinical decision support guidance based on a specific
   decision support module"/> 
  <code value="evaluate"/> 
  <resource value="ServiceDefinition"/> 
  <system value="false"/> 
  <type 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="id"/> 
  </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 though
     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 typically supply patient-independent information
     to the module."/> 
    <type value="Parameters"/> 
  </parameter> 
  <parameter> 
    <name value="inputData"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="*"/> 
    <documentation value="The input data for the request. These data are defined by the data requirements of the
     module and typically provide patient-dependent information."/> 
    <type value="Any"/> 
  </parameter> 
  <parameter> 
    <name value="patient"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The patient in context, if any."/> 
    <type value="Reference"/> 
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> 
  </parameter> 
  <parameter> 
    <name value="encounter"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The encounter in context, if any."/> 
    <type value="Reference"/> 
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> 
  </parameter> 
  <parameter> 
    <name value="initiatingOrganization"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The organization initiating the request."/> 
    <type value="Reference"/> 
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> 
  </parameter> 
  <parameter> 
    <name value="initiatingPerson"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The person initiating the request."/> 
    <type value="Reference"/> 
  </parameter> 
  <parameter> 
    <name value="userType"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The type of user initiating the request, e.g. patient, healthcare provider, or specific
     type of healthcare provider (physician, nurse, etc.)."/> 
    <type value="CodeableConcept"/> 
  </parameter> 
  <parameter> 
    <name value="userLanguage"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Preferred language of the person using the system."/> 
    <type value="CodeableConcept"/> 
  </parameter> 
  <parameter> 
    <name value="userTaskContext"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The task the system user is performing, e.g. laboratory results review, medication list
     review, etc. This information can be used to tailor decision support outputs, such as
     recommended information resources."/> 
    <type value="CodeableConcept"/> 
  </parameter> 
  <parameter> 
    <name value="receivingOrganization"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The organization that will receive the response."/> 
    <type value="Reference"/> 
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> 
  </parameter> 
  <parameter> 
    <name value="receivingPerson"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The person in the receiving organization that will receive the response."/> 
    <type value="Reference"/> 
  </parameter> 
  <parameter> 
    <name value="recipientType"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The type of individual that will consume the response content. This may be different from
     the requesting user type (e.g. if a clinician is getting disease management guidance for
     provision to a patient). E.g. patient, healthcare provider or specific type of healthcare
     provider (physician, nurse, etc.)."/> 
    <type value="CodeableConcept"/> 
  </parameter> 
  <parameter> 
    <name value="recipientLanguage"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Preferred language of the person that will consume the content."/> 
    <type value="CodeableConcept"/> 
  </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."/> 
    <type value="GuidanceResponse"/> 
  </parameter> 
</OperationDefinition>