Change appointment
Retrieve appointment (versioned) (A038, FHIR STU3)
Overview
Use this endpoint to retrieve a specific version of an Appointment.
Supported security patterns
- Healthcare worker, user-restricted access
Pre-requisites
The pre-requisites for this endpoint are the same as for endpoint [[HYPERLINK_A038]].
Note: e-RS only supports the retrieval of the most recent version of an Appointment. You cannot retrieve earlier versions.
Use case
See [[HYPERLINK_A038]].
Related endpoints
See [[HYPERLINK_A038]].
Sandbox test scenarios
You can test the following scenarios in our sandbox environment
| Scenario | Request |
|---|---|
| Appointment booked to directly-bookable service | appointmentId=70000, version=5 |
| Appointment booked to indirectly-bookable service | appointmentId=70001, version=5 |
| Appointment deferred to service provider for booking | appointmentId=70002, version=5 |
| Appointment sent for triage | appointmentId=70003, version=5 |
| Appointment triage response (Record Triage Outcome) | appointmentId=70004, version=5 |
| Appointment Cancel Appointment, Action Later | appointmentId=70005, version=5 |
| Appointment cancelled | appointmentId=70006, version=5 |
| Appointment converted from an Advice and Guidance Request and booked to a directly-bookable service | appointmentId=70007, version=5 |
get/STU3/Appointment/{id}/_history/{version}
Request
- Base URLhttps://sandbox.api.service.nhs.uk/referrals/FHIR
- URLhttps://sandbox.api.service.nhs.uk/referrals/FHIR/STU3/Appointment/{id}/_history/{version}
- AuthHTTP bearer
Path parameters
versionstring required
Example:5
The version of the resource to be retrieved. It must be the latest version of the resource otherwise HISTORY_NOT_SUPPORTED error will be returned (HTTP 404 Not Found).
Parameters
#/paths/~1STU3~1Task/get/parameters/0 (unresolved $ref)
#/paths/~1STU3~1Task/get/parameters/1 (unresolved $ref)
#/paths/~1STU3~1Task/get/parameters/2 (unresolved $ref)
#/paths/~1STU3~1Task/get/parameters/3 (unresolved $ref)
#/paths/~1STU3~1Task/get/parameters/4 (unresolved $ref)
#/paths/~1STU3~1Appointment~1%7Bid%7D/put/parameters/4 (unresolved $ref)
Response
(unresolved $ref)
Changes
No recorded changes to this operation across all 1 revision of this API.