diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/About-BaRS/Quick-Start-Guide.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/About-BaRS/Quick-Start-Guide.page.md index 1788bc42..070ec24b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/About-BaRS/Quick-Start-Guide.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/About-BaRS/Quick-Start-Guide.page.md @@ -11,7 +11,7 @@ We recommend reading the following documentation as part of the discovery stage * [BaRS FHIR API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) ### Onboarding -{{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text:Onboarding}} with our platform is a self-service process. This step is required to make requests of the BaRS API and have requests forwarded to your endpoint, as a Receiver. This **must** occur on both Integration (INT) and Production environments. The {{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text: full step-by-step onboarding guide}} can be followed by any solution on either environment. +{{pagelink:Testing-and-Environments, text:Connecting to environments}} on our platform is a self-service process. This step is required to make requests of the BaRS API and have requests forwarded to your endpoint, as a Receiver. This **must** occur on both Integration (INT) and Production environments. Full details of the security model adopted by the platform can be found under the [security](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) section. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/BaRS-Principles-and-Prerequisites/Principles-and-prerequisites.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/BaRS-Principles-and-Prerequisites/Principles-and-prerequisites.page.md index 0f341134..f7f3eabc 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/BaRS-Principles-and-Prerequisites/Principles-and-prerequisites.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/BaRS-Principles-and-Prerequisites/Principles-and-prerequisites.page.md @@ -26,7 +26,7 @@ This page describes BaRS principles and prerequisites for suppliers. Elements of 3. Systems MUST support JSON formats for all API interactions 4. Systems SHOULD have a FHIR Server or FHIR functionality in place 5. Systems SHOULD implement RESTful behaviour patterns -6. System Suppliers MUST complete the {{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text:BaRS onboarding process}} +6. System Suppliers MUST complete the {{pagelink:Testing-and-Environments, text:BaRS connecting to environments process}} 7. Systems MUST support Service Discovery
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.10.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.10.0.page.md index 3354a34c..64c28d77 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.10.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.10.0.page.md @@ -1,3 +1,6 @@ +
+ +
### 1.10.0 ## Implementation Guide Changes @@ -10,7 +13,11 @@ | Assure |Provided clarity on the expectations and limitation of the assurance process.| | Testing and environments |Onboarding renamed to Connecting to environments. Specific sections created for Connecting as a sender and Connecting as a receiver to make navigation easier and give step by step guidance. +

+

+
+
-### Previous Releases + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md new file mode 100644 index 00000000..8feabc60 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.11.0.page.md @@ -0,0 +1,12 @@ +### 1.11.0 + +## Implementation Guide Changes + +| Change | Description | +|---------------------------------------|---------------------------------------------------------------------------------------------------------| +| Bug fixes and corrections |There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.| + +
+
+ +### Previous Releases diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/toc.yaml index 7a56c1e6..58d65f6b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/toc.yaml @@ -1,5 +1,7 @@ - name: Index filename: Index.page.md +- name: 1.11.0 + filename: 1.11.0.page.md - name: 1.10.0 filename: 1.10.0.page.md - name: 1.9.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md index 12490805..c16040c6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md @@ -1,3 +1,6 @@ +
+
+ ## {{page-title}} This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.0-beta.6 @@ -11,8 +14,6 @@ This is a minor "patch" with clarifications to limited areas of the Implementati |-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| | | FHIR BaRS CodeSystem values added for Location Types | Values for Helimed From and Helimed To added | non-breaking | -| FHIR BaRS CodeSystem value added for Flag Categories | Value for Call Warning added | non-breaking | -| Updated FHIR Questionnaire and QuestionnaireResponse guidance | Guidance updated to reflect Nature of Call published Questionnaire being removed for beta | non-breaking | ### Payload Change Log @@ -20,11 +21,9 @@ This is a minor "patch" with clarifications to limited areas of the Implementati | FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | |------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| | QuestionnaireResponse.extension.valueCodeableConcept.text | This SHOULD be populated with the name of the questionnaire responses contained within. | This SHOULD be populated with the name of the questionnaire responses contained within. For the Nature-of-call response this MUST be set to 'Nature of Call (NOC)' | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | non-breaking | -| QuestionnaireResponse.questionnaire | Example updated - https://fhir.nhs.uk/Questionnaire/NOC | Example updated - https://fhir.nhs.uk/Questionnaire/PTS | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | non-breaking | -| QuestionnaireResponse.questionnaire | Necessity Updated - MUST | Necessity Updated - MAY | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | non-breaking | +
+

- -### Previous Releases \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md new file mode 100644 index 00000000..66dc9142 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md @@ -0,0 +1,29 @@ +## {{page-title}} +This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.0-beta.7 + +### Application Change Log + + +
+ + +| Change | Description | Impact | +|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| +| +| Implementation guidance updated | patient.id implementation guidance corrected | correction | + + +### Payload Change Log + + +| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | +|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| +| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Request |Bug fix | correction | +| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Response |Bug fix | correction | + + + +
+
+ +### Previous Releases \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/toc.yaml index 6483f7a3..b84064b5 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/toc.yaml @@ -1,5 +1,7 @@ - name: Index filename: Index.page.md +- name: 1.0.0-beta.7 + filename: 1.0.0-beta.7.page.md - name: 1.0.0-beta.6 filename: 1.0.0-beta.6.page.md - name: 1.0.0-beta.5 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md index d844892c..197bb24f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md @@ -232,7 +232,7 @@ This payload is used to transmit all the necessary information that is required | Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | |------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------| | Patient | This resource is used to communicate details about the patient who is the subject of the referral.
It also includes contact information for third parties when required.

https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | | -| Patient.id | It also includes contact information for third parties when required. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | +| Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | | Patient.meta | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | MUST | 1..1 | | | Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient | | Patient.meta.LastUpdate | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md index 1e5849d2..c89420f6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md @@ -194,7 +194,7 @@ ONLY) | Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | |------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | | -| Patient.id | It also includes contact information for third parties when required. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | +| Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | | Patient.meta | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | MUST | 1..1 | | | Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient | | Patient.meta.LastUpdate | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Certificates.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Certificates.page.md index 330a586a..72fc620f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Certificates.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Certificates.page.md @@ -7,7 +7,7 @@ The BaRS API and supplier solution will be secured by HTTPS/TLS, for both inboun In order to establish a connection to and from any environment, a chain of trust must be set up using the certificates detailed below. -For information on obtaining certificates as a Receiver see the {{pagelink:onboarding}} section. +For information on obtaining certificates as a Receiver see the {{pagelink:Testing-and-Environments, text: Connect as a receiver}} section. ## Inbound diff --git a/guides/Live-ImplementationGuide-BaRS/guide.yaml b/guides/Live-ImplementationGuide-BaRS/guide.yaml index 85bed2b9..f1478627 100644 --- a/guides/Live-ImplementationGuide-BaRS/guide.yaml +++ b/guides/Live-ImplementationGuide-BaRS/guide.yaml @@ -1,5 +1,5 @@ title: NHS Booking and Referral Standard description: FHIR Implementation Guide for the NHS Booking and Referral Standard -version: 1.10.0 +version: 1.11.0 style-root: project style-name: NHSD diff --git a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html index 67641b3e..f936f1d1 100644 --- a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html +++ b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html @@ -162,7 +162,7 @@ data-uipath="document.title"> {{guide-title}} -
Guide v{{ guide-version }} | Core v1.3.1 | Package v1.37.0
+
Guide v{{ guide-version }} | Core v1.3.1 | Package v1.38.0
diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md index 596d7df3..ae179835 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md @@ -231,7 +231,7 @@ This payload is used to transmit all the necessary information that is required | Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | |------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------| | Patient | This resource is used to communicate details about the patient who is the subject of the referral.
It also includes contact information for third parties when required.

https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | | -| Patient.id | It also includes contact information for third parties when required. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | +| Patient.id | It also includes contact information for third parties when required. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | | Patient.meta | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | MUST | 1..1 | | | Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient | | Patient.meta.LastUpdate | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |