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-CheckServices-Operation-1"/>
   <url value="https://fhir.nhs.uk/STU3/OperationDefinition/UEC-CheckServices-Operation-1"/>
   <version value="1.1.0"/>
   <name value="UEC-CheckServices-Operation"/>
   <status value="draft"/>
   <kind value="operation"/>
   <date value="2020-04-15T00: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 a Directory of Services (DoS). It is performed at a server level at the end of a triage journey with a generic Referral Request defined in order to find a specific set of nearby services which can deal with the patient."/>
   <code value="check-services"/>
   <system value="true"/>
   <type value="false"/>
   <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="referralRequest"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The core of the $check-services operation is based on the outcome of triage, represented as a chief concern, next activity and acuity. These are all captured in the ReferralRequest, so this resource contains all that is required for the outcome of triage."/>
      <type value="ReferralRequest"/>
   </parameter>
   <parameter>
      <name value="patient"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The patient for whom the triage took place. There are a number of patient elements which are used by some of the directories such as age and gender."/>
      <type value="Patient"/>
   </parameter>
   <parameter>
      <name value="location"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The location represents the patient's current location."/>
      <type value="Location"/>
   </parameter>
   <parameter>
      <name value="requester"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The person initiating the the $check-services request. The requester is the user of the EMS. This will typically be a Patient or RelatedPerson if the EMS is being used by a member of the public (e.g. a patient-facting public internet system) or a Practitioner where there has been an initiatingOrganisation as part of the triage."/>
      <type value="Any"/>
   </parameter>
   <parameter>
      <name value="registeredGPPractice"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The organization representing the registered GP of the Patient."/>
      <type value="Organization"/>
   </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 Directory of Services that is the target of the check operation."/>
      <type value="Parameters"/>
   </parameter>
   <parameter>
      <name value="searchDistance"/>
      <use value="in"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="The distance/duration to search within."/>
      <type value="Quantity"/>
   </parameter>
   <parameter>
      <name value="services"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The output is a set of HealthcareService resources and related information which can deliver the patient's health needs."/>
      <type value="Parameters"/>
   </parameter>
   <parameter>
      <name value="services.parameters"/>
      <use value="out"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="Each healthcare service returned MUST have it's own parameter."/>
      <type value="BackboneElement"/>
   </parameter>
   <parameter>
      <name value="services.parameters.name"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="This MUST be populated with the serviceId."/>
      <type value="string"/>
   </parameter>
   <parameter>
      <name value="services.parameters.part"/>
      <use value="out"/>
      <min value="1"/>
      <max value="*"/>
      <documentation value="Named parts of this parameter. This MUST contain a parameter named service which MUST contain the HealthcareService resource. This MAY also contain other implementation-specific information about the HealthcareService such as it's distance from the patient's location or capacity."/>
      <type value="string"/>
   </parameter>
   <parameter>
      <name value="outputParameters"/>
      <use value="out"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="The output parameters for a request, if any. These parameters are defined by the target DoS."/>
      <type value="Parameters"/>
   </parameter>
</OperationDefinition>