diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md index 696524d8..83184adc 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md @@ -2,4 +2,32 @@ topic: Analysis --- -# {{page-title}} \ No newline at end of file +# {{page-title}} + +The information in section will help you prepare to build, test and assure your product to use the Booking and Referral Standard. + +
+ +{{pagelink:Analysis-BaRS-Principles-and-Prerequisites, text:BaRS Principles and Prerequisites}} + +
+ +{{pagelink:Analysis-Infrastructure, text:Infrastructure}} + +
+ +{{pagelink:Analysis-RolesAndResponsibilities, text:Roles and Responsibilities}} + +
+ +{{pagelink:Analysis-Releases, text:Releases}} + +
+ +{{pagelink:Analysis-Versioning, text:Versioning}} + +
+ +{{pagelink:Analysis-Content-Negotiation, text:Content Negotiation}} + +
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md index 3047bb26..992bea62 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md @@ -18,10 +18,6 @@ Components of BaRS centralised infrastructure are as follows: | Component | Description | |-----------------------|--------------| | BaRS Proxy API | Senders direct all requests to this Proxy API for all requests. | -| Endpoint catalogue | A component that holds service identifiers and their corresponding physical addresses. It is capable of supporting national and local directory of services or even standalone endpoints configured within a single system. Providers will be able to manag their endpoints via an API. | - - - - | +| Endpoint catalogue | A component that holds service identifiers and their corresponding physical addresses. It is capable of supporting national and local directory of services or even standalone endpoints configured within a single system. Providers will be able to manage their endpoints via an API. |
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml index bde58151..7e782147 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml @@ -4,7 +4,7 @@ filename: BaRS-Principles-and-Prerequisites - name: Infrastructure filename: Infrastructure -- name: Roles and responsibilities +- name: Roles and Responsibilities filename: RolesAndResponsibilities.md - name: Releases filename: Releases diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md index 7771dbec..cd7c0dad 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md @@ -57,7 +57,7 @@ When a BARS Receiver processes information in a Flag resource; * they **should** populate a flag in their system, if their solution supports that flag * they **must** display the information in the Flag resource in a way that supports the associated workflow (i.e. the relevant end users can see it and act upon it) -* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}. +* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payloads }}. ### Observation The Observation resource is used to carry assertions supporting the assessment performed by the Sender. In the BaRS UEC Applications, Senders **should** add clinical notes to the Careplan resource rather than Observation, especially where they expect a Receiver to act upon the information. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Payloads.page.md index f4850e03..dc626d0a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Payloads.page.md @@ -57,7 +57,7 @@ When a BARS Receiver processes information in a Flag resource; * they **should** populate a flag in their system, if their solution supports that flag * they **must** display the information in the Flag resource in a way that supports the associated workflow (i.e. the relevant end users can see it an act upon it) -* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}. +* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payloads }}. ### Observation The Observation resource is used to carry assertions supporting the assessment performed by the Sender. In the BaRS UEC Applications, Senders **should** add clinical notes to the Careplan resource rather than Observation, especially where they expect a Receiver to act upon the information. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md index 91150182..33c388a4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md @@ -53,7 +53,7 @@ When a BARS Receiver processes information in a Flag resource; * they **should** populate a flag in their system, if their solution supports that flag * they **must** display the information in the Flag resource in a way that supports the associated workflow (i.e. the relevant end users can see it and act upon it) -* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}. +* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payloads }}. ### Consent In the BaRS UEC Applications the level of consent is stipulated to be for 'Direct Care' only. A referral **must** contain a Consent resource and it **must** adhere to the [example](https://simplifier.net/NHSBookingandReferrals/8fc39b95-89a6-45fb-914f-1458a10e9e14/~json) provided under the BaRS FHIR assets. 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 12186e0f..32b2a445 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md @@ -1,9 +1,12 @@ +--- +topic: fhir_assets +--- -## FHIR Assets +## {{page-title}}
-The complete directory of FHIR assets can be found on the simplifier project page +The complete directory of FHIR assets can be found on the Booking and Referrals simplifier project page **Profiles** @@ -33,8 +36,8 @@ Message definitions are a key aspect of BaRS. They define the content of payload **Application** -BaRS Applications define workflows and payloads. They can support any number of use-cases with the same requirements. Suppliers build and are assured for specific Applications. As BaRS grows Applications are expected to include more use-cases, supporting re-use of both the BaRS Application and supplier development. +BaRS Applications define workflows and payloads. They can support any number of use-cases with the same requirements. Suppliers build and are assured for specific Applications. As BaRS grows, Applications are expected to include more use-cases, supporting re-use of both the BaRS Application and supplier development. -For further information and resouces regarding the FHIR standard see the [FHIR website](http://hl7.org/fhir/overview-dev.html). +For further information and resources regarding the FHIR standard see the [FHIR website](http://hl7.org/fhir/R4/overview-dev.html).
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs.guide.md new file mode 100644 index 00000000..620dade2 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/ContactUs.guide.md @@ -0,0 +1,22 @@ +--- +topic: +--- + + +## Contact us + +To ensure your enquiry is received and answered promptly please review the options below. + +### BaRS enquiries + +Use our booking and referral standard [enquiry form](https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form) to ask a question about the project, the standard, or simply to leave your feedback. + +### 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 () + +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/Index.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md index 93c8614b..6f2c484e 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md @@ -1,18 +1,5 @@ +--- +topic: Help +--- -## Contact us - -To ensure your enquiry is received and answered promptly please review the options below. - -### BaRS enquiries - -Use our booking and referral standard [enquiry form](https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form) to ask a question about the project, the standard, or simply to leave your feedback. - -### 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 () - -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/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml index 8a48ba14..1bed6b05 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml @@ -1,5 +1,5 @@ -- name: Index - filename: Index.guide.md +- name: Contact Us + filename: ContactUs.guide.md - name: How to use this implementation guide filename: Howtousethisimplementationguide.guide.md - name: Glossary