{
  "description": "Sample capability statement showing new MessageDefinition structure, modify this Capability Statement to reflect what your system is capable of.",
  "_filename": "BARS-CapabilityStatement-example.json",
  "package_name": "uk.nhsdigital.bars.r4",
  "format": [ "xml", "json" ],
  "date": "2024-01-09",
  "publisher": "NHS England",
  "fhirVersion": "4.0.1",
  "name": "BaRS FHIR Server CapabilityStatement",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": null,
  "package_version": "1.28.0",
  "status": "active",
  "messaging": [ {
    "endpoint": [ {
      "address": "https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4",
      "protocol": {
        "code": "http"
      }
    } ],
    "supportedMessage": [ {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-validation"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-interim"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-full"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-cancelled"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request-cancelled"
    }, {
      "mode": "sender",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral-short"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-validation"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-interim"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-full"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-cancelled"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request-cancelled"
    }, {
      "mode": "receiver",
      "definition": "https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral-short"
    } ]
  } ],
  "id": "706cd3f1-1271-47b1-b346-d2f69e078e08",
  "kind": "instance",
  "url": "https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4'",
  "software": {
    "name": "NHS Digital",
    "version": "1.2.0"
  },
  "version": "1.4.0",
  "contact": [ {
    "name": "System Administrator",
    "telecom": [ {
      "value": "interoperabilityteam@nhs.net",
      "system": "email"
    } ]
  } ],
  "implementation": {
    "url": "https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4",
    "description": "BaRS FHIR Server"
  },
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "CapabilityStatement",
      "versioning": "no-version",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "vread"
      } ]
    }, {
      "type": "MessageDefinition",
      "versioning": "no-version",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "useContext:identifier",
        "type": "token",
        "documentation": "The target service identifier. Allowing the ability to filter returned message definitions by the specified service id."
      } ]
    }, {
      "type": "Appointment",
      "versioning": "no-version",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "vread"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "documentation": "Unique identifier for an appointment"
      }, {
        "name": "date",
        "type": "date",
        "documentation": "Appointment start date"
      }, {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "NHS Number (system must be https://fhir.nhs.uk/Id/nhs-number)"
      } ]
    }, {
      "type": "ServiceRequest",
      "versioning": "no-version",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "vread"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "documentation": "Unique identifier for a ServiceRequest"
      }, {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "NHS Number (system must be https://fhir.nhs.uk/Id/nhs-number)"
      } ]
    }, {
      "type": "Slot",
      "versioning": "no-version",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "start",
        "type": "date"
      }, {
        "name": "status",
        "type": "token"
      }, {
        "name": "Schedule.actor:HealthcareService",
        "type": "token"
      } ],
      "searchInclude": [ "Slot:schedule", "Schedule:actor:Practitioner", "Schedule:actor:PractitionerRole", "Schedule:actor:HealthcareService", "HealthcareService.providedBy", "HealthcareService:location" ]
    } ],
    "security": {
      "service": [ {
        "coding": [ {
          "code": "Certificates",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
          "display": "Certificates"
        } ]
      } ]
    },
    "operation": [ {
      "name": "$process-message",
      "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
    } ],
    "interaction": [ {
      "code": "transaction"
    }, {
      "code": "search-system"
    } ]
  }, {
    "mode": "client",
    "resource": [ {
      "type": "Appointment",
      "versioning": "no-version",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "vread"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "documentation": "Unique identifier for an appointment"
      }, {
        "name": "date",
        "type": "date",
        "documentation": "Appointment start date"
      }, {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "NHS Number (system must be https://fhir.nhs.uk/Id/nhs-number)"
      } ]
    }, {
      "type": "ServiceRequest",
      "versioning": "no-version",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "vread"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "documentation": "Unique identifier for a ServiceRequest"
      }, {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "NHS Number (system must be https://fhir.nhs.uk/Id/nhs-number)"
      } ]
    }, {
      "type": "Slot",
      "versioning": "no-version",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "start",
        "type": "date"
      }, {
        "name": "status",
        "type": "token"
      }, {
        "name": "Schedule.actor:HealthcareService",
        "type": "token"
      } ],
      "searchInclude": [ "Slot:schedule", "Schedule:actor:Practitioner", "Schedule:actor:PractitionerRole", "Schedule:actor:HealthcareService", "HealthcareService.providedBy", "HealthcareService:location" ]
    } ],
    "security": {
      "service": [ {
        "coding": [ {
          "code": "OAuth",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
          "display": "OAuth"
        } ]
      } ]
    },
    "operation": [ {
      "name": "$process-message",
      "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
    } ],
    "interaction": [ {
      "code": "transaction"
    }, {
      "code": "search-system"
    } ]
  } ]
}