Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
topic: TRN-Core-1.3.1
---

## {{page-title}}

| Change | Description | Impact |
|------------------------------------------|----------------------------------------|---------------------------------|
| ... | ...| <mark style="background-color: Yellow">correction</mark> |

<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To support the workflows for this Application of the standard the operations tha

### Make a Referral

Making a referral for this Application follows the {{pagelink:core-SPComposites-1.3.0, text:standard pattern for BaRS composite operations}}.
Making a referral for this Application follows the {{pagelink:core-SPComposites-1.3.1, text:standard pattern for BaRS composite operations}}.

The Message Definition that defines this payload for this Application is: {{link:MessageDefinition-BARS-MessageDefinition-ServiceRequest-Request-Referral}}

Expand Down Expand Up @@ -86,7 +86,7 @@ X-Correlation-Id = <GUID_000002>

### Cancel a Referral

To cancel a referral this Application follows the {{pagelink:core-SPCancellation-1.3.0, text:standard pattern for BaRS cancellation}}.
To cancel a referral this Application follows the {{pagelink:core-SPCancellation-1.3.1, text:standard pattern for BaRS cancellation}}.

The Message Definition that defines the payload for this Application is: {{link:messagedefinition-barsmessagedefinitionservicerequestrequestcancelled}}

Expand Down Expand Up @@ -247,7 +247,7 @@ X-Correlation-Id = <GUID_00002>

### Make a booking

Making a booking for this Application follows the {{pagelink:Core-StandardPattern-1.3.0, text:standard pattern for BaRS operations}}.
Making a booking for this Application follows the {{pagelink:Core-StandardPattern-1.3.1, text:standard pattern for BaRS operations}}.

The Message Definition that defines this payload for this Application is: [BARS Message Definition - Booking Request](https://simplifier.net/nhsbookingandreferrals/messagedefinition-bars-messagedefinition-booking-request)

Expand Down Expand Up @@ -308,7 +308,7 @@ X-Correlation-Id = <GUID_00002>
```
### Cancel a Booking

To cancel a booking this Application follows the {{pagelink:core-SPCancellation-1.3.0, text:standard pattern for BaRS cancellation}}.
To cancel a booking this Application follows the {{pagelink:core-SPCancellation-1.3.1, text:standard pattern for BaRS cancellation}}.

The Message Definition that defines the payload for this Application is: [BARS Message Definition - Cancel Booking Request](https://simplifier.net/nhsbookingandreferrals/messagedefinition-barsmessagedefinitionbookingrequestcancelled)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ topic: APP1-Payloads
The specific guidance around the use of key FHIR resources is described below.

### MessageHeader Resource
{{pagelink:core-SPMessageHeader-1.3.0, text:Standard Patterns for BaRS Operations}} explains in detail how the **MessageHeader** resource **must** be used.
{{pagelink:core-SPMessageHeader-1.3.1, text:Standard Patterns for BaRS Operations}} explains in detail how the **MessageHeader** resource **must** be used.

The MessageHeader resource for the Booking Request should have the following resource elements set as follows:
* **MessageHeader.eventCoding** - **must** be populated with 'booking-request'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ The payloads and workflow have been designed to support these services. Other {{
* The booking Receiver **must** accept the booking request regardless of whether the patient is known to the service provider
* The booking Receiver **must** accept potential patients who do **<ins>not</ins>** have a national validated identifier e.g. NHS Number.
* Where a national identifier is included, it **must** be 'traced and verified', otherwise, the referral Sender **must <ins>not</ins>** include the national indentifier in the request
* Where the booking was <ins>not</ins> successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the booking was <ins>not</ins> successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the booking was <ins>not</ins> successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.1, text:failure scenarios}} for more detail.
* Where the booking was <ins>not</ins> 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.
* If included in the synchronous HTTP response, the booking Sender **must** make available the human readable identifier for the booking to the end user
* The booking Sender **must** send accompanying clinical information in a BaRS referral request
* The booking Sender **must** reference the booking in the BaRS referral request (where the booking is made first in the workflow)
Expand Down Expand Up @@ -131,8 +131,8 @@ The payloads and workflow have been designed to support these services. Other {{
* 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 <ins>not</ins> successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the referral was <ins>not</ins> successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the referral was <ins>not</ins> 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 <ins>not</ins> 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** include reference to any accompanying BaRS booking related to the referral
* The referral Sender's request **must** be referenced in the BaRS booking request (where the referral is made first in the workflow)
* The referral Receiver **must** link the explicitly related booking and referral requests
Expand Down Expand Up @@ -173,11 +173,11 @@ The payloads and workflow have been designed to support these services. Other {{
<br>

### Error Handling
* Suppliers **must** adhere to the {{pagelink:core-ErrorHandling-1.3.0, text:error handling guidance}}
* Suppliers **must** adhere to the {{pagelink:core-ErrorHandling-1.3.1, text:error handling guidance}}
<br>
<br>
### Non Functional
* Suppliers **must** adhere to the {{pagelink:core-NFR-1.3.0, text:non functional requirements}}
* Suppliers **must** adhere to the {{pagelink:core-NFR-1.3.1, text:non functional requirements}}

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To support the workflows for this Application of the standard the operations tha

### Make a Referral

Making a referral for this Application follows the {{pagelink:core-standardpattern-1.3.0, text:standard pattern for BaRS operations}}.
Making a referral for this Application follows the {{pagelink:core-standardpattern-1.3.1, text:standard pattern for BaRS operations}}.

The message definition that defines this payload for this Application is: {{link:https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral}}

Expand Down Expand Up @@ -140,7 +140,7 @@ X-Correlation-Id = <GUID_00002>

### Make a booking

Making a booking for this Application follows the {{pagelink:core-standardpattern-1.3.0, text:standard pattern for BaRS operations}}.
Making a booking for this Application follows the {{pagelink:core-standardpattern-1.3.1, text:standard pattern for BaRS operations}}.

The message definition that defines this payload for this Application is: {{link:https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ topic: APP2-Payloads
The specific guidance around the use of key FHIR resources is described below.

### MessageHeader Resource
{{pagelink:core-SPMessageHeader-1.3.0, text:Standard Patterns for BaRS Operations}} explains in detail how the **MessageHeader** resource **must** be used.
{{pagelink:core-SPMessageHeader-1.3.1, text:Standard Patterns for BaRS Operations}} explains in detail how the **MessageHeader** resource **must** be used.

The MessageHeader resource for the Booking Request should have the following resource elements set as follows:
* **MessageHeader.eventCoding** - **must** be populated with 'booking-request'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ The payloads and workflow have been designed to support these services. Other {{
* The booking Receiver **must** accept the booking request regardless of whether the patient is not known to the service provider
* The booking Receiver **must** accept potential patients who do <ins>not</ins> have a national validated identifier e.g. NHS Number.
* Where a national indentifier is included, it **must** be 'traced and verified', otherwise, the referral Sender **must** <ins>not</ins> include the national indentifer in the request
* Where the booking was <ins>not</ins> successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the booking was <ins>not</ins> successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the booking was <ins>not</ins> successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.1, text:failure scenarios}} for more detail.
* Where the booking was <ins>not</ins> 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 booking Sender **must** send accompanying clinical information in a BaRS referral request
* The booking Sender's request **must** be referenced in the BaRS referral request (where the booking is made first in the workflow)
* The booking Receiver **must** link the explicitly related booking and referral requests
Expand All @@ -108,8 +108,8 @@ The payloads and workflow have been designed to support these services. Other {{
* 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
* Where the referral was <ins>not</ins> successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the referral was <ins>not</ins> successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.3.0, text:failure scenarios}} for more detail.
* Where the referral was <ins>not</ins> 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 <ins>not</ins> 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** include reference to any accompanying BaRS booking related to the referral
* The referral Sender's request **must** be referenced in the BaRS booking request (where the referral is made first in the workflow)
* The referral Receiver **must** link the explicitly related booking and referral requests
Expand All @@ -130,11 +130,11 @@ The payloads and workflow have been designed to support these services. Other {{
<br>
<br>
### Error Handling
* Suppliers **must** adhere to the {{pagelink:core-ErrorHandling-1.3.0, text:error handling guidance}}
* Suppliers **must** adhere to the {{pagelink:core-ErrorHandling-1.3.1, text:error handling guidance}}
<br>
<br>
### Non Functional
* Suppliers **must** adhere to the {{pagelink:core-NFR-1.3.0, text:non functional requirements}}
* Suppliers **must** adhere to the {{pagelink:core-NFR-1.3.1, text:non functional requirements}}
<br>
<br>
<hr>
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To support the workflows for this application of the standard the operations tha

### Make a Referral

Making a referral for this application follows the {{pagelink:Core-StandardPattern-1.3.0, text:standard pattern for BaRS operations}}.
Making a referral for this application follows the {{pagelink:Core-StandardPattern-1.3.1, text:standard pattern for BaRS operations}}.

The Message Definition that defines this payload for this application is: {{link:MessageDefinition-BARS-MessageDefinition-ServiceRequest-Request-Referral}}
<p>
Expand Down Expand Up @@ -102,7 +102,7 @@ X-Correlation-Id = <GUID_000002>

### Cancel a Referral

To cancel a referral this Application follows the {{pagelink:core-SPCancellation-1.3.0, text:standard pattern for BaRS cancellation}}.
To cancel a referral this Application follows the {{pagelink:core-SPCancellation-1.3.1, text:standard pattern for BaRS cancellation}}.

The Message Definition that defines the payload for this Application is: {{link:messagedefinition-barsmessagedefinitionservicerequestrequestcancelled}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ topic: APP3-Payloads
## {{page-title}}

### MessageHeader Resource
For detailed information on the use of MessageHeader please refer to the {{pagelink:core-SPMessageHeader-1.3.0, text:Standard Pattern Message Header}}.
For detailed information on the use of MessageHeader please refer to the {{pagelink:core-SPMessageHeader-1.3.1, text:Standard Pattern Message Header}}.

The MessageHeader resource for the Referral Request should have the following resource elements set as follows:
* **MessageHeader.eventCoding** - **must** be populated with 'servicerequest-request'
Expand Down Expand Up @@ -91,7 +91,7 @@ The level of consent currently supported by BaRS is for 'Direct Care' only. In e

## Referral Cancellation Payload

The ability to cancel a Referral Request is a core workflow in BaRS. For details on the use of the standard pattern for cancellation please see the following {{pagelink:core-SPCancellation-1.3.0, text:Standard Patterns - Cancellation}}.
The ability to cancel a Referral Request is a core workflow in BaRS. For details on the use of the standard pattern for cancellation please see the following {{pagelink:core-SPCancellation-1.3.1, text:Standard Patterns - Cancellation}}.

<br>
<hr>
Expand Down
Loading
Loading