Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

A007: Retrieve Clinical Information

Status: Live

API

Method URL
GET /ers-api/v1/Binary/$ers.generateCRI?UBRN={UBRN}

Description

This API lets users create a real-time Portable Document Format (PDF) of the referral. This is suitable for integration into a 3rd party system. You can find the Clinical Information for a referral request using a UBRN.

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 a PDF of clinical referral information for referral is returned. The response code 200 (OK) is returned.

Notes

Get the Clinical Referral Information for a Referral Request identified by the given UBRN.

Parameters

Parameter Value Description Parameter Type Data Type
UBRN   UBRN Query String

Response Messages

HTTP Status Code Reason
200 OK
403 Forbidden
404 Not Found

All content is available under the Open Government Licence v3.0, except where otherwise stated