A006: Retrieve Attachment

For the new FHIR v3 endpoint, please click here.

Status:

Deprecated

This endpoint has been deprecated, meaning you should not use it for new integrations.

Instead, please use our newer e-RS FHIR API solution which is documented here: https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir

API

Base URL (Dev1): https://api.dev1.ers.ncrs.nhs.uk/ers-api/

Method	URL
GET	v1/Binary/{AttachmentLogicalID}

Description

This API lets users retrieve and download linked files for a referral, also known as attachments.

Note: The AttachmentLogicalID won’t be made available explicitly, but the full path required to retrieve the attachment is returned by A005 Retrieve Referral Request. The path to the attachment can be found in the “url” field of the DocumentReference.content.attachment in the contained section of the ReferralRequest resource.

Input

Provide ASID of the end-point system and equivalent Session Key generated for the SSO Token-ID.

Example

XAPI_ASID:200000000220
HTTP_X_SESSION_KEY:pro-xapi-session_5a399946-23c5-4543-8c4f-7eca38732a58
Accept:*/*

Output

If successful file content linked to the referral is returned. The response code 200 (OK) is returned.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
AttachmentLogicalID		The logical ID for the Binary resource (i.e. for the attachment) in the format att-x-y where x and y are Integers	Path	String

Response Messages

HTTP Status Code	Reason
200	OK
403	Forbidden
404	Not Found

API Hub

Explore and Make use of Nationally Defined Messaging APIs