API Hub

Explore and Make use of Nationally Defined Messaging APIs

This is a HL7 FHIR server, and as you appear to be accessing this page from a web browser you are seeing a HTML version of the requested resource(s). You can also access this URL from a FHIR client as a ReSTful API call. For more details please see the HL7 FHIR specification.
{
  "resourceType": "OperationDefinition",
  "id": "UEC-Evaluate-Operation-1",
  "url": "https://fhir.nhs.uk/STU3/OperationDefinition/UEC-Evaluate-Operation-1",
  "version": "1.0.0",
  "name": "UEC-Evaluate-Operation",
  "status": "draft",
  "kind": "operation",
  "date": "2020-03-27T00:00:00+00:00",
  "publisher": "NHS Digital",
  "contact": [
    {
      "name": "UEC Interoperability Team",
      "telecom": [
        {
          "value": "uecintegration@nhs.net",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This is a FHIR operation performed by the Encounter Management System (EMS). It is an evaluate operation performed against the Service Definition resource to request clinical decision support guidance from a selected Clinical Decision Support System (CDSS).",
  "code": "evaluate",
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "requestId",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "An optional client-provided identifier to track the request.",
      "type": "id"
    },
    {
      "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. The inputData element MUST be populated with FHIR resources detailing the current state of the triage journey as follows: All assertions current for this Encounter (typically Observation resources). This includes all GuidanceResponse outputParameters supplied by any CDSS. Any relevant information taken from other (external) systems SHOULD be included. OR Any QuestionnaireResponse(s) available from the user. Note that this MAY include QuestionnaireResponse(s) which have been amended. These MUST be addressed by the CDSS and the assertions updated. The CDSS MUST filter the supplied inputData and disregard any information not relevant for the ServiceDefinition. The EMS MUST NOT send duplicate items.",
      "type": "Any"
    },
    {
      "name": "patient",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The patient in context, if any.",
      "type": "Reference"
    },
    {
      "name": "encounter",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The encounter in context, if any.",
      "type": "Reference"
    },
    {
      "name": "initiatingOrganization",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organisation initiating the request.",
      "type": "Reference"
    },
    {
      "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. Professional, Patient, Responsible person.",
      "type": "CodeableConcept",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/UEC-RoleCode-1"
      }
    },
    {
      "name": "userLanguage",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Preferred language of the person using the system.",
      "type": "CodeableConcept",
      "binding": {
        "strength": "required",
        "valueSetUri": "http://hl7.org/fhir/stu3/valueset-languages"
      }
    },
    {
      "name": "userTaskContext",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The task the system user is performing, e.g. Triage, Consultation, History taking. This information can be used to tailor decision support outputs, such as recommended information resources.",
      "type": "CodeableConcept",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/UEC-TaskContext-1"
      }
    },
    {
      "name": "receivingOrganization",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organization that will receive the response.",
      "type": "Reference"
    },
    {
      "name": "receivingPerson",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The person in the receiving organization who will receive the response. This MUST be the same as the initiatingPerson.",
      "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. Professional, Patient, Responsible person.",
      "type": "CodeableConcept",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/UEC-RoleCode-1"
      }
    },
    {
      "name": "recipientLanguage",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Preferred language of the person using the system.",
      "type": "CodeableConcept",
      "binding": {
        "strength": "required",
        "valueSetUri": "http://hl7.org/fhir/stu3/valueset-languages"
      }
    },
    {
      "name": "setting",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The current setting of the request (Online, Telephony, Face to Face, Video consultation, SMS, Email).",
      "type": "CodeableConcept",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/UEC-CommunicationChannel-1"
      }
    },
    {
      "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. Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource.",
      "type": "GuidanceResponse"
    }
  ]
}