UEC-IsValid-Operation-1

HTML View

Parameters (In)

NameCardinalityTypeDocumentation
requestId0..1Id

An optional client-provided identifier to track the request.

ODSCode1..1Identifier

The validity of the CDSS is based on the current patient's registered GP.

evaluateAtDateTime0..1DateTime

The date time for which the evaluation should be carried out. If not supplied the default is ‘now’.

dateOfBirth0..1DateTime

The patient's date of birth.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Boolean

The output is a boolean - true if the CDSS is valid for this patient at this time, and false if not.

Table View

OperationDefinition.id[0]UEC-IsValid-Operation-1
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/UEC-IsValid-Operation-1
OperationDefinition.version[0]1.1.0
OperationDefinition.name[0]UEC-IsValid-Operation
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2020-04-16T00: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 an EMS. It is performed at the ServiceDefinition resource type level at the start of a triage journey in order to check whether this CDSS is able to provide ServiceDefinitions appropriate for the current journey.
OperationDefinition.code[0]isValid
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]ODSCode
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]The validity of the CDSS is based on the current patient's registered GP.
OperationDefinition.parameter[1].type[0]Identifier
OperationDefinition.parameter[2].name[0]evaluateAtDateTime
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]The date time for which the evaluation should be carried out. If not supplied the default is ‘now’.
OperationDefinition.parameter[2].type[0]dateTime
OperationDefinition.parameter[3].name[0]dateOfBirth
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]0
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]The patient's date of birth.
OperationDefinition.parameter[3].type[0]dateTime
OperationDefinition.parameter[4].name[0]return
OperationDefinition.parameter[4].use[0]out
OperationDefinition.parameter[4].min[0]1
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]The output is a boolean - true if the CDSS is valid for this patient at this time, and false if not.
OperationDefinition.parameter[4].type[0]boolean

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="UEC-IsValid-Operation-1" />
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/UEC-IsValid-Operation-1" />
<version value="1.1.0" />
<name value="UEC-IsValid-Operation" />
<status value="draft" />
<kind value="operation" />
<date value="2020-04-16T00: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 an EMS. It is performed at the ServiceDefinition resource type level at the start of a triage journey in order to check whether this CDSS is able to provide ServiceDefinitions appropriate for the current journey." />
<code value="isValid" />
<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="ODSCode" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The validity of the CDSS is based on the current patient's registered GP." />
<type value="Identifier" />
</parameter>
<parameter>
<name value="evaluateAtDateTime" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The date time for which the evaluation should be carried out. If not supplied the default is ‘now’." />
<type value="dateTime" />
</parameter>
<parameter>
<name value="dateOfBirth" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The patient's date of birth." />
<type value="dateTime" />
</parameter>
<parameter>
<name value="return" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The output is a boolean - true if the CDSS is valid for this patient at this time, and false if not." />
<type value="boolean" />
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"id": "UEC-IsValid-Operation-1",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/UEC-IsValid-Operation-1",
"version": "1.1.0",
"name": "UEC-IsValid-Operation",
"status": "draft",
"kind": "operation",
"date": "2020-04-16T00: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 an EMS. It is performed at the ServiceDefinition resource type level at the start of a triage journey in order to check whether this CDSS is able to provide ServiceDefinitions appropriate for the current journey.",
"code": "isValid",
"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": "ODSCode",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The validity of the CDSS is based on the current patient's registered GP.",
"type": "Identifier"
},
{
"name": "evaluateAtDateTime",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date time for which the evaluation should be carried out. If not supplied the default is ‘now’.",
"type": "dateTime"
},
{
"name": "dateOfBirth",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The patient's date of birth.",
"type": "dateTime"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The output is a boolean - true if the CDSS is valid for this patient at this time, and false if not.",
"type": "boolean"
}
]
}
---
back to top