Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

A017: Defer Booking to Provider

Status: Alpha

API

Base URL (Dev3): https://api.dev3.ers.ncrs.nhs.uk/ers-api/

Method URL
POST v1/ReferralRequest/{UBRN}/$ers.deferBooking

Description

This API lets the professional user to defer a booking to a different Service Provider

Input

Provide ASID for the end-point system, Session Key and VersionId.

Example

XAPI_ASID:200000000220
HTTP_X_SESSION_KEY:pro-xapi-session_5a399946-23c5-4543-8c4f-7eca38732a58
Accept:application/json+fhir
If-Match: W/"n"

Body

Provide Service ID and Deferral Reason where you want this referral to defer to.

Example

{
  "meta": {
    "profile": "http://fhir.nhs.uk/OperationDefinition/ers-DeferAppointment-operation-1"
  },
  "parameter": [{
    "name": "serviceId",
    "valueString": "6473294"
  },
  {
    "name": "deferralReason",
    "valueString": "SYSTEM_UNAVAILABLE"
  },

  {
    "name": "deferralComment",
    "valueString": "Test"
  }
   ]
}

Output

If successful the URBN created in A011 is deferred to a different Service Provider. The response code 200 (OK) is returned. This response has no body.


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