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
4 changes: 4 additions & 0 deletions CodeSystem/flag-categories-bars.xml
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,8 @@
<code value="API" />
<display value="Additional Patient Information" />
</concept>
<concept>
<code value="CW" />
<display value="Call Warning" />
</concept>
</CodeSystem>
21 changes: 15 additions & 6 deletions CodeSystem/location-types-bars.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,29 @@
<copyright value="Copyright &#169; 2021 NHS Digital" />
<caseSensitive value="true"/>
<content value="complete"/>
<concept>
<code value="CLOC" />
<display value="Caller Location" />
</concept>
<concept>
<code value="HLOCFR" />
<display value="Helimed From Location" />
</concept>
<concept>
<code value="HLOCTO" />
<display value="Helimed To Location" />
</concept>
<concept>
<code value="ILOC" />
<display value="Incident Location" />
</concept>
<concept>
<code value="CLOC" />
<display value="Caller Location" />
<code value="OLOC" />
<display value="Other Location" />
</concept>
<concept>
<code value="RLOC" />
<display value="Rendezvous Location" />
</concept>
<concept>
<code value="OLOC" />
<display value="Other Location" />
</concept>

</CodeSystem>
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.8">

## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.8.

Expand All @@ -24,7 +27,8 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
| 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. | Update | Booking Request |Implementation guidance added | <mark style="background-color: Yellow">correction</mark> |
| 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. | Update | Referral Response |Implementation guidance added | <mark style="background-color: Yellow">correction</mark> |

</div>
</div>

<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## {{page-title}}
This is a major release with a significant change to the Implementation Guidance and examples for v2.0.0. The changes are detailed in the change log.

### Application Change Log


<br>


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
| NHSno | ??? | <mark style="background-color: Red">correction</mark> |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| NHSNo | | | Update | | | <mark style="background-color: Red">correction</mark> |


<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 2.0.0
filename: 2.0.0.page.md
- name: 1.0.8
filename: 1.0.8.page.md
- name: 1.0.7
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.8">

## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.8.

Expand Down Expand Up @@ -25,6 +28,9 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
| 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. | Update | Booking Request |Implementation guidance added | <mark style="background-color: Yellow">correction</mark> |
| 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. | Update | Referral |Implementation guidance added | <mark style="background-color: Yellow">correction</mark> |

</div>
</div>

<br>
<hr>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## {{page-title}}
This is a major release with a significant change to the Implementation Guidance and examples for v2.0.0. The changes are detailed in the change log.

### Application Change Log


<br>


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
| NHSno | ??? | <mark style="background-color: Red">correction</mark> |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| NHSNo | | | Update | | | <mark style="background-color: Red">correction</mark> |


<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 2.0.0
filename: 2.0.0.page.md
- name: 1.0.8
filename: 1.0.8.page.md
- name: 1.0.7
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.4">

## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.4.

Expand All @@ -24,6 +27,9 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
| careplan.period.start| datetime | dateTime | Update | Referral |Implementation guidance added | <mark style="background-color: Yellow">correction</mark> |
| patient.identifier.system | | This SHOULD be populated with the namespace for the Identifier | Update | Referral | Implementation Guidance consistent across all applications | <mark style="background-color: Yellow">correction</mark> |

</div>
</div>

<br>
<hr>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## {{page-title}}
This is a major release with a significant change to the Implementation Guidance and examples for v2.0.0. The changes are detailed in the change log.

### Application Change Log


<br>


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
| NHSno | ??? | <mark style="background-color: Red">correction</mark> |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| NHSNo | | | Update | | | <mark style="background-color: Red">correction</mark> |


<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 2.0.0
filename: 2.0.0.page.md
- name: 1.0.4
filename: 1.0.4.page.md
- name: 1.0.3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.2.3">

## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.2.3.

Expand Down Expand Up @@ -31,6 +34,9 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
| patient.identifier.system | | This SHOULD be populated with the namespace for the Identifier | Update | Interim Validation Response | Implementation Guidance consistent across all applications | <mark style="background-color: Yellow">correction</mark> |
| patient.identifier.system | | This SHOULD be populated with the namespace for the Identifier | Update | Validation Response | Implementation Guidance consistent across all applications | <mark style="background-color: Yellow">correction</mark> |

</div>
</div>

<br>
<hr>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## {{page-title}}
This is a major release with a significant change to the Implementation Guidance and examples for v2.0.0. The changes are detailed in the change log.

### Application Change Log


<br>


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
| NHSno | ??? | <mark style="background-color: Red">correction</mark> |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| NHSNo | | | Update | | | <mark style="background-color: Red">correction</mark> |


<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 2.0.0
filename: 2.0.0.page.md
- name: 1.2.3
filename: 1.2.3.page.md
- name: 1.2.2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Cancellation is documented for completeness. The technical functionality for can

Steps to cancel:

* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken with [GET DocumentReference](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference) (searchset bundle) and selecting the Service and Appointment.id to create the read request of the Appointment resource by .id. NB: If a match cannot be performed using this method, the process of cancelling must be done manually.
* Set the Appointment.status value to "cancelled". NB - It is also permissible to update .reasonCode in the request but no other element.
* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually
* Set the Appointment.status value to "cancelled". NB - It is also permissible to update .reasonCode in the request but no other element
* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}
* Once processed, the Receiver of the booking must [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#delete-/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}}

resource returned:
```json
Expand Down Expand Up @@ -81,7 +82,7 @@ Request body:
```json
{
"resourceType": "Appointment",
"id":"aca94bdb-2e38-4399-9ece-2ba083ce65b5"
"id":"aca94bdb-2e38-4399-9ece-2ba083ce65b5",
"meta": {
"lastUpdated": "2024-01-11T16:01:30.8185338+00:00",
"profile": [
Expand Down Expand Up @@ -110,5 +111,3 @@ Request body:
```

<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/BaRS_Foundation_Cancel.drawio.svg" ></img>

Once the appointment is cancelled, the Receiver is responsible for managing the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-1.3.1, text: Document Reference Standard Pattern}}.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ If undertaking a booking within the context of an Application, the guidance stat
* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/metadata)
* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot)
* Select a slot
* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) operation to complete the booking NB: the returned Appointment.id for future operations
* Perform a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) operation to complete the booking NB: the returned Appointment.id for future operations
* Once processed, the Receiver of the booking must makes a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/DocumentReference) request to create a pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}}

Request Body

Expand Down Expand Up @@ -52,8 +53,4 @@ Request Body
}
```

<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/BaRS_Foundation_Book.drawio.svg" ></img>

Once the appointment is created, the Receiver is responsible for managing the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-1.3.1, text: Document Reference Standard Pattern}}.


<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/BaRS_Foundation_Book.drawio.svg" ></img>
Loading
Loading