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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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>
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down Expand Up @@ -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)"
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,25 @@ The third identifier (currently optional) relates to the product-id, system '*ht
}
```

**context:** includes 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 4: Retrieve the booking or referral
The booking or referral resource can be retrieved by making a GET request for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest/-id-).

The two key values required to make the request are the first two identifiers in the DocumentReference; the resource .id ('*https://fhir.nhs.uk/Id/BaRS-Identifier*') and service id ('*https://fhir.nhs.uk/Id/dos-service-id*'). Use the resource .id populate the location of the request and service id to populate the NHSD-Target-Identifier HTTP Header, as described in the worked example below.

For BaRS, a GET of the relevant resource using the Target Identifiers. In this simplified example, the identifier containing the service id is used in the NHSD-Target-Identifier header, instructing the BaRS proxy to route to the request to that target **note**: The header is not base64Encoded in this example:

```bash
```
cURL --location 'https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4/Appointment/8c63d621-4d86-4f57-8699-e8e22d49935d' \
--header 'X-Request-ID: {{X-Request-ID}}' \
--header 'X-Correlation-ID: {{X-Correlation-ID}}' \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ For more detail please visit the {{pagelink:Core-StandardPattern-1.3.1, text: St

The key capabilities surrounding appointments are listed below. This section will provide information on how to meet them.

* view
* book
* update
* cancel
Expand Down
Loading