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-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"
    }
  ]
}