UEC-Evaluate-Operation-1

HTML View

Parameters (In)

NameCardinalityTypeBindingDocumentation
requestId0..1Id

An optional client-provided identifier to track the request.

inputParameters0..1Parameters

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.

inputData0..*Any

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.

patient1..1Reference

The patient in context, if any.

encounter1..1Reference

The encounter in context, if any.

initiatingOrganization0..1Reference

The organisation initiating the request.

initiatingPerson0..1Reference

The person initiating the request.

userType0..1CodeableConceptUEC Role Code (required)

The type of user initiating the request, e.g. Professional, Patient, Responsible person.

userLanguage0..1CodeableConcepthttp://hl7.org/fhir/stu3/valueset-languages (required)

Preferred language of the person using the system.

userTaskContext0..1CodeableConceptUEC Task Context (required)

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.

receivingOrganization0..1Reference

The organization that will receive the response.

receivingPerson0..1Reference

The person in the receiving organization who will receive the response. This MUST be the same as the initiatingPerson.

recipientType0..1CodeableConceptUEC Role Code (required)

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.

recipientLanguage0..1CodeableConcepthttp://hl7.org/fhir/stu3/valueset-languages (required)

Preferred language of the person using the system.

setting0..1CodeableConceptUEC Communication Channel (required)

The current setting of the request (Online, Telephony, Face to Face, Video consultation, SMS, Email).

settingContext0..1CodeableConcept

Additional detail about the setting of the request, if any.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1GuidanceResponse

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.

Table View

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

XML View

<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" />
<name value="UEC Interoperability Team" />
<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" />
<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>
<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>
<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>
<name value="patient" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The patient in context, if any." />
<type value="Reference" />
</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>
<name value="initiatingOrganization" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The organisation initiating the request." />
<type value="Reference" />
</parameter>
<name value="initiatingPerson" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The person initiating the request." />
<type value="Reference" />
</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" />
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-RoleCode-1" />
</binding>
</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" />
<strength value="required" />
<valueSetUri value="http://hl7.org/fhir/stu3/valueset-languages" />
</binding>
</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" />
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-TaskContext-1" />
</binding>
</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>
<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>
<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" />
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-RoleCode-1" />
</binding>
</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" />
<strength value="required" />
<valueSetUri value="http://hl7.org/fhir/stu3/valueset-languages" />
</binding>
</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" />
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/UEC-CommunicationChannel-1" />
</binding>
</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>
<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>

JSON View

{
"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,
{
"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"
}
]
}
---
back to top