Retrieve clinical information
Retrieve advice and guidance request summary (versioned) (A024, FHIR STU3)
Overview
Use this endpoint to retrieve a specific version of CommunicationRequest.
Supported security patterns
- Application-restricted access, unattended access
- Healthcare worker, user-restricted access
Pre-requisites
The pre-requisites for this endpoint are the same as for endpoint [[HYPERLINK_A024]].
Note: e-RS only supports the retrieval of the most recent version of CommunicationRequest. You cannot retrieve earlier versions.
Important note
The Important notes for this endpoint are the same as for endpoint [[HYPERLINK_A024]].
Use case
See [[HYPERLINK_A005]].
Related endpoints
See [[HYPERLINK_A024]].
Sandbox test scenarios
You can test the following scenarios in our sandbox environment
| Scenario | Request |
|---|---|
| Simple summary CommunicationRequest | ubrn=000000070000, version=5 |
| Attachment file reference present | ubrn=000000070001, version=5 |
| CommunicationRequest with attachments unavailable for download | ubrn=000000070002, version=5 |
get/STU3/CommunicationRequest/{ubrn}/_history/{version}
Request
- Base URLhttps://sandbox.api.service.nhs.uk/referrals/FHIR
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Parameters
#/paths/~1STU3~1ReferralRequest~1%7Bubrn%7D/get/parameters/0 (unresolved $ref)
#/paths/~1STU3~1Appointment~1%7Bid%7D~1_history~1%7Bversion%7D/get/parameters/6 (unresolved $ref)
#/paths/~1STU3~1Task/get/parameters/0 (unresolved $ref)
#/paths/~1STU3~1Communication/get/parameters/3 (unresolved $ref)
#/paths/~1STU3~1Communication/get/parameters/4 (unresolved $ref)
#/paths/~1STU3~1Communication/get/parameters/5 (unresolved $ref)
#/paths/~1STU3~1Task/get/parameters/4 (unresolved $ref)
Response
(unresolved $ref)
Changes
No recorded changes to this operation across all 1 revision of this API.