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
Expand Up @@ -30,9 +30,6 @@ topic: TRN-API-1.2.0
<br>
<hr>

### Previous Releases


#### Initial release In BaRS 1.5.0

<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
topic: TRN-API-1.3.0
---
<br>

<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.3.0">

## {{page-title}}

### Change Log

### in BaRS 1.9.0

| Change | Description | Impact |
|----------------------------------------------|---------------------------------------------------------------------|--------|
| <div class="imgHandshake">{{render:handshake}}</div> - Additional patient demographic parameters added to GET /Appointment | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - - Additional patient demographic parameters added to GET /ServiceRequest | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| Fixed incorrect character display on GET /Slot description | 1.9.0 | Character display for a double quote was displaying oddly. | <mark style="background-color: Yellow">correction</mark> |


<br>
<hr>

</div>
</div>

<hr>
<br>
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ topic: TRN-API-global

| Change | BaRS Version | Description | Impact |
|------------------------------------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| <div class="imgHandshake">{{render:handshake}}</div> - Additional patient demographic parameters added to GET /Appointment | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - - Additional patient demographic parameters added to GET /ServiceRequest | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| Fixed incorrect character display on GET /Slot description | 1.9.0 | Character display for a double quote was displaying oddly. | <mark style="background-color: Yellow">correction</mark> |
| Removal of use-context HTTP header | 1.8.2 |Restricted the use of the use-context header to non-write operations | <mark style="background-color: Yellow">correction</mark> |
| Improvments to header documentation | 1.8.2 |Added better explanations for most of the headers needed | <mark style="background-color: Green">Addition</mark> |
| Addition of the use-context HTTP header | 1.8.1 | A new header to assist in {{pagelink:core-EndToEndWorkflow-Logging-1.0.5, text: audting and logging}} | <mark style="background-color: Green">Addition</mark> |
Expand All @@ -19,45 +22,4 @@ topic: TRN-API-global
| Improvement to DocumentReference Schema | 1.5.0 | the DocumentReference Schemas have been flattend for easier consumption | <mark style="background-color: Yellow">correction</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - Corrections to example references containing http. | 1.5.0 | Several references to http://fhir.nhs.uk have been corrected to "https". | <mark style="background-color: Yellow">correction</mark> |

This Section will list all updates to the BaRS API Specification within the 1.2.0 minor release, published for BaRS 1.5.0.

### Publication of the 1.2.0 API Specification (in development)

The API Spec landing page will now have the an additional version to select to view. At present this will present 1.0.0, 1.1.0 and 1.2.0, with links to each specification. 1.1 and 1.2.0 are currently in development.

### Endpoint Catalogue

**EndpointCatalogue related Endpoints have been added to the specification in preparation for future use cases.**

The following endpoints are now available in the 1.2.0 specification. These endpoints will be used in future use cases and future iterations of current use cases.

* GET /Endpoint
* GET /HealthcareService
* GET /Organization
* GET /Endpoint/[id]
* GET /HealthcareService/[id]
* GET /Organization/[id]
* PUT /Endpoint/[id]
* PUT /HealthcareService/[id]
* PUT /Organization/[id]
* DELETE /Endpoint/[id]
* DELETE /HealthcareService/[id]
* DELETE /Organization/[id]

### Appointment

The following endpoints have been provisionally added to the 1.2.0 specification. These endpoints will be used in future use cases and future iterations of current use cases.

* POST /Appointment/[id]
* PUT /Appointment/[id]
* PATCH /Appointment/[id]
* DELETE /Appointment/[id]

### ServiceRequest

The following endpoints have been provisionally added to the 1.2.0 specification. These endpoints will be used in future use cases and future iterations of current use cases.

* POST /Appointment/[id]
* PUT /Appointment/[id]
* PATCH /Appointment/[id]
* DELETE /Appointment/[id]
### Previous Releases
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
filename: Index.page.md
- name: Global
filename: Global.page.md
- name: 1.3.0
filename: 1.3.0.page.md
- name: 1.2.0
filename: 1.2.0.page.md
- name: 1.1.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.8.2">

### 1.8.2

## Implementation Guide Changes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This payload is used to transmit all the necessary information that is required
| Bundle | https://simplifier.net/nhsbookingandreferrals/barsbundlemessage | | 1..1 | |
| Bundle.id | This id is generated by the originating sender of the message, retained in subsequent messages.. | MUST | 1..1 | 79120f41-a431-4f08-bcc5-1e67006fcae0 |
| Bundle.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
| Bundle.meta.versionId | This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing. | MUST | 0..1 | |
| Bundle.meta.versionId | This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing. | MUST | 0..1 | 1.0.0-beta |
| Bundle.meta.profile | This MUST be populated with the structure definition for BaRSBundleMessage : 'https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage |
| Bundle.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
| Bundle.type | This MUST be populated with 'message' - FIXED VALUE | MUST | 1..1 | message |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ A Home AST may request support from a Supporting AST when they cannot meet all o
- If the Supporting AST rejects the request, the Home AST will make alternative arrangements
- If the Supporting AST accepts the request:
- the Supporting AST is responsible for dispatching the requested resource within the time frame specified in the request
- The Home AST remains responsible for the case and for dispatching the resources not specified in the request
- the Home AST remains responsible for the case and for dispatching the resources not specified in the request

Note: The BaRS Referral may be used to support single patient Mutual aid requests. It is not intended to replace processes relating to Mutual Aid Requests to support Major Incidents with multiple patients.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a name="top"></a>
## How to use this implementation guide
## How to use this Implementation Guide

This section provides a generated <a href="#P1">site map</a> of this implementation guide.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you are using BaRS in a live environment, then follow the guidance below if y

### How to contact the National Service Desk

Email: [ssd.nationalservicedesk@nhs.net](ssd.nationalservicedesk@nhs.net)
Email: ssd.nationalservicedesk@nhs.net

Telephone: 0300 303 5035

Expand Down
Loading