eHealth Infrastructure

{
  "resourceType" : "OperationDefinition",
  "id" : "Library-i-evaluate",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n<p>The operation is idempotent.</p>\n<h3>Parameter description</h3>\n<ul>\n<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.\nSee ehealth-library.parameters for required parameters.</li>\n</ul>\n<p>Example:</p>\n<pre><code class=\"language-json\">{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'parameters',\n      'resource': {\n        'resourceType': 'Parameters',\n        'parameter': [\n          {\n            'name': 'isWarm',\n            'valueBoolean': true\n          }\n        ]\n      }\n    }\n  ]\n}\n</code></pre>\n<h3>Output description</h3>\n<p>Upon success this operation returns an ehealth-guidanceresponse resource containing the decision support result.</p>\n<p>Extract of example output:</p>\n<pre><code class=\"language-json\">{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'return',\n      'resource': {\n        'resourceType': 'GuidanceResponse',\n        ... ,\n        'contained': [\n          {\n            'resourceType': 'Parameters',\n            'id': 'outputParameters1',\n            'parameter': [\n              {\n                'name': 'situation-quality',\n                'valueCodeableConcept': {\n                  'coding': [\n                    {\n                      'system': 'http://ehealth.sundhed.dk/cs/situation-quality',\n                      'code': 'SQ2',\n                      'display': 'Situation quality 2'\n                    }\n                  ]\n                }\n              ]\n            }\n          ],\n          ... ,\n          'outputParameters': {\n          'reference': '#outputParameters1'\n          }\n        ]\n      }\n    }\n  ]\n}\n</code></pre>\n</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>"
  },
  "url" : "http://ehealth.sundhed.dk/fhir/OperationDefinition/Library-i-evaluate",
  "version" : "2019.5.3",
  "name" : "evaluate",
  "status" : "active",
  "kind" : "operation",
  "date" : "2019-06-07T11:10:06+00:00",
  "description" : "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.\n\nThe operation is idempotent.\n\n### Parameter description\n- 1..1 Parameters: HL7 FHIR [Parameters](https://www.hl7.org/fhir/stu3/parameters.html) resource containing input parameters for the clinical decision support computation.\nSee ehealth-library.parameters for required parameters.\n\nExample:\n\n```json\n{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'parameters',\n      'resource': {\n        'resourceType': 'Parameters',\n        'parameter': [\n          {\n            'name': 'isWarm',\n            'valueBoolean': true\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n### Output description\nUpon success this operation returns an ehealth-guidanceresponse resource containing the decision support result.\n\nExtract of example output:\n\n```json\n{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'return',\n      'resource': {\n        'resourceType': 'GuidanceResponse',\n        ... ,\n        'contained': [\n          {\n            'resourceType': 'Parameters',\n            'id': 'outputParameters1',\n            'parameter': [\n              {\n                'name': 'situation-quality',\n                'valueCodeableConcept': {\n                  'coding': [\n                    {\n                      'system': 'http://ehealth.sundhed.dk/cs/situation-quality',\n                      'code': 'SQ2',\n                      'display': 'Situation quality 2'\n                    }\n                  ]\n                }\n              ]\n            }\n          ],\n          ... ,\n          'outputParameters': {\n          'reference': '#outputParameters1'\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n",
  "idempotent" : true,
  "code" : "evaluate",
  "resource" : [
    "Library"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "parameters",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "Parameters"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "type" : "GuidanceResponse"
    }
  ]
}