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.
<?xml version="1.0" encoding="UTF-8" standalone="no"?><OperationDefinition xmlns="http://hl7.org/fhir">
   <id value="UEC-Evaluate-Operation-1"/>
   <url value="https://fhir.nhs.uk/STU3/OperationDefinition/UEC-Evaluate-Operation-1"/>
   <version value="1.0.0"/>
   <name value="UEC-Evaluate-Operation"/>
   <status value="draft"/>
   <kind value="operation"/>
   <date value="2020-03-27T00:00:00+00:00"/>
   <publisher value="NHS Digital"/>
   <contact>
      <name value="UEC Interoperability Team"/>
      <telecom>
         <value value="uecintegration@nhs.net"/>
         <use value="work"/>
      </telecom>
   </contact>
   <description value="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 value="evaluate"/>
   <system value="false"/>
   <type value="true"/>
   <instance value="false"/>
   <parameter>
      <name value="requestId"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="An optional client-provided identifier to track the request."/>
      <type value="id"/>
   </parameter>
   <parameter>
      <name value="inputParameters"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="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 value="Parameters"/>
   </parameter>
   <parameter>
      <name value="inputData"/>
      <use value="in"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="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 value="Any"/>
   </parameter>
   <parameter>
      <name value="patient"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The patient in context, if any."/>
      <type value="Reference"/>
   </parameter>
   <parameter>
      <name value="encounter"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The encounter in context, if any."/>
      <type value="Reference"/>
   </parameter>
   <parameter>
      <name value="initiatingOrganization"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The organisation initiating the request."/>
      <type value="Reference"/>
   </parameter>
   <parameter>
      <name value="initiatingPerson"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The person initiating the request."/>
      <type value="Reference"/>
   </parameter>
   <parameter>
      <name value="userType"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The type of user initiating the request, e.g. Professional, Patient, Responsible person."/>
      <type value="CodeableConcept"/>
      <binding>
         <strength value="required"/>
         <valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-RoleCode-1"/>
      </binding>
   </parameter>
   <parameter>
      <name value="userLanguage"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Preferred language of the person using the system."/>
      <type value="CodeableConcept"/>
      <binding>
         <strength value="required"/>
         <valueSetUri value="http://hl7.org/fhir/stu3/valueset-languages"/>
      </binding>
   </parameter>
   <parameter>
      <name value="userTaskContext"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="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 value="CodeableConcept"/>
      <binding>
         <strength value="required"/>
         <valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-TaskContext-1"/>
      </binding>
   </parameter>
   <parameter>
      <name value="receivingOrganization"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The organization that will receive the response."/>
      <type value="Reference"/>
   </parameter>
   <parameter>
      <name value="receivingPerson"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The person in the receiving organization who will receive the response. This MUST be the same as the initiatingPerson."/>
      <type value="Reference"/>
   </parameter>
   <parameter>
      <name value="recipientType"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="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 value="CodeableConcept"/>
      <binding>
         <strength value="required"/>
         <valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-RoleCode-1"/>
      </binding>
   </parameter>
   <parameter>
      <name value="recipientLanguage"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Preferred language of the person using the system."/>
      <type value="CodeableConcept"/>
      <binding>
         <strength value="required"/>
         <valueSetUri value="http://hl7.org/fhir/stu3/valueset-languages"/>
      </binding>
   </parameter>
   <parameter>
      <name value="setting"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The current setting of the request (Online, Telephony, Face to Face, Video consultation, SMS, Email)."/>
      <type value="CodeableConcept"/>
      <binding>
         <strength value="required"/>
         <valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-CommunicationChannel-1"/>
      </binding>
   </parameter>
   <parameter>
      <name value="settingContext"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Additional detail about the setting of the request, if any."/>
      <type value="CodeableConcept"/>
   </parameter>
   <parameter>
      <name value="return"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="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 value="GuidanceResponse"/>
   </parameter>
</OperationDefinition>