---
title: "Retrieve clinical information (A007, FHIR STU3)"
method: POST
path: "/STU3/ReferralRequest/{ubrn}/$ers.generateCRI"
tags: ["Retrieve clinical information"]
---

# Retrieve clinical information (A007, FHIR STU3)

`POST /STU3/ReferralRequest/{ubrn}/$ers.generateCRI`

## Request

- Base URL: `https://sandbox.api.service.nhs.uk/referrals/FHIR`
- URL: `https://sandbox.api.service.nhs.uk/referrals/FHIR/STU3/ReferralRequest/{ubrn}/$ers.generateCRI`
- Auth: HTTP bearer

## Overview

Use this endpoint to generate a PDF file that summarises clinical information for a referral.

This does not include files attached to a referral or advice request. These must be retrieved via [[HYPERLINK_A042]]

[Read](https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings/e-referral-service/retrieve-clinical-referral-information-as-a-service-provider) our building healthcare software guide for detailed information.

## Supported security patterns
- Application-restricted access
- Healthcare worker, user-restricted access

## Pre-requisites
### Application-restricted access 
In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.

### Healthcare worker, user-restricted access
In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:
  - `REFERRING_CLINICIAN`
  - `REFERRING_CLINICIAN_ADMIN`
  - `SERVICE_PROVIDER_CLINICIAN`
  - `SERVICE_PROVIDER_CLINICIAN_ADMIN`

You need to use the `Unique Booking Reference Number` (UBRN) of a referral request in order to use this endpoint.

## Important note
A referral pathway in e-RS can be made up of more than one UBRN. For example, a referral is booked and seen in a general knee clinical assessment service (UBRN #1), 
and the service decides to onward refer to a more specialist knee miniscus service (UBRN #2). This would result in two UBRNs for the referral pathway 
in this example (but there could be more related UBRNs if onward referred multiple times).

As such, it is important that all clinical information is obtained from across all the related UBRNs referenced in [[HYPERLINK_A005]]. 
You can do this using the following endpoints:
  - [[HYPERLINK_A007]]
  - [[HYPERLINK_A006]]

Note: It is possible that the initial UBRN may be the only one in the referral pathway to have clinical information and/or attachments associated.

## Use case

As an authenticated user or application

I need to retrieve a clinical information summary (in PDF format) associated with the referral

So that I can assess its content and decide what further action may be needed.

## Related endpoints
You can retrieve clinical attachments that are associated with a referral using [[HYPERLINK_A006]].

## Parameters

- `#/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)
- `#/paths/~1STU3~1ReferralRequest~1%7Bubrn%7D/get/parameters/0` (unresolved $ref)

## Response `200`

Response contains the binary stream of the clinical information summary (PDF).

## Other responses

- `401` (unresolved $ref)
- `403` (unresolved $ref)
- `404` (unresolved $ref)
- `406` (unresolved $ref)
- `422`: Where status code 422 (Unprocessable Entity) is returned then an eRS-OperationOutcome-1 will be included in the body, as detailed below. Check diagnostics property for specific information regarding the error. | Error code | Description | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | INVALID_REQUEST_TYPE | The `UBRN` provided exists in e-RS but does not correspond to an active request. | | PATIENT_ERROR | An error occurred while retrieving the requested patient. Do not attempt again. | | NO_RELATIONSHIP | The user does not have a legitimate relationship with the request. |
- `429` (unresolved $ref)
- `500` (unresolved $ref)
- `503` (unresolved $ref)

---

[API](https://skmtc.dev/nhs/apis/e-referrals-service-api.md) - [All operations](https://skmtc.dev/nhs/apis/e-referrals-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nhs/apis/e-referrals-service-api/revisions/916969ea472f?raw)
