Important: This guide is currently under development
This is a preview of a developing guide for information only. It is not intended to be used until the completed v1.0.0 guide is released (around the end of March 2023)
If you are interested in developing a BaRS compliant solution right now, please use the contact form here and the team will be in touch
CapabilityStatements
Table
CapabilityStatement.id[0] | 45bcbe62-718b-4874-a68c-b0fe39a76cf5 |
CapabilityStatement.status[0] | active |
CapabilityStatement.experimental[0] | True |
CapabilityStatement.date[0] | 2022-06-29 |
CapabilityStatement.publisher[0] | NHS Digital |
CapabilityStatement.contact[0].name[0] | System Administrator |
CapabilityStatement.contact[0].telecom[0].system[0] | |
CapabilityStatement.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CapabilityStatement.description[0] | Sample capability statement showing new MessageDefinition structure, modify this Capability Statement to reflect what your system is capable of. |
CapabilityStatement.kind[0] | instance |
CapabilityStatement.software[0].name[0] | NHS Digital |
CapabilityStatement.implementation[0].description[0] | NHS Digital Message endpoint |
CapabilityStatement.implementation[0].url[0] | https://fhir.nhs.uk/fhir/message-drop |
CapabilityStatement.fhirVersion[0] | 4.0.1 |
CapabilityStatement.format[0] | xml |
CapabilityStatement.format[1] | json |
CapabilityStatement.messaging[0].endpoint[0].protocol[0].system[0] | http://terminology.hl7.org/CodeSystem/message-transport |
CapabilityStatement.messaging[0].endpoint[0].protocol[0].code[0] | mllp |
CapabilityStatement.messaging[0].endpoint[0].address[0] | mllp:10.1.1.10:9234 |
CapabilityStatement.messaging[0].reliableCache[0] | 30 |
CapabilityStatement.messaging[0].documentation[0] | ADT A08 equivalent for external system notifications |
CapabilityStatement.messaging[0].supportedMessage[0].mode[0] | sender |
CapabilityStatement.messaging[0].supportedMessage[0].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-validation |
CapabilityStatement.messaging[0].supportedMessage[1].mode[0] | sender |
CapabilityStatement.messaging[0].supportedMessage[1].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-interim |
CapabilityStatement.messaging[0].supportedMessage[2].mode[0] | sender |
CapabilityStatement.messaging[0].supportedMessage[2].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-full |
CapabilityStatement.messaging[0].supportedMessage[3].mode[0] | sender |
CapabilityStatement.messaging[0].supportedMessage[3].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral |
CapabilityStatement.messaging[0].supportedMessage[4].mode[0] | sender |
CapabilityStatement.messaging[0].supportedMessage[4].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral |
CapabilityStatement.messaging[0].supportedMessage[5].mode[0] | sender |
CapabilityStatement.messaging[0].supportedMessage[5].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request |
CapabilityStatement.messaging[0].supportedMessage[6].mode[0] | receiver |
CapabilityStatement.messaging[0].supportedMessage[6].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-validation |
CapabilityStatement.messaging[0].supportedMessage[7].mode[0] | receiver |
CapabilityStatement.messaging[0].supportedMessage[7].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-interim |
CapabilityStatement.messaging[0].supportedMessage[8].mode[0] | receiver |
CapabilityStatement.messaging[0].supportedMessage[8].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-full |
CapabilityStatement.messaging[0].supportedMessage[9].mode[0] | receiver |
CapabilityStatement.messaging[0].supportedMessage[9].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral |
CapabilityStatement.messaging[0].supportedMessage[10].mode[0] | receiver |
CapabilityStatement.messaging[0].supportedMessage[10].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral |
CapabilityStatement.messaging[0].supportedMessage[11].mode[0] | receiver |
CapabilityStatement.messaging[0].supportedMessage[11].definition[0] | https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request |
XML
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="45bcbe62-718b-4874-a68c-b0fe39a76cf5" /> <status value="active" /> <experimental value="true" /> <date value="2022-06-29" /> <publisher value="NHS Digital" /> <contact> <name value="System Administrator" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> </telecom> </contact> <description value="Sample capability statement showing new MessageDefinition structure, modify this Capability Statement to reflect what your system is capable of." /> <kind value="instance" /> <software> <name value="NHS Digital" /> </software> <implementation> <description value="NHS Digital Message endpoint" /> <url value="https://fhir.nhs.uk/fhir/message-drop" /> </implementation> <fhirVersion value="4.0.1" /> <format value="xml" /> <format value="json" /> <messaging> <endpoint> <protocol> <system value="http://terminology.hl7.org/CodeSystem/message-transport" /> <code value="mllp" /> </protocol> <address value="mllp:10.1.1.10:9234" /> </endpoint> <reliableCache value="30" /> <documentation value="ADT A08 equivalent for external system notifications" /> <supportedMessage> <mode value="sender" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-validation" /> </supportedMessage> <supportedMessage> <mode value="sender" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-interim" /> </supportedMessage> <supportedMessage> <mode value="sender" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-full" /> </supportedMessage> <supportedMessage> <mode value="sender" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral" /> </supportedMessage> <supportedMessage> <mode value="sender" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral" /> </supportedMessage> <supportedMessage> <mode value="sender" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request" /> </supportedMessage> <supportedMessage> <mode value="receiver" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-validation" /> </supportedMessage> <supportedMessage> <mode value="receiver" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-interim" /> </supportedMessage> <supportedMessage> <mode value="receiver" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-validation-full" /> </supportedMessage> <supportedMessage> <mode value="receiver" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral" /> </supportedMessage> <supportedMessage> <mode value="receiver" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral" /> </supportedMessage> <supportedMessage> <mode value="receiver" /> <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request" /> </supportedMessage> </messaging> </CapabilityStatement>
JSON
{ "resourceType": "CapabilityStatement", "id": "45bcbe62-718b-4874-a68c-b0fe39a76cf5", "status": "active", "experimental": true, "date": "2022-06-29", "publisher": "NHS Digital", "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" }, "implementation": { "description": "NHS Digital Message endpoint", "url": "https://fhir.nhs.uk/fhir/message-drop" }, "fhirVersion": "4.0.1", "format": [ "xml", "json" ], "messaging": [ { "endpoint": [ { "protocol": { "system": "http://terminology.hl7.org/CodeSystem/message-transport", "code": "mllp" }, "address": "mllp:10.1.1.10:9234" } ], "reliableCache": 30, "documentation": "ADT A08 equivalent for external system notifications", "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-booking-request" }, { "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-booking-request" } ] } ] }