• Content
• XML
• JSON

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Library-i-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://ehealth.sundhed.dk/fhir/OperationDefinition/Library-i-evaluate</pre><div><p>This operation evaluates parameters passed as input against the decision support rule identified by the ehealth-library resource. It returns the computed clinical decision support result and/or errors. The operation is applicable for an ehealth-library resource with type=logic-library (see HL7 FHIR <a href="https://www.hl7.org/fhir/stu3/library-definitions.html#Library.type">Library.type</a>). Such a resource identifies a decision support rule and defines its parameters.</p>
<p>The operation is idempotent.</p>
<h3>Parameter description</h3>
<ul>
<li>1..1 Parameters: HL7 FHIR <a href="https://www.hl7.org/fhir/stu3/parameters.html">Parameters</a> resource containing input parameters for the clinical decision support computation.
See ehealth-library.parameters for required parameters.</li>
</ul>
<p>Example:</p>
<pre><code class="language-json">{
  'resourceType': 'Parameters',
  'parameter': [
    {
      'name': 'parameters',
      'resource': {
        'resourceType': 'Parameters',
        'parameter': [
          {
            'name': 'isWarm',
            'valueBoolean': true
          }
        ]
      }
    }
  ]
}
</code></pre>
<h3>Output description</h3>
<p>Upon success this operation returns an ehealth-guidanceresponse resource containing the decision support result.</p>
<p>Extract of example output:</p>
<pre><code class="language-json">{
  'resourceType': 'Parameters',
  'parameter': [
    {
      'name': 'return',
      'resource': {
        'resourceType': 'GuidanceResponse',
        ... ,
        'contained': [
          {
            'resourceType': 'Parameters',
            'id': 'outputParameters1',
            'parameter': [
              {
                'name': 'situation-quality',
                'valueCodeableConcept': {
                  'coding': [
                    {
                      'system': 'http://ehealth.sundhed.dk/cs/situation-quality',
                      'code': 'SQ2',
                      'display': 'Situation quality 2'
                    }
                  ]
                }
              ]
            }
          ],
          ... ,
          'outputParameters': {
          'reference': '#outputParameters1'
          }
        ]
      }
    }
  ]
}
</code></pre>
</div><p>URL: [base]/Library/[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>parameters</td><td>1..1</td><td><a href="http://hl7.org/fhir/STU3/parameters.html">Parameters</a></td><td/><td/></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href="http://hl7.org/fhir/STU3/guidanceresponse.html">GuidanceResponse</a></td><td/><td/></tr></table></div>
  </text>
  <url
       value="http://ehealth.sundhed.dk/fhir/OperationDefinition/Library-i-evaluate"/>
  <version value="2019.5.2"/>
  <name value="evaluate"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2019-05-29T18:05:58+00:00"/>
  <description
               value="This operation evaluates parameters passed as input against the decision support rule identified by the ehealth-library resource. It returns the computed clinical decision support result and/or errors. The operation is applicable for an ehealth-library resource with type=logic-library (see HL7 FHIR [Library.type](https://www.hl7.org/fhir/stu3/library-definitions.html#Library.type)). Such a resource identifies a decision support rule and defines its parameters.

The operation is idempotent.

### Parameter description
- 1..1 Parameters: HL7 FHIR [Parameters](https://www.hl7.org/fhir/stu3/parameters.html) resource containing input parameters for the clinical decision support computation.
See ehealth-library.parameters for required parameters.

Example:

```json
{
  &#39;resourceType&#39;: &#39;Parameters&#39;,
  &#39;parameter&#39;: [
    {
      &#39;name&#39;: &#39;parameters&#39;,
      &#39;resource&#39;: {
        &#39;resourceType&#39;: &#39;Parameters&#39;,
        &#39;parameter&#39;: [
          {
            &#39;name&#39;: &#39;isWarm&#39;,
            &#39;valueBoolean&#39;: true
          }
        ]
      }
    }
  ]
}
```

### Output description
Upon success this operation returns an ehealth-guidanceresponse resource containing the decision support result.

Extract of example output:

```json
{
  &#39;resourceType&#39;: &#39;Parameters&#39;,
  &#39;parameter&#39;: [
    {
      &#39;name&#39;: &#39;return&#39;,
      &#39;resource&#39;: {
        &#39;resourceType&#39;: &#39;GuidanceResponse&#39;,
        ... ,
        &#39;contained&#39;: [
          {
            &#39;resourceType&#39;: &#39;Parameters&#39;,
            &#39;id&#39;: &#39;outputParameters1&#39;,
            &#39;parameter&#39;: [
              {
                &#39;name&#39;: &#39;situation-quality&#39;,
                &#39;valueCodeableConcept&#39;: {
                  &#39;coding&#39;: [
                    {
                      &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/situation-quality&#39;,
                      &#39;code&#39;: &#39;SQ2&#39;,
                      &#39;display&#39;: &#39;Situation quality 2&#39;
                    }
                  ]
                }
              ]
            }
          ],
          ... ,
          &#39;outputParameters&#39;: {
          &#39;reference&#39;: &#39;#outputParameters1&#39;
          }
        ]
      }
    }
  ]
}
```
"/>
  <idempotent value="true"/>
  <code value="evaluate"/>
  <resource value="Library"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="parameters"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="Parameters"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="GuidanceResponse"/>
  </parameter>
</OperationDefinition>