IG 1.10.0 Merge to Main

guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md

@@ -27,7 +27,7 @@ topic: Application5
 
 </div>
 
-
+Any suppliers building to this application (Application 5) must engage with NHS England's Pharmacy First/DSIC teams prior to building application 5.
 
 ## Use Cases Supported
 

guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md

@@ -0,0 +1,83 @@
+---
+topic: Connect-as-a-receiver
+---
+
+## {{page-title}}
+
+BaRS uses TLS-MA to communicate with Receiving endpoints. Receiving endpoints need a certificate under the NHS Root CA to facilitate TLS-MA.  The receiver needs to follow these steps to access Integration (INT) and Production (PROD) environments.
+
+To connect to the BaRS proxy as a receiver follow these steps:
+
+Step 1: Apply for your domain [apply for a new nhs.uk domain](https://digital.nhs.uk/services/networking-addressing/apply-for-an-nhs.uk-domain-for-websites-and-web-applications).  You must complete Section 5: For website or application records visible on the public internet.
+
+Step 2: Request a certificate under the NHS Root CA. The FQDN must be an nhs.uk address.
+    * There are different certificate chains for INT and PROD
+    * [INT Certificate](https://digital.nhs.uk/services/path-to-live-environments/integration-environment#rootca-and-subca-certificates) chains (**Note:** _these may be out of date_)
+    * [PROD Certificate](https://digital.nhs.uk/services/path-to-live-environments/live-environment) chains (**Note:** _these may be out of date_)stered, you can then begin the process to obtain your certificate by generating a certificate request.
+The fully qualified domain name (FQDN) is equal to the certificate name (CN) by convention.
+
+Step 3: Create a Certificate Signing Request (*.csr). This is the file you will send to us so we can generate a signed certificate for your endpoints. Create a private key; a password is optional.
+```
+openssl genpkey -algorithm RSA -out private.key -aes256
+```
+Create the *.csr, use the following command:</br>
+**Note:** <small>_Generate the CSR with only the common name field populated, which must match the FQDN. All other fields can remain blank. The email field MUST be blank. Please note FQDNs MUST be in the .nhs.uk domain as we can only issue certificates in this domain._</small>
+```
+openssl req -new -key private.key -out request.csr
+```
+
+Step 4: Send the .csr file to be signed by NHS England and get the client certificate. To do this, follow these environment specific steps:
+
+#### Client certificate: Integration (INT)
+Step 1: Contact ITOC to make a [Combined endpoint and service registration request](https://digital.nhs.uk/services/path-to-live-environments/path-to-live-forms/combined-endpoint-and-service-registration-request) 
+     {{render:Onboarding FORM.png}}
+    In the form:
+    * Select Create/renew a certificate only (No endpoint)
+    * Specify Integration environment
+    * FQDN must match your domain and CN on the cert e.g. '**BaRS-INT-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**'
+    * In Additional comments/notes, state ‘BaRS’ certificate request
+    * Add ‘N/A’ in the Party Key field because there is no relation to SDS endpoints
+Step 2: Receive certificate from ITOC
+Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue
+
+#### Client certificate: Production (PROD)
+**Production endpoints can only be requested when Solution Assurance issue the supplier with the Technical Conformance certificate** 
+Step1: Send the .csr to <dir@nhs.net>, indicating this is for a BaRS Receiver endpoint
+    * Format for FQDN on PROD for:
+        * Supplier hosted solutions is ‘**BaRS-PROD-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**’
+            * This option is used for multi-tenanted solutions.
+        * Service Provider hosted solutions is ‘**BaRS-PROD-\<ODS Code\>.\<Provider name\>.nhs.uk**’
+            * This option is used for non multi-tenanted solutions. If multiple endpoints are needed, the ODS code can be appended with an identifier for the setting.
+            * It may be that the provider already has a 'nhs.uk' standard domain DNS entry. If one exists, it should be used for this new subdomain.
+Step 2: Receive certificate from DIR Team
+Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue
+Step 4: Make changes to your [firewall exceptions](https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Deploy/Technical-deployment\Firewallexceptions) to receive messages from the BaRS proxy.
+
+#### Installing and configuring your application to use the certificate
+Step 1: INT and PROD copy the cert text inlcuding `-----BEGIN CERTIFICATE` as the first line and `END CERTIFICATE-----` as the last. Save this text locally as a file called barsinreceiver.cer (change the name to suit).
+
+Step 2: Create a .pfx file so you can serve HTTPS (TLS) endpoints. You can use the command below to export a *.pfx file from the *.key file you made earlier (when you made the *.csr file) along with the *.cer file you were emailed.
+
+```
+openssl pkcs12 -export -out barsintreceiver.pfx -inkey barsintreceiver.key -in barsintreceiver.cer
+```
+
+Step 3: Create a password for your .pfx file. 
+
+Step 4: Make configuration changes to reference the *.pfx file and password
+
+(C# example, Other launguages will vary but be similar)
+
+``` c#
+
+// Configure Kestrel to use the certificate
+builder.WebHost.ConfigureKestrel(options =>
+{
+    options.ListenAnyIP(8080, listenOptions =>
+    {
+        listenOptions.UseHttps(certPath, certPassword);
+    });
+});
+
+```
+

guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-sender.page.md

@@ -0,0 +1,19 @@
+---
+topic: connect-as-a-sender
+---
+
+## {{page-title}}
+
+API-M provides the [security model](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) for BaRS. 
+
+To connect to the BaRS proxy as a sender follow these steps:
+
+Step 1: follow the NHS Developer authenitication and authorisation process [NHS Developer authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-login-separate-authentication-and-authorisation#step-1-register-your-application-with-nhs-login)
+
+Step 2: trust the Certificate Authorities (CA) mentioned below. For INT this will be downloadable from http://pki.nhs.uk/int/G2/auth/NHSINTAuthG2.crt 
+( you can examine the .cer file if you have one )
+```
+openssl x509 -in barsintreceiver.cer -text -noout
+```
+
+

guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Onboarding.page.md

@@ -4,119 +4,9 @@ topic: onboarding
 
 ## {{page-title}}
 
-API-M provides the [security model](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) for BaRS. 
-
-There are two roles: Sender and Receiver. Most BaRS Applications will require a solution to support both roles, despite being predominantly one or the other, because of the response workflow steps. In response flows, the original Sender becomes a Receiver and the original Receiver becomes a Sender. 
+In each BaRS workflow there are two roles: Sender and Receiver. In applications with response workflows, both parties act as a Sender and a Receiver, and will need to follow the instructions to connect to environments as both. 
 
 The Sender obtains a token from the API-M platform to make requests of the BaRS API Proxy, which brokers the request through the Receiver, secured via TLS-MA (Transport Layer Security-Mutual Authentication).
 
 BaRS is based on internet-first principles and there is no requirement for [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network) connectivity.
 
-### Sender
-* [Follow the steps here to get set up](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-login-separate-authentication-and-authorisation#step-1-register-your-application-with-nhs-login)
-
-The sender will also need to trust the Certificate Authorities mentioned below. For INT this will be downloadable from http://pki.nhs.uk/int/G2/auth/NHSINTAuthG2.crt 
-( you can examine the .cer file if you have one )
-```
-openssl x509 -in barsintreceiver.cer -text -noout
-```
-### Some commands that might help to get the Root CA and chain
-
-To get a cert from an endpoint
-```
-openssl s_client -showcerts -connect BaRS-INT-X26.BarsReceiver.thirdparty.nhs.uk:443 < /dev/null | openssl x509 -outform PEM > server-cert.pem
-```
-Then to list info from the .pem
-```
-openssl x509 -in server-cert.pem -text -noout
-```
-
-You can use the output from this command to get the full CA chain.
-
-```
-sudo cp ca-chain.pem /usr/local/share/ca-certificates/ sudo update-ca-certificates
-```
-
-This will ensure that your system trusts the certificates issued by the CA.
-
-
-### Receiver 
-BaRS will utilise TLS-MA to communicate with Receiving endpoints. Receiving endpoints will require a certificate under the NHS Root CA to facilitate TLS-MA.
-
-* The receiver must request a certificate under the NHS Root CA
-    * There are different certificate chains for INT and Prod
-    * [INT Certificate](https://digital.nhs.uk/services/path-to-live-environments/integration-environment#rootca-and-subca-certificates) chains (**Note:** _these may be out of date_)
-    * [Prod Certificate](https://digital.nhs.uk/services/path-to-live-environments/live-environment) chains (**Note:** _these may be out of date_)
-* The receiving endpoint will present the certificate obtained for TLS-MA
-* The receiving endpoint will need to trust the Root CAs and SubCAs for their respective environments
-* The receiving endpoint will only accept requests presented with certificates from their respective chains
-
-As the certificates are using the NHS Root CA, the FQDN must be an nhs.uk address. This is the case for both INT and Prod.
-
-You can apply for your domain [here](https://digital.nhs.uk/services/networking-addressing/apply-for-an-nhs.uk-domain-for-websites-and-web-applications), ensuring that you complete Section 5: For website or application records visible on the public internet.
-
-Once you have your domain registered, you can then begin the process to obtain your certificate by generating a certificate request.
-
-Certificate requests will need to be signed for your endpoint. Note that the fully qualified domain (FQDN) name is equal to the certificate name (CN) by convention.
-
-You need to create a Certificate Signing Request (*.csr). This is the file you will send to us so we can generate a signed certificate for your endpoints. The first step is to create a private key; a password is optional.
-```
-openssl genpkey -algorithm RSA -out private.key -aes256
-```
-Then, to create the *.csr, use the following command:</br>
-**Note:** <small>_Generate the CSR with only the common name field populated, which must match the FQDN. All other fields can remain blank. The email field MUST be blank. Please note FQDNs MUST be in the .nhs.uk domain as we can only issue certificates in this domain._</small>
-```
-openssl req -new -key private.key -out request.csr
-```
-
-At this point, you should have a .key and a .csr file. The next step will be to send the .csr file to be signed by the NHS and get the client certificate. For full steps, see the sections below for each environment.
-
-#### Integration (INT)
-* [Request](https://digital.nhs.uk/services/path-to-live-environments/path-to-live-forms/combined-endpoint-and-service-registration-request) a ‘certificate only’ from ITOC
-    * {{render:Onboarding FORM.png}}
-    * Certificate Only (No endpoint)
-    * Integration environment
-    * FQDN must match your domain and CN on the cert e.g. '**BaRS-INT-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**'
-    * Ensure it is clear this is a request for a ‘BaRS’ certificate
-    * ‘N/A’ in the Party Key section because there is no relation to SDS endpoints
-* Receive certificate from ITOC
-* Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue
-
-#### Production (Prod)
-* Once Solution Assurance issues the supplier with the Technical Conformance certificate, Production endpoints can be requested
-* Send the .csr to <dir@nhs.net>, indicating this is for a BaRS Receiver endpoint
-    * Format for FQDN on PROD for:
-        * Supplier hosted solutions is ‘**BaRS-PROD-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**’
-            * This option is used for multi-tenanted solutions.
-        * Service Provider hosted solutions is ‘**BaRS-PROD-\<ODS Code\>.\<Provider name\>.nhs.uk**’
-            * This option is used for non multi-tenanted solutions. If multiple endpoints are needed, the ODS code can be appended with an identifier for the setting.
-            * It may be that the provider already has a 'nhs.uk' standard domain DNS entry. If one exists, it should be used for this new subdomain.
-* Receive certificate from DIR Team
-* Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue
-
-**Note:** <span style="color:red">**Receiver Firewall Amendments**</span> - Requests from the BaRS API Proxy will originate from **INT** on **35.197.254.55** & **35.246.55.143** and **PROD** on **34.89.0.111** & **34.89.69.6**.
-
-Once you have the certificate from the NHS service desk, copy the text for the cert with the `-----BEGIN CERTIFICATE` as the first line and `END CERTIFICATE-----` as the last. Save this text locally as a file called barsinreceiver.cer (change the name to suit).
-
-You will probably need to make a .pfx file so you can serve HTTPS (TLS) endpoints. You can use the command below to export a *.pfx file from the *.key file you made earlier (when you made the *.csr file) along with the *.cer file you were emailed.
-
-```
-openssl pkcs12 -export -out barsintreceiver.pfx -inkey barsintreceiver.key -in barsintreceiver.cer
-```
-
-You will be prompted for a password for your .pfx file. You will need to use this password along with the .pfx file.
-
-Once you have the *.pfx file you can use it the following way (C# example, Other launguages will vary but be similar)
-
-``` c#
-
-// Configure Kestrel to use the certificate
-builder.WebHost.ConfigureKestrel(options =>
-{
-    options.ListenAnyIP(8080, listenOptions =>
-    {
-        listenOptions.UseHttps(certPath, certPassword);
-    });
-});
-
-```

guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/toc.yaml

@@ -2,7 +2,11 @@
   filename: Index.page.md
 - name: Environments
   filename: Environments.page.md
-- name: Onboarding
+- name: Connecting to environments
   filename: Onboarding.page.md
+- name: Connect as a Sender
+  filename: Connect-as-a-sender.page.md
+- name: Connect as a Receiver
+  filename: Connect-as-a-receiver.page.md
 - name: TKW
   filename: TKW.page.md

guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md

@@ -23,6 +23,7 @@ The Appointment Management Foundation is based on {{pagelink:design-core-1.3.1,
 The key functions surrounding appointment bookings are listed below. This section will provide information on how to meet them using the Appointment Resource.
 
 The ability to -
+* view
 * book 
 * update
 * cancel

guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md

@@ -13,7 +13,16 @@ Steps to Reschedule:
 * Select a new slot
 * Update the resource with the new slot. NB: Only the .slot element of the resource must be updated
 * Perform a [PATCH](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#patch-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}
-* Once processed, the Receiver of the booking must [update (PUT)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/DocumentReference/-id-) the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}}
+* Once processed, the Receiver of the booking must [update (PUT)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/DocumentReference/-id-) the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}}. The principle update to the pointer is to change the .context element to alter the slot time - 
+
+```json
+"context": {
+  "period": {
+    "start": "2025-02-12T12:30:30+00:00",
+    "end": "2025-02-12T12:40:30+00:00"
+  }
+}
+```
 
 
 In this example the Appointment resource is with the existing slot, and updated with the newly selected slot. 
@@ -82,4 +91,4 @@ Request Body
 	]
 }
 ```
-<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/BaRS_Foundation_Update.drawio.svg" ></img>
+<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/BaRS_Foundation_Reschedule.drawio.svg" ></img>

guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Update-Existing-Booking.page.md

@@ -22,6 +22,17 @@ resource returned:
 		]
 	},
 	"status": "booked",
+	"reasonCode": [
+		{
+			"coding": [
+				{
+					"system": "http://snomed.info/sct",
+					"code": "165342003",
+					"display": "Patient declined laboratory test (situation)"
+				}
+			]
+		}
+	],
 	"description": "Reason for calling",
 	"created": "2024-10-08T15:01:30+00:00",
 	"participant": [
@@ -53,8 +64,8 @@ Request Body
 			"coding": [
 				{
 					"system": "http://snomed.info/sct",
-					"code": "65363002",
-					"display": "Otitis media (disorder)"
+					"code": "165332000",
+					"display": "Laboratory test requested (situation)"
 				}
 			]
 		}

guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Introduction.page.md

@@ -5,7 +5,7 @@ topic: core-StandardPattern-document-reference-Introduction-1.3.1
 # Standard Pattern - DocumentReference
 
 <div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b>Important:  Release information</b>
-<p>This Section of the Implementation Guide is currently a preview, in an Alpha state and subject to change.</p>
+<p>This Section of the Implementation Guide is currently a preview, in an Alpha state and subject to change. There is only currently support for Appointment (booking) pointers.</p>
 </div>
 
 ## Introduction

guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md

@@ -83,6 +83,16 @@ The third identifier (currently optional) relates to the product-id, system '*ht
 	}
 ```
 
+**context:** MUST include a period set to the Appointment start and end times.
+
+```json
+"context": {
+  "period": {
+    "start": "2025-02-12T12:30:30+00:00",
+    "end": "2025-02-12T12:40:30+00:00"
+  }
+}
+```
 
 ### Step 3: Save and Transmit the DocumentReference (pointer)
 Once all the necessary fields are populated, perform a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/DocumentReference) of the DocumentReference to the /DocumentReference endpoint on the BaRS proxy. This will create a DocumentReference in the NRL.