FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/45bcbe62-718b-4874-a68c-b0fe39a76cf5

Packageuk.nhsdigital.bars.r4
Resource TypeCapabilityStatement
Id45bcbe62-718b-4874-a68c-b0fe39a76cf5
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=uk.nhsdigital.bars.r4@1.36.0&canonical=https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4'
URLhttps://int.api.service.nhs.uk/booking-and-referral/FHIR/R4'
Version1.1.0
Statusactive
Date2024-01-09
NameBaRS FHIR Server CapabilityStatement
DescriptionSample capability statement showing new MessageDefinition structure, modify this Capability Statement to reflect what your system is capable of.
Kindinstance

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source

{
  "resourceType": "CapabilityStatement",
  "id": "45bcbe62-718b-4874-a68c-b0fe39a76cf5",
  "url": "https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4'",
  "version": "1.1.0",
  "name": "BaRS FHIR Server CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2024-01-09",
  "publisher": "NHS England",
  "contact": [
    {
      "name": "System Administrator",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net"
        }
      ]
    }
  ],
  "description": "Sample capability statement showing new MessageDefinition structure, modify this Capability Statement to reflect what your system is capable of.",
  "kind": "instance",
  "software": {
    "name": "NHS Digital",
    "version": "1.2.0"
  },
  "implementation": {
    "description": "BaRS FHIR Server",
    "url": "https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "Certificates",
                "display": "Certificates"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "CapabilityStatement",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "no-version"
        },
        {
          "type": "MessageDefinition",
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "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",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "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",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "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",
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "searchInclude": [
            "Slot:schedule",
            "Schedule:actor:Practitioner",
            "Schedule:actor:PractitionerRole",
            "Schedule:actor:HealthcareService",
            "HealthcareService.providedBy",
            "HealthcareService:location"
          ],
          "searchParam": [
            {
              "name": "start",
              "type": "date"
            },
            {
              "name": "status",
              "type": "token"
            },
            {
              "name": "Schedule.actor:HealthcareService",
              "type": "token"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "search-system"
        }
      ],
      "operation": [
        {
          "name": "$process-message",
          "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
        }
      ]
    },
    {
      "mode": "client",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "OAuth",
                "display": "OAuth"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "Appointment",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "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",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "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",
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "searchInclude": [
            "Slot:schedule",
            "Schedule:actor:Practitioner",
            "Schedule:actor:PractitionerRole",
            "Schedule:actor:HealthcareService",
            "HealthcareService.providedBy",
            "HealthcareService:location"
          ],
          "searchParam": [
            {
              "name": "start",
              "type": "date"
            },
            {
              "name": "status",
              "type": "token"
            },
            {
              "name": "Schedule.actor:HealthcareService",
              "type": "token"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "search-system"
        }
      ],
      "operation": [
        {
          "name": "$process-message",
          "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
        }
      ]
    }
  ],
  "messaging": [
    {
      "endpoint": [
        {
          "protocol": {
            "code": "http"
          },
          "address": "https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4"
        }
      ],
      "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"
        }
      ]
    }
  ]
}