diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md index daf1998e..6dbc17ff 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md @@ -70,7 +70,7 @@ Step 2: Receive certificate from DIR Team Step 3: Email 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. +Step 4: Make changes to your {{pagelink:firewall-exceptions, text: firewall exceptions}} to receive messages from the BaRS proxy.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md index c017af5b..e9bf589c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md @@ -13,7 +13,7 @@ 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}}. The principle update to the pointer is to change the .context element to alter the slot time - +* 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 principal update to the pointer is to change the .context element to alter the slot time - ```json "context": { diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md index 88fe9b8c..0c4b307b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md @@ -38,7 +38,7 @@ The second identifier of note is the Receiving service who own the resource. The } ``` -The third identifier (currently optional) relates to the product-id, system '*https://fhir.nhs.uk/id/product-id*'. This is forth coming functionality and further detail on its utility will follow but [working documentation] (https://github.com/NHSDigital/nhse-epr-integration/blob/main/pages/appendix1.md) is being actively updated. +The third identifier (currently optional) relates to the product-id, system '*https://fhir.nhs.uk/id/product-id*'. This is forthcoming functionality and further detail on its utility will follow but [working documentation] (https://github.com/NHSDigital/nhse-epr-integration/blob/main/pages/appendix1.md) is being actively updated. ```json "identifier": [ @@ -103,14 +103,14 @@ After saving, the DocumentReference will be assigned a unique id (e.g., Document To ensure that the DocumentReference was created successfully, retrieve it using its [id](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference/-id-) or [search](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference) for it using relevant parameters. Make sure to validate the returned DocumentReference to confirm that all the contents are accurate. ### Updating a DocumentReference -A DocumentReference can be updated by performing a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/DocumentReference/-id-) request with the updated resource to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A Read operation must be performed prior to this to ensure that the new DocumentReference is the most up to date. +A DocumentReference can be updated by performing a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/DocumentReference/-id-) request with the updated resource to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A read operation must be performed prior to this to ensure that the new DocumentReference is the most up to date. **Note**: A Receiver can only update DocumentReference resources that they created and own. ### Delete a DocumentReference -A DocumentReference can be removed by performing a [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#delete-/DocumentReference/-id-) request to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A Read operation must be performed prior to this to ensure that the action is appropriate. +A DocumentReference can be removed by performing a [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#delete-/DocumentReference/-id-) request to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A read operation must be performed prior to this to ensure that the action is appropriate. -**Note**: A Receiver can only delete DocumentReference resources that they created and own. +**Note**: A Receiver can only delete DocumentReference resources they created and own. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md index 022c34eb..de867509 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md @@ -10,7 +10,7 @@ The FHIR DocumentReference resource represents a reference to a clinical documen ### Step 2: Search for the booking or referral pointer (DocumentReference) FHIR DocumentReference resources holding pointers for BaRS bookings and referrals are stored in a central Registry, within NRL (National Record Locator), as decribed above, and interrogated through the [BaRS API DocumentReference](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference). -To find a booking or referral location, you need to search for the appropriate DocumentReference resource from the Registry, using search parameters. It is mandatory to include the subject:identifier (the patient's NHS number), other parameters can be used to filter the response further e.g type of document (booking and referral). +To find a booking or referral location, you need to search for the appropriate DocumentReference resource from the Registry, using search parameters. It is mandatory to include the subject:identifier (the patient's NHS number). Other parameters can be used to filter the response further e.g type of document (booking and referral). ### Step 3: Inspect the booking or referral pointer (DocumentReference) Once you retrieve the Document Reference(s) (pointers) from the search, inspect the returned resources to identify the one you need. Look for relevant metadata, as described below, to confirm the correct resource. @@ -37,7 +37,7 @@ The second identifier, required to make the subsequent request for the booking o } ``` -The third identifier (currently optional) relates to the product-id, system '*https://fhir.nhs.uk/id/product-id*'. This is forth coming functionality and further detail on its utility will follow but [working documentation] (https://github.com/NHSDigital/nhse-epr-integration/blob/main/pages/appendix1.md) is being actively updated. +The third identifier (currently optional) relates to the product-id, system '*https://fhir.nhs.uk/id/product-id*'. This is forthcoming functionality and further detail on its utility will follow but [working documentation] (https://github.com/NHSDigital/nhse-epr-integration/blob/main/pages/appendix1.md) is being actively updated. ```json "identifier": [ diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md index 48726ed8..8e3d22a3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md @@ -1,3 +1,7 @@ +--- +topic: firewall-exceptions +--- + ## {{page-title}} BaRS receivers need to configure firewall exceptions for both Integration (INT) and Production (PROD) environments. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Technicaldeployment.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Technicaldeployment.page.md index cddd66d8..4871384b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Technicaldeployment.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Technicaldeployment.page.md @@ -21,6 +21,6 @@ This is an abbreviated deployment guide, focused exclusively on the technical st \* If a Sender is to receive an asynchronous response from the Receiver, as part of the defined workflow, they will also require a Service profile. This will need configuration in the {{pagelink:configure-endpoint-catalogue, text:Endpoint Catalogue}} too. -NB- These steps apply to connecting and configuring systems to both the Integration (INT) and Production (PROD) environment. +NB- These steps apply to connecting and configuring systems to both the Integration (INT) and Production (PROD) environments.