{
  "description": "API Definition for BaRS",
  "_filename": "CapabilityStatement-apim-bars.json",
  "package_name": "uk.nhsdigital.r4",
  "format": [ "application/fhir+json", "application/fhir+xml" ],
  "date": "2021-04-28T00:00:00+00:00",
  "publisher": "digital.nhs.uk",
  "fhirVersion": "4.0.1",
  "name": "SupplierEvents",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": null,
  "package_version": "2.4.3",
  "extension": [ {
    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package",
    "extension": [ {
      "url": "FHIRPackage",
      "extension": [ {
        "url": "name",
        "valueString": "ukcore.release1.test"
      } ]
    }, {
      "url": "FHIRPackage",
      "extension": [ {
        "url": "name",
        "valueString": "uk.nhsdigital.r4.test"
      } ]
    }, {
      "url": "openApi",
      "extension": [ {
        "url": "documentation",
        "valueUri": "https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir"
      }, {
        "url": "description",
        "valueString": "Booking and Referral - FHIR API"
      } ]
    }, {
      "url": "openApi",
      "extension": [ {
        "url": "documentation",
        "valueUri": "https://simplifier.net/guide/nhsbookingandreferrals/home"
      }, {
        "url": "description",
        "valueString": "NHS Bookings and Referrals"
      } ]
    } ]
  } ],
  "status": "active",
  "messaging": [ {
    "supportedMessage": [ {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response"
    }, {
      "mode": "receiver",
      "extension": [ {
        "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
        "extension": [ {
          "url": "example",
          "extension": [ {
            "url": "request",
            "valueBoolean": true
          }, {
            "url": "value",
            "valueReference": {
              "reference": "Bundle/950831dd-2603-442d-9a07-e4b6cd2ac544"
            }
          } ]
        } ]
      } ],
      "definition": "https://fhir.nhs.uk/MessageDefinition/subscription-notification"
    } ]
  } ],
  "id": "5ec38b9d-bd63-471b-b5b6-3ced7218b4ff",
  "kind": "requirements",
  "url": "https://fhir.nhs.uk/CapabilityStatement/apim-bars",
  "version": "3.0.0",
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "ServiceRequest",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest",
      "interaction": [ {
        "code": "read",
        "documentation": "Get a specific referral"
      }, {
        "code": "search-type",
        "documentation": "Get referral/s for a patient"
      } ],
      "searchParam": [ {
        "name": "patient.identifier",
        "type": "token",
        "documentation": "The patient identifier (e.g. NHS Number) that the service request is about"
      } ],
      "documentation": "Supports Referrals and advice guidance requests"
    }, {
      "type": "Slot",
      "profile": "https://fhir.nhs.uk/StructureDefinition/England-Slot",
      "interaction": [ {
        "code": "search-type",
        "documentation": "Get slots"
      } ],
      "searchParam": [ {
        "name": "status",
        "type": "token",
        "documentation": "The free/busy status of the appointment"
      }, {
        "name": "start",
        "type": "date",
        "documentation": "Appointment start date/time."
      }, {
        "name": "end",
        "type": "date",
        "documentation": "Appointment end date/time."
      }, {
        "name": "_include",
        "type": "composite",
        "documentation": "Inclusions that drive the rescusive depth of the search"
      } ],
      "searchInclude": [ "Slot:schedule", "Schedule:actor:Practitioner", "Schedule:actor:PractitionerRole", "Schedule:actor:HealthcareService", "Schedule:actor:Organization", "Schedule:actor:Location" ]
    }, {
      "type": "Appointment",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Appointment",
      "interaction": [ {
        "code": "read",
        "documentation": "Get a specific booking"
      }, {
        "code": "search-type",
        "documentation": "Get Bookings for a patient"
      } ],
      "searchParam": [ {
        "name": "patient.identifier",
        "type": "token",
        "extension": [ {
          "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
          "extension": [ {
            "url": "required",
            "valueBoolean": true
          }, {
            "url": "minimum",
            "valueInteger": 1
          }, {
            "url": "maximum",
            "valueInteger": 1
          }, {
            "url": "exampleParameter",
            "valueString": "https://fhir.nhs.uk/Id/nhs-number|9000000009"
          } ]
        } ],
        "documentation": "Search for appointment for a patient by NHS Number"
      } ]
    }, {
      "type": "MessageDefinition",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MessageDefinition",
      "interaction": [ {
        "code": "read",
        "documentation": "Find Message Definition"
      } ]
    } ],
    "security": {
      "service": [ {
        "coding": [ {
          "code": "OAuth",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
          "display": "OAuth2 Token"
        } ]
      } ]
    },
    "operation": [ {
      "name": "process-message",
      "definition": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-process-message",
      "documentation": "Destination of both subscription-notifications and BaRS referrals"
    } ]
  } ]
}