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.
{
  "resourceType": "OperationDefinition",
  "id": "UEC-CheckServices-Operation-1",
  "url": "https://fhir.nhs.uk/STU3/OperationDefinition/UEC-CheckServices-Operation-1",
  "version": "1.1.0",
  "name": "UEC-CheckServices-Operation",
  "status": "draft",
  "kind": "operation",
  "date": "2020-04-15T00: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 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": "check-services",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "requestId",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "An optional client-provided identifier to track the request.",
      "type": "id"
    },
    {
      "name": "referralRequest",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "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": "ReferralRequest"
    },
    {
      "name": "patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "Patient"
    },
    {
      "name": "location",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The location represents the patient's current location.",
      "type": "Location"
    },
    {
      "name": "requester",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "Any"
    },
    {
      "name": "registeredGPPractice",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organization representing the registered GP of the Patient.",
      "type": "Organization"
    },
    {
      "name": "inputParameters",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "Parameters"
    },
    {
      "name": "searchDistance",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "The distance/duration to search within.",
      "type": "Quantity"
    },
    {
      "name": "services",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The output is a set of HealthcareService resources and related information which can deliver the patient's health needs.",
      "type": "Parameters"
    },
    {
      "name": "services.parameters",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "Each healthcare service returned MUST have it's own parameter.",
      "type": "BackboneElement"
    },
    {
      "name": "services.parameters.name",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "This MUST be populated with the serviceId.",
      "type": "string"
    },
    {
      "name": "services.parameters.part",
      "use": "out",
      "min": 1,
      "max": "*",
      "documentation": "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": "string"
    },
    {
      "name": "outputParameters",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "The output parameters for a request, if any. These parameters are defined by the target DoS.",
      "type": "Parameters"
    }
  ]
}