Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-decisionsupportservicemodule-evaluate.json

Raw JSON (canonical form)

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "DecisionSupportServiceModule-evaluate",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/DecisionSupportServiceModule-evaluate",
  "name": "Evaluate",
  "status": "draft",
  "kind": "operation",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "date": "2015-12-11T17:38:40+11:00",
  "description": "The evaluate operation requests clinical decision support guidance based on a specific decision support module",
  "code": "evaluate",
  "system": false,
  "instance": true,
  "parameter": [
    {
      "name": "requestId",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "An optional client-provided identifier to track the request",
      "type": "code"
    },
    {
      "name": "evaluateAtDateTime",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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 \"Now\" 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": "datetime"
    },
    {
      "name": "inputParameters",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "Parameters"
    },
    {
      "name": "setting",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The current setting of the request (inpatient, outpatient, etc)",
      "type": "CodeableConcept"
    },
    {
      "name": "settingContext",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Additional detail about the setting of the request, if any",
      "type": "CodeableConcept"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The result of the request as a GuidanceResponse resource. Output parameters, if any, will be contained in the parameters element of the response",
      "type": "GuidanceResponse"
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.