Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Support for booking only services

Support for “booking only” type services

Some services that are profiled on the Urgent Care Directory of Services are comissioned as “booking only” services. This means that these services will only accept a referral if a booking has also been made for that patient.

If no appointment is available then a referral should not be made.

To achieve this, a “service attribute” is configurable against services. This will allow the service to be flagged as “booking only”. Therefore if this attribute is present on the servicem all consumer systems should withold referrals. The DoS API documentation for this can be found here.

Workflow

An example workflow showing how this might be implemented is illustrated below:

Example xml returned:

When requesting DoS service details with “CheckCapacitySummary” DoS API call, there is a section in the returned message for the additional attributes:

<ns1:attributes>
  <attribute>
    <dataType>string</dataType>
    <name>requirebooking</name>
    <description>The service only accepts referrals with an accompanying booked appointment.</description>
    <value>true</value>
  </attribute>
</ns1:attributes>

This attribute will have three possible states:

  • not present
  • present and false
  • present and true

For the first two cases, it can be assumed that referrals can be made without a booking. Only if the attribute is present and true should a referral be witheld if there has been no booking.


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