Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

A019: Generate Patient Letter API

API

Request Type URL
POST v1/ReferralRequest/{UBRN}/$ers.generatePatientLetter

Description

This API retrieves the Patient Appointment Request Letter once the referral request has been created (with or without uploaded attachments).

Input

Provide ASID for the end-point system, Session Key, Content Type and Accept parameters.

Example

XAPI_ASID:200000000220
HTTP_X_SESSION_KEY: pro-xapi-session_5a399946-23c5-4543-8c4f-7eca38732a58
Content-Type: application/json+fhir
Accept: */*

Output

If successful:

Response Status: 200 OK
Response Body: A PDF file with Patient Letter will be generated.

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