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": "eRS-BookAppointment-Operation-1",
  "text": {
    "status": "generated"
  },
  "url": "https://fhir.nhs.uk/STU3/OperationDefinition/eRS-BookAppointment-Operation-1",
  "version": "1.0.0",
  "name": "eRS-BookAppointment-Operation-1",
  "status": "draft",
  "kind": "operation",
  "date": "2019-10-14T11:07:00+01:00",
  "publisher": "NHS Digital",
  "contact": [
    {
      "name": "Interoperability Team",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work"
        }
      ]
    }
  ],
  "description": "To book an appointment slot for a referral of a patient.",
  "code": "ers.BookAppointment",
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "slotId",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The identifier for this slot.  The namespace for this identifier is \"https://fhir.nhs.uk/Id/ers-slot-identifier\".",
      "type": "Identifier"
    },
    {
      "name": "intentionToAddReferralLetter",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Intention to add a referral letter.",
      "type": "Coding",
      "binding": {
        "strength": "required",
        "valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/eRS-ReferralLetterIntention-1"
      }
    },
    {
      "name": "referral",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The referral request that has just been updated.",
      "type": "ReferralRequest",
      "profile": {
        "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
      }
    }
  ]
}