diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md index 83184adc..e3557b6c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md @@ -4,30 +4,30 @@ topic: Analysis # {{page-title}} -The information in section will help you prepare to build, test and assure your product to use the Booking and Referral Standard. +This section provides technical information to support suppliers in effectively implementing BaRS.
-{{pagelink:Analysis-BaRS-Principles-and-Prerequisites, text:BaRS Principles and Prerequisites}} +{{pagelink:principles_prerequesites, text:BaRS Principles and Prerequisites}}
-{{pagelink:Analysis-Infrastructure, text:Infrastructure}} +{{pagelink:infrastructure, text:Infrastructure}}
-{{pagelink:Analysis-RolesAndResponsibilities, text:Roles and Responsibilities}} +{{pagelink:roles-and-responsibilities, text:Roles and Responsibilities}}
-{{pagelink:Analysis-Releases, text:Releases}} +{{pagelink:releases, text:Releases}}
-{{pagelink:Analysis-Versioning, text:Versioning}} +{{pagelink:version-negotiation, text:Versioning}}
-{{pagelink:Analysis-Content-Negotiation, text:Content Negotiation}} +{{pagelink:core-content-negotiation, text:Content Negotiation}}
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md index 8feabc60..3cfd1582 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md @@ -5,6 +5,12 @@ | Change | Description | |---------------------------------------|---------------------------------------------------------------------------------------------------------| | Bug fixes and corrections |There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.| +| About BaRS renamed to Analysis |Following user research into the experience of using the Implementation Guide, About BaRS is renamed Analysis to support users to locate information they need.| +| Home page |The Home page is restructured to include a step by step guide that supports users to identify where they are in the implementation process.| +| FHIR Assets |Content about FHIR formerly in the About BaRS section about is relocated to the FHIR Assets page.| +| Roles and Responsibilities |Roles and Responsibilities content formerly in the Deploy section is relocated as a specific page in the Analysis section.| +| Infrastructure |Content about Infrastructure formerly in the About BaRS section about is relocated on a specific page in the Analysis section.| +| Contact Us |Improved content added in Help and Support with additional contact details for Digital Onboarding Service and Toolkit Work Bench queries.|
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/RolesAndResponsibilities.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/RolesAndResponsibilities.md index e38c9cab..3529b40c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/RolesAndResponsibilities.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/RolesAndResponsibilities.md @@ -1,3 +1,7 @@ +--- +topic: roles-and-responsibilities +--- + ## {{page-title}} Roles and responsibilities for each involved party are described below. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md index 6b178574..0cc0d7b9 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md @@ -31,18 +31,23 @@ topic: Application8 This application supports the use of the following use cases: -| Use Case | Name | Code | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------| -| Referrals from A&G into eRS | A&G to eRS | a8t1 | +|Use case | Name | Code| +|--------------------------------------------------------------------------------|------|------| +| Improved Advice and Guidance to electronic-Referral Service (e-RS)| IAG to e-RS | A8T1 | +| 111Online to electronic-Referral Service (e-RS)| 111online to e-RS | A8T2 | +| NHS.UK to electronic-Referral Service (e-RS)| nhs.uk to e-RS | A8T3 | ## Introduction ### Overview -This page provides guidance for implementing the Referral Standard (BaRS) specifically for the use cases listed above. It should be used alongside the {{pagelink:design-core-1.0.7, text:BaRS Core implementation guide}} and API Specification when developing to the standard. +This page provides guidance for implementing the Referral Standard (BaRS) specifically for the use cases listed above. It should be used alongside the {{pagelink:design-core-1.3.1, text:BaRS Core implementation guide}} and API Specification when developing to the standard. ### Data model endorsements -TBC +NHS England teams within Referrals and Appointments, Digitial Urgent and Emergency Care and the National Pathway for Self-Referrals have co-produced the Application 8 standard to facilitate interoperability between existing systems for referral pathways. + +This page provides guidance for implementing the Referral Standard (BaRS) specifically for the use cases listed above. It should be used alongside the {{pagelink:design-core-1.3.1, text:BaRS Core implementation guide}} and Payload Definitions when developing to the standard. +
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md index 4e26934e..793eee49 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md @@ -6,49 +6,65 @@ TOPIC: APP8-ScopeAndRequirements ### Scope Overview This BaRS Application (Referrals from Advice and Guidance to eRS broker, Application 8) supports the following use case(s) ONLY: -- Advice and Guidance referring into eRS +* Improved Advice and Guidance to electronic-Referral Service (e-RS) +* 111Online to electronic-Referral Service (e-RS) +* NHS.UK to electronic-Referral Service (e-RS) -The payload and workflow have been designed to support this service. Other {{pagelink:applications, text:BaRS Applications}} offer scope for alternative use cases. + + +The payload and workflow have been designed to support these services. Other {{pagelink:applications, text:BaRS Applications}} offer scope for alternative use cases. ### Functional Scope -**Directing the referral (without Service Discovery)** -- Direct to eRS static value + +**Service Discovery** +- Establishing a service, or service shortlist, for onward care is a mandatory step in the workflow + + +**Directing the referral (independent of Service Discovery)** +- Direct to predefined value representing the broker **Referral** - A referral in this Application is a request for care, on behalf of an individual, from a sending service to a broker - The referral can be sent without having to establish the capacity of the receiving service - The referral will contain primarily clinical information, indicating the need of the individual and **must** state the anticipated action required by the receiving service (see Task FHIR resource) - A list of healthcare services which can support the patient/client need are offered to the broker to direct the next step in care +* Supporting information, other than the assessment, is expected to be included in a referral, if collected, including: + * new or existing safeguarding concerns + * locally held Special Patient Notes + * external information sources used during initial assessment prior to referral + * timing information to support the timely delivery of care and reporting + **API-M** - All requests and responses associated with BaRS must occur through the BaRS API Proxy **Constraints** - No guidance is provided on the display of referral information beyond the {{pagelink:principles_prerequesites, text:Principles for rendering BaRS Payload}} -- Consent within BaRS will be for Direct-Care only +- BaRS currently supports the communication of consent for direct care only - Certificates for Receiving messages to use nhs.uk domains only - Receiving endpoints are to be internet facing - Clincial Constraints exist - See Hazard Log - No element level 'updates' to requests are supported. A new request must be generated to change information in the referral request - No digital support to remove or cancel a referral are offered (this would need to be achieved manually) -- Where an Online Consultation or other self assessment tool is used to refer, the referral must be verified by a human representative of the sending organisation before the request is made +- The service discovery tool for establishing services for onward care must be the [e-RS Service Search API A010](https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir#post-/STU3/HealthcareService/$ers.searchHealthcareServicesForPatient) ### Requirements -**Directing a referral** -- The service **must** support a unique identifier which the Sender is configured with to engage in the BaRS referral workflow +**Service Discovery** +- Where more than one service is shortlisted, the maximum number of services allowed on a given shortlist is 20. -**Referral** -- TBC - -**Contacts** -- A minimum of one contact (patient or third party) with a contact method (phone, email, etc.) of phone **must** be provided in referral requests -- All contacts **must** have a rank associated with them -- There **must** be only one contact with a rank of 1 -- All contacts **must** have at least one contact method (phone, email, etc.) -- All contact methods **must** have a rank -- There **must** be only one contact method with a rank of 1 -- The contact ranked 1 and the contact method ranked 1 **must** be the primary callback for the request +**Referral** +- The referral Receiver **must** accept the referral request regardless of whether the patient is known to the service provider +- The referral Receiver **must** only accept potential patients who do **have** a national validated identifier e.g. NHS Number +- The national identifier **must** have a [verification status](https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-nhsnumberverificationstatus) of 'Number present and verified' otherwise, the referral Sender **must not** include it in the request +- Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral Sender's request +- The referral Receiver **must** clearly identify any included safeguarding concern to the end user +- The referral Receiver **must** accurately represent information made by the Sender to the end user. +- The referral Sender **must** make available the human readable identifier for the referral, included in the HTTP synchronous response, to the end user +- Where the referral was not successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.1, text:failure scenarios}} for more detail +- Where the referral was not successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.3.1, text:failure scenarios}} for more detail +- The referral Sender **must** indicate consent to share (for Direct Care) to the Receiver +- The referral Sender **must** indicate the urgency (using the agreed codeset) of the request to the Receiver ### Audit diff --git a/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md index 32b2a445..551262ec 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md @@ -6,7 +6,7 @@ topic: fhir_assets
-The complete directory of FHIR assets can be found on the Booking and Referrals simplifier project page +The complete directory of FHIR assets can be found on [the Booking and Referrals simplifier project page](https://simplifier.net/NHSBookingandReferrals/~introduction). **Profiles** diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs/Index.guide.md similarity index 77% rename from guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs.guide.md rename to guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs/Index.guide.md index 620dade2..8776ace9 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs/Index.guide.md @@ -1,5 +1,5 @@ --- -topic: +topic: contactus --- @@ -13,9 +13,9 @@ Use our booking and referral standard [enquiry form](https://digital.nhs.uk/serv ### Test and assurance enquiries -[Create an account](https://onboarding.prod.api.platform.nhs.uk) for the Digital Onboarding Service to start assurance. For queries relating to your account or the service email () +[Create an account](https://onboarding.prod.api.platform.nhs.uk) for the Digital Onboarding Service to start assurance. For queries relating to your account or the service email -For any queries relating to toolkit workbench (TKW) email () +For any queries relating to toolkit workbench (TKW) email ### Amending appointments If you're a patient looking to book, change or cancel appointments please contact the service directly. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs/toc.yaml new file mode 100644 index 00000000..7f8a26c4 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs/toc.yaml @@ -0,0 +1,2 @@ +- name: Index + filename: Index.guide.md diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads/Index.guide.md similarity index 90% rename from guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads.guide.md rename to guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads/Index.guide.md index dc3f6c1f..573750a9 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads/Index.guide.md @@ -1,7 +1,12 @@ +--- +topic: downloads +--- + ## Downloads This page gives a link to download the FHIR assets as a downloadable package. It may be specific to the specification or be a snapshot of the UK Core FHIR assets. BARS Package: https://simplifier.net/packages/uk.nhsdigital.bars.r4/ -BARS Project Resources: https://simplifier.net/nhsbookingandreferrals \ No newline at end of file +BARS Project Resources: https://simplifier.net/nhsbookingandreferrals + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads/toc.yaml new file mode 100644 index 00000000..7f8a26c4 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Downloads/toc.yaml @@ -0,0 +1,2 @@ +- name: Index + filename: Index.guide.md diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md similarity index 98% rename from guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary.guide.md rename to guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md index d7b54d4b..479c4787 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md @@ -1,3 +1,7 @@ +--- +topic: glossary +--- + ## Glossary

diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/toc.yaml new file mode 100644 index 00000000..7f8a26c4 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/toc.yaml @@ -0,0 +1,2 @@ +- name: Index + filename: Index.guide.md diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Howtousethisimplementationguide.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/HowToUseThisImplementationGuide/Index.guide.md similarity index 99% rename from guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Howtousethisimplementationguide.guide.md rename to guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/HowToUseThisImplementationGuide/Index.guide.md index 634e836b..822e7c07 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Howtousethisimplementationguide.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/HowToUseThisImplementationGuide/Index.guide.md @@ -1,3 +1,7 @@ +--- +topic: howtousethisimplementationguide +--- + ## How to use this Implementation Guide @@ -94,3 +98,5 @@ Note: not all pages described in the table will be present in every implementati + + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/HowToUseThisImplementationGuide/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/HowToUseThisImplementationGuide/toc.yaml new file mode 100644 index 00000000..7f8a26c4 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/HowToUseThisImplementationGuide/toc.yaml @@ -0,0 +1,2 @@ +- name: Index + filename: Index.guide.md diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportanIncident.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportAnIncident/Index.guide.md similarity index 97% rename from guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportanIncident.guide.md rename to guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportAnIncident/Index.guide.md index bc02389d..a01888d1 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportanIncident.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportAnIncident/Index.guide.md @@ -1,3 +1,7 @@ +--- +topic: reportanincident +--- + ## Report an incident @@ -18,4 +22,5 @@ Suppliers can also raise an incident directly from [My developer Hub](https://id ### National Service Status (HSCN connection needed) -View the [status of all our services and sign up for national service updates](https://nww.digital.nhs.uk/servicemanagement/status/) \ No newline at end of file +View the [status of all our services and sign up for national service updates](https://nww.digital.nhs.uk/servicemanagement/status/) + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportAnIncident/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportAnIncident/toc.yaml new file mode 100644 index 00000000..7f8a26c4 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ReportAnIncident/toc.yaml @@ -0,0 +1,2 @@ +- name: Index + filename: Index.guide.md diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml index 1bed6b05..2f033226 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml @@ -1,10 +1,10 @@ - name: Contact Us - filename: ContactUs.guide.md -- name: How to use this implementation guide - filename: Howtousethisimplementationguide.guide.md + filename: ContactUs +- name: How to use this Implementation Guide + filename: HowToUseThisImplementationGuide - name: Glossary - filename: Glossary.guide.md + filename: Glossary - name: Downloads - filename: Downloads.guide.md + filename: Downloads - name: Report an Incident - filename: ReportanIncident.guide.md \ No newline at end of file + filename: ReportanIncident \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html index f936f1d1..072f69af 100644 --- a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html +++ b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html @@ -364,9 +364,8 @@ FHIR Version: {{ guide-fhir-version }}

- Privacy Policy   + Privacy and Cookie Policy   - Cookie Policy