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-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>