Operation-servicedefinition-evaluate.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ServiceDefinition-evaluate",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ServiceDefinition-evaluate",
  "name": "Evaluate",
  "status": "draft",
  "kind": "operation",
  "date": "2017-12-20T15:52:34+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "The evaluate operation requests clinical decision support guidance based on a specific decision support module",
  "code": "evaluate",
  "resource": [
    "ServiceDefinition"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "requestId",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "An optional client-provided identifier to track the request.",
      "type": "id"
    },
    {
      "name": "evaluateAtDateTime",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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 \"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 typically supply patient-independent information to the module.",
      "type": "Parameters"
    },
    {
      "name": "inputData",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "The input data for the request. These data are defined by the data requirements of the module and typically provide patient-dependent information.",
      "type": "Any"
    },
    {
      "name": "patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The patient in context, if any.",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Patient"
      ]
    },
    {
      "name": "encounter",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The encounter in context, if any.",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Encounter"
      ]
    },
    {
      "name": "initiatingOrganization",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organization initiating the request.",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Organization"
      ]
    },
    {
      "name": "initiatingPerson",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The person initiating the request.",
      "type": "Reference"
    },
    {
      "name": "userType",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.).",
      "type": "CodeableConcept"
    },
    {
      "name": "userLanguage",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Preferred language of the person using the system.",
      "type": "CodeableConcept"
    },
    {
      "name": "userTaskContext",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "CodeableConcept"
    },
    {
      "name": "receivingOrganization",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organization that will receive the response.",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Organization"
      ]
    },
    {
      "name": "receivingPerson",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The person in the receiving organization that will receive the response.",
      "type": "Reference"
    },
    {
      "name": "recipientType",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "CodeableConcept"
    },
    {
      "name": "recipientLanguage",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Preferred language of the person that will consume the content.",
      "type": "CodeableConcept"
    },
    {
      "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.",
      "type": "GuidanceResponse"
    }
  ]
}