EBooking Implementation Manual
	Programme	NPFIT	DOCUMENT NUMBER
	Sub-Prog/Project	Comms & Messaging	National Prog	Org	Prog/Proj	Doc Type	Seq
	Prog. Director	Tim Jones	NPFIT	NDA	COM	TZ	0163
	Sub-Prog/Proj Mgr	Margaret Baldock
	Author	Core Technical Team	Version No.		3.5
	NPO/PSO Contact	Sarah King	Status		Issued

 

 

Contents

 

 

Change History

In Version	Author	Date	Amendment Details
0.3	Core Technical Team	29/10/2003	First version for external Issue
0.4	Core Technical Team	25/11/2003	Final draft version. Added new messages for Appointment cancellation, changed message identifiers, modified some models in response to feedback. Changed Storyboards to involve new interactions.
1.0	Core Technical Team	28/11/2003	Resolved cosmetic & typographic errors prior to Issue
2.0	Core Technical Team	08/02/2004	Merged message types, resolved wrapper issues, modified some models and documentation in response to feedback. Modified message types within interactions. Added triggers section
2.1	Core Technical Team	O5/04/2004	Change requests : DACM-CR-24, DACM-CR-26 & DACM-CR-27. Inclusion of detailed referral example.
3.0	Core Technical Team	25/06/2004	Added Consultant to the Slot response and updated all wrappers. Added section on Error Correction
3.1	Core Technical Team	16/07/2004	Change request NPFIT-NDA-CM-RZ-0120
3.2	Core Technical Team	17/09/2004	Includes new generic Control Act Wrapper, new SDS OIDs and updated Agent SDS CMETs. Removed withdrawal message option
3.3	Core Technical Team	24/09/2004	Align document paragraph numbers with Contents.
3.4	Core Technical Team	29/10/2004	Change request MIM-CR-0076 and Updated to new versions of Infrastructure Artefacts.
3.5	Core Technical Team	06/12/2004	Updated to use new versions of Infrastructure Artefacts. Previous section 8 - Interaction Index removed.

 

 

1    Overview

The Electronic Booking Service (eBS) provides a mechanism for Primary care to register a request for a service for a patient and either book an appointment there and then or allow the patient to book a suitable appointment themselves at a later date through a number of routes.

 

The service requested for a patient is identified with a unique service booking number (UBRN) which allows access to the selected service for the purpose of booking the appointment. Once an appointment has been selected, its availability is confirmed with the Fulfiller and the appointment made.

 

Further business analysis to support the sending of referral information to PSIS will be undertaken as part of P1R2; this will ensure that data correction mechanisms used for PSIS support the eBooking process.

 

 

 

2    Storyboards

2.1    Book now - Refer now

Mrs. Alan has a long history of a painful left hip. Until recently she has coped well with conservative treatments, but during a follow-up consultation, it becomes apparent that she is encountering increasing discomfort and immobility. After discussing possible options, her GP, Dr Evans, decides that a referral to an orthopaedic Out-Patient appointment, to explore surgical options, is indicated. He asks Mrs. Alan if she is interested in having an appointment with the shortest wait or would prefer to only take a local appointment. Mrs Alan indicates that she would prefer a local appointment. Dr Evans activates the eBooking Service (eBS) option on his local system. A Request Service interaction ensues and a message is sent to eBS with Mrs Alan’s details. The eBS responds with a Confirm Service Request message containing a UBRN.

 

Meanwhile, the eBooking Application is launched with the patient details available and Dr Evans uses its search facility to locate local services in this area. In negotiation with Mrs Alan, he selects an appropriate appointment in the orthopaedic outpatient clinic run by Mr Daniels, a new consultant, at the local Hospital.  By this time, the UBRN has been received by the application.

 

The eBS application prompts Dr Evans to indicate consent to call back, to which Mrs Alan consents, and if transport is required (which it is in this case).

 

Once an appointment has been selected, the eBS sends a Request Appointment Confirmation message to the local hospital system to ensure that the selected appointment time is still available. The local system responds with a Confirm Appointment message.  eBS can now confirm that the appointment has been booked and Dr Evans prints out the appointment details and any requirements of the clinic for Mrs Alan to take home.

 

Mrs Alan leaves the consultation room and Dr Evans enters the referral information for Mr Daniels in the GP system. He electronically signs the referral and, on completion, it is sent electronically to eBS as a Referral message where it is stored. The local hospital system may access the eBS to view the referral.

 

Mr Daniels is a new Consultant at Greenhill NHS Trust Hospital. He has just started up a number of Orthopaedic clinics. The clinic times and the duration of appointments have been agreed and configured on the Hospital system by the Medical Records department.

 

The local PCT has chosen to make the orthopaedic services available through the new eBooking service, on which the appropriate clinics have been configured, and the PAS system in the hospital has been upgraded to receive and send booking messages. The available appointments are notified to the eBooking service in response to a request for them. Mr Daniels however has little IT knowledge and experience and the Medical Records department agree to provide the consultant with a print out of referrals. Mr Daniels agrees to undertake basic IT training.

 

The day before the appointment, Mrs Alan rings the BMS and informs them that she cannot make the appointment as she is suffering from severe diarrhoea. The eBS send a request to the hospital to cancel the appointment and receives a confirmation back. They are able to make an appointment for Mrs Alan a couple of days later as there has been a cancellation.

 

On the day of the appointment, Mrs Alan is collected by ambulance and arrives for her outpatient appointment. Mr Daniels has been provided with a print-out of the referral information. He also has Mrs Alan’s Hospital record. On examination, Mr Daniels agrees a number of further tests that will be carried out on Mrs Alan and they arrange a further appointment.

 

Two days later Mrs Alan has a fall and calls out her GP for a home visit. Dr Evans checks her appointment record on the eBooking Service application before he drives out and sees that she has had an appointment which has not been marked as a ‘Did Not Attend’, so he is confident that she has been seen by the consultant. During his visit he decides she needs immediate attention and should be admitted to hospital.

 

2.2    Book Now - Refer Later

In this scenario, a member of  the practice staff enters the referral details from a dictated memo created by Dr Evans after the patient encounter. The details are then validated by Dr Evans prior to being sent to the eBooking system.

 

Following completion of the appointment booking, Mrs Alan leaves the consultation.

 

Dr Evans dictates the referral information for the referral of Mrs Alan to Mr Daniels. Jane, one of the GP practice staff logs on the GP system and selects the patient’s record. She locates the Booking Number (UBRN) for the referral to Mr Daniels and enters the referral information. Dr Evans logs onto the system the next day before the surgery and electronically signs the referral. On completion, the system sends the Referral electronically to the eBS where it is stored. The referral may be accessed for viewing by the local hospital.

 

2.3    Book Later - Refer Later

Mr Wilson makes an appointment with his General Practitioner, Dr Green, regarding a respiratory problem. On seeing his GP, it is clear that he is anaemic and suffering ‘Shortness of Breath’. He also reports discomfort in his chest.  Dr Green carries out an initial examination and asks for Mr Wilson to go to the local laboratory to have some blood tests carried out. He discusses the situation with Mr Wilson and it is agreed that he will be referred to a cardiologist for further investigation. 

 

Dr Green finds Mr Wilson’s record on his computer and selects the eBooking option. Whilst a Unique Booking Reference Number (UBRN) is being obtained from the eBS in response to a Request for Service, Dr Green is able to search for the required services on the eBooking screen which is presented to him. Mr Wilson asks for an appointment as soon as possible and is happy to travel to attend as he can drive himself. Once they have decided on the appropriate clinic for Mr Wilson to attend, Dr Green proposes a date for the appointment to Mr Wilson. At this time, Mr Wilson cannot be sure that he can be available so Dr Green prints out the information on the service they have selected for him without making an appointment and tells Mr Wilson to ‘phone the Booking Management Service (BMS) quoting the reference number (UBRN) in order to book the appointment.

 

Mr Wilson calls in at the local Pathology department on his way home and has blood collected for the tests requested by Dr Green. On reaching home, he checks in his diary and rings the BMS quoting the UBRN as requested. The operator searches for, and finds, the required service on the eBS and they agree an appointment time. The eBS sends a message to the hospital system where the clinic is run in order to confirm the appointment. The system responds with a rejection as the appointment has already been filled. The operator reviews the other appointments available on the eBS and, in discussion with Mr Wilson, they select another time. This time the Hospital system, which will fulfil the appointment, responds with an appointment confirmation. The BMS operator confirms with Mr Wilson that the appointment has been booked and he should attend and that the clinic requires him to take a sample of urine with him.

 

The laboratory carry out the tests requested by Dr Green and send the results to him via the Pathology Messaging system. On receipt, Dr Green reviews the results and constructs a referral letter against the UBRN for Mr Wilson incorporating those results which have significance to the referral. Once he has finished this, he electronically signs the letter and it is sent in a referral message to the eBS.

 

The Cardiac Outpatients clinic review their appointment list and find that, due to illness within the team, they are under-resourced for the appointments made for the day on which Mr Wilson is due to attend. The clinic administrator reviews the list with Mr Hussein and they decide that Mr Wilson is not at risk if he is asked to attend at a later date. The Administrator cancels the appointment which results in a communication cancelling the appointment being sent to the eBS. As the appointment slot has now been made unavailable by the Appointment fulfiller (the clinic), an additional Slot Cancellation is sent to eBooking to ensure that the slot is not offered to anyone else. The clinic has arranged that all re-scheduling will be carried out by the eBS. On receipt of the cancellation, the eBS contact Mr Wilson and they agree on a new appointment time. As before, this is checked and confirmed electronically with the Hospital PAS (fulfiller) application.

 

Mr Wilson does not attend his appointment on the agreed date. The Hospital PAS (Service Fulfiller) notifies the eBS with a Did Not Attend communication and BMS are able to contact Mr Wilson. They ascertain the reason for his non-attendance, he had a fall and was in casualty, and arrange for a further appointment. This time, Mr Wilson attends and is treated for his condition.

 

3    Application Roles

The applications involved in the eBooking process play specific roles. These, along with the interactions associated with each role, are identified below.

 

3.1    eBS Service Requestor - PRPA_AR010000UK01

The Service Requestor is the initiator of any eBooking service request and will request services from a fulfiller via the intermediary eBooking Service to schedule an appointment for a subject. The role will require the Requestor to supply patient information and a patient referral along with the receipt of acknowledgement messages from the eBooking Service.

 

eBS Service Requestor Interactions.

 

 

3.2    eBooking Service

The eBooking Service role acts as a focal point between multiple service fulfillers and multiple Service Requestors. The Application plays two roles and will receive requests for Services and Referrals from the Service Requestor and will receive Service availability messages from the Service Fulfillers. The eBooking Service will supply unique references for each Service request and will manage confirmation of bookings between the Requestor and fulfiller. No requirement has been identified for the eBooking Service to supply a referral to the Fulfiller system or for the Service Requestor to be notified of any appointment or cancellation that may take place.

 

3.2.1    eBS Service Request Manager - PRPA_AR020000UK01

In this role, the eBS Service Request Manager is responsible for receiving requests for Services and the issue of the Unique Booking Reference Number. It may also receive Service cancellation notifications from Service Requestors.

 

eBS Service Request Manager Interactions.

 

 

3.2.2    eBS Appointment Manager - PRSC_AR020000UK02

In this role, the eBS Appointment Manager is responsible for managing the available slots and for requesting confirmation of Appointment requests from Appointment fulfillers. It may also cancel appointments or receive Cancel notifications from Fulfillers

 

eBS Appointment Manager Interactions.

 

 

3.3    eBS Service Fulfiller - PRSC_AR030000UK02

The Service Fulfiller Application role will provide Appointment services for specific clinics to the eBooking Service and may cancel services, both confirmed and available. The role will also receive requests to book, cancel and supply available services. It will provide information on available services in response to a query from the eBooking Service. No requirement has been identified for the unsolicited updating of the eBooking Service either for slots that have been booked or changes to already advertised slots.

 

eBS Service Fulfiller Interactions.

 

 

4    Trigger Events

4.1    Request eBooking Service - PRPA_TE010000UK01

 

Structured Name	Request eBooking Service, Fulfilment Request
Type	User Request

 

Indicates that the requester has activated a request for the provision of a service. This results in an interaction with the eBS and the receiving application is asked to act on it.

 

4.2    Respond Service Request - PRPA_TE020000UK01

 

Structured Name	Respond Service Request, Confirmation
Type	Interaction Based

 

The eBS application has accepted a request for the provision of a service. This triggers an interaction based response to the requester.

 

4.3    Appointment Service Notification - PRSC_TE040000UK01

 

Structured Name	Respond Service Request, Confirmation
Type	User Request

 

Trigger is the selection of an appointment slot on the eBS. The interaction notifies the fulfiller of the selected appointment and requests confirmation that it can be fulfilled.

 

4.4    Appointment Confirmation - PRSC_TE050000UK01

   

Structured Name	Appointment Confirmation
Type	Interaction Based

 

The fulfiller accepts and confirms a request for the provision of a scheduled service (appointment).

 

4.5    Appointment Rejection - PRSC_TE060000UK01

 

Structured Name	Appointment Rejection
Type	Interaction Based

 

The fulfiller rejects a request for the provision of a scheduled service (appointment).

 

4.6    Appointment Cancellation - PRSC_TE070000UK01

 

Structured Name	Appointment Cancellation
Type	User Request

 

The user cancels an appointment on eBS. This results in an interaction to the fulfiller requesting appointment cancellation.

 

4.7    Request Appointment Cancellation Success - PRSC_TE140000UK01

 

Structured Name	Request Appointment Cancellation Success
Type	Interaction Based

 

Indicates that the fulfiller has responded successfully to the request for the cancellation of a promised appointment.

 

4.8    Request Appointment Cancellation Failure - PRSC_TE150000UK01

 

Structured Name	Request Appointment Cancellation Failure
Type	Interaction Based

 

Indicates that the fulfiller has failed in response to the request for the cancellation of a promised appointment.

 

4.9    Appointment Cancellation event - PRSC_TE130000UK01

 

Structured Name	Appointment Cancellation Event
Type	State Transition
State Transition	Cancel Appointment Notification

 

An appointment is cancelled on the fulfiller system. The interaction advises the eBS of the cancellation of a promised appointment by the fulfiller.

 

4.10    Update Available slots cache - PRSC_TE080000UK01

 

Structured Name	Update Available slots cache
Type	State Transition
State Transition	Update available appointment slots Request

 

A state change on the eBS triggers a requests for an update of the available slots for a fulfiller.

 

4.11    Available Slot Response - PRSC_TE090000UK01

 

Structured Name	Available slots Response
Type	Interaction Based
State Transition	Respond to Update available appointment slots Request

 

The fulfiller application responds to a request for an update of its available slots.

 

4.12    Cancel Slot Availability - PRSC_TE100000UK01

 

Structured Name	Cancel Slot Availability
Type	State Transition
State Transition	Appointment slot no longer available

 

A slot ceases to be ‘available’ on the fulfiller. The fulfiller application notifies eBS of the change in availability of an appointment slot.

 

4.13    Notification of DNAs - PRSC_TE110000UK01

 

Structured Name	Notification of Did Not Attends
Type	State Transition
State Transition	DNA Appointment update

 

 A state change on the fulfiller application triggers a notification to eBS of appointment slot promises that have not been fulfilled.

 

4.14    Send Referral - PRPA_TE030000UK01

 

Structured Name	Send Referral
Type	State Transition
State Transition	Referral completion

  

The requester changes the status of a referral to ‘complete’.  The referral statement is sent to eBS.

 

 

5    Interaction Diagrams

5.1    Maintenance Interactions

5.2    Service Request Interactions

5.3    Appointment Interactions

 

6    Interactions

6.1    Request Service - PRPA_IN010000UK07

A request from a Service Requestor to the eBooking Service (eBS) for a Service Request Number known as a Unique Booking Reference Number (UBRN)

 

Sending Role	eBS Service Requestor	PRPA_AR010000UK01
Receiving Role	eBS Service Request Manager	PRPA_AR020000UK01
Trigger Event	Request eBooking Service	PRPA_TE010000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Request Service	PRPA_MT010101UK04

 

 

Receiver Responsibilities

Reason	Interaction
eBS confirms the request with a Confirm Service Request containing a UBRN for the service and using the Application acknowledgement wrapper.	Send Confirm Service Request PRPA_IN020000UK06

 

6.2    Confirm Service Request - PRPA_IN020000UK06

A positive response to the Service Request. This is fulfilled by the sending of a UBRN to the requesting system.

 

Sending Role	eBS Service Request Manager	PRPA_AR020000UK01
Receiving Role	eBS Service Requestor	PRPA_AR010000UK01
Trigger Event	Respond Service Request	PRPA_TE020000UK01
Transmission Wrapper	Application Acknowledgement	MCCI_MT020101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Confirm Service Request	PRPA_MT020101UK01

 

 

Receiver Responsibilities

Reason	Interaction
Application acceptance	Application Acknowledgement MCCI_IN010000UK13

 

6.3    Request Appointment Confirmation - PRSC_IN040000UK08

On selection of a service and an appointment, the eBS will request a confirmation of the service from the fulfiller that the appointment service will be provided.

 

Sending Role	eBS Appointment Manager	PRSC_AR020000UK02
Receiving Role	eBS Service Fulfiller	PRSC_AR030000UK02
Trigger Event	Appointment Service Notification	PRSC_TE040000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Request Appointment Confirmation	PRSC_MT040101UK08

 

 

Receiver Responsibilities

Reason	Interaction
The fulfiller will identify if the appointment is still available and may be booked and respond using an application acknowledgement wrapper	Send Confirm Appointment PRSC_IN050000UK06 OR Send Reject Appointment PRSC_IN060000UK06

 

6.4    Confirm Appointment - PRSC_IN050000UK06

This interaction is between the Fulfiller and the eBS and confirms the Scheduled service.

Note: The message will carry both the USRN generated by the fulfiller and the UBRN

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Appointment Confirmation	PRSC_TE050000UK01
Transmission Wrapper	Application Acknowledgement	MCCI_MT020101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Request Appointment Response	PRSC_MT050101UK03

 

 

Receiver Responsibilities

Reason	Interaction
Application acceptance	Application Acknowledgement MCCI_IN010000UK13

 

6.5    Reject Appointment - PRSC_IN060000UK06

This message will be sent if the Fulfiller cannot fulfil the request.

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Appointment Rejection	PRSC_TE060000UK01
Transmission Wrapper	Application Acknowledgement	MCCI_MT020101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Request Appointment Response	PRSC_MT050101UK03

 

 

Receiver Responsibilities

Reason	Interaction
Receiver Application acknowledges receipt	Application Acknowledgement MCCI_IN010000UK13

 

6.6    Request Appointment Cancellation - PRSC_IN070000UK08

This shall be sent from the eBooking Service to the appointment fulfiller in order to cancel a promised appointment. The UBRN shall be used as the identifier.

 

Sending Role	eBS Appointment Manager	PRSC_AR020000UK02
Receiving Role	eBS Service Fulfiller	PRSC_AR030000UK02
Trigger Event	Appointment Cancellation	PRSC_TE070000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act - State Transition Control	MCAI_MT040101UK03
Message Type	Request Appointment Cancellation	PRSC_MT070101UK05

 

 

Receiver Responsibilities

Reason	Interaction
If the Appointment can be cancelled, a Confirm Appointment Cancellation shall be sent. Otherwise, a Reject Appointment Cancellation shall. Both shall use an application Acknowledgement wrapper	PRSC_IN140000UK06 or PRSC_IN150000UK06

 

6.7    Confirm Appointment Cancellation - PRSC_IN140000UK06

The Fulfiller will notify the eBS Appointment Manager of the successful cancellation of the appointment.

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Request Appointment Cancellation Success	PRSC_TE140000UK01
Transmission Wrapper	Application Acknowledgement	MCCI_MT020101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Appointment Cancellation Response	PRSC_MT140101UK02

 

 

Receiver Responsibilities

Reason	Interaction
The eBS will acknowledge receipt.	Application Acknowledgement MCCI_IN010000UK13

 

6.8    Reject Appointment Cancellation - PRSC_IN150000UK06

The Fulfiller will notify the eBS Appointment Manager that the appointment cancellation request has been rejected.

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Request Appointment Cancellation Failure	PRSC_TE150000UK01
Transmission Wrapper	Application Acknowledgement	MCCI_MT020101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Appointment Cancellation Response	PRSC_MT140101UK02

 

 

Receiver Responsibilities

Reason	Interaction
The eBS will acknowledge receipt.	Application Acknowledgement MCCI_IN010000UK13

 

6.9    Notify Appointment Cancellation - PRSC_IN130000UK07

This shall be sent from the appointment fulfiller to eBS in order to cancel a promised appointment.  The USRN shall be used as the identifier.

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Appointment Cancellation event	PRSC_TE130000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Notify Appointment Cancellation	PRSC_MT130101UK03

 

 

Receiver Responsibilities

Reason	Interaction
An Accept Acknowledgement shall be sent	Application Acknowledgement MCCI_IN010000UK13

 

6.10    Request Available Slots - PRSC_IN080000UK07

The eBS may request an update of available services from a fulfiller.

 

Sending Role	eBS Appointment manager	PRSC_AR020000UK02
Receiving Role	eBS Service Fulfiller	PRSC_AR030000UK02
Trigger Event	Update Available slots cache	PRSC_TE080000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Request Available Slots	PRSC_MT080101UK04

 

 

Receiver Responsibilities

Reason	Interaction
Application acceptance	Application Acknowledgement MCCI_IN010000UK13
The Fulfiller shall identify appointment slots that meet the requested criteria.	Respond Available Slots PRSC_IN090000UK09

 

6.11    Respond Available Slots - PRSC_IN090000UK09

The Fulfiller will respond to any query for available scheduled services with an update notification message.

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Available Slot Response	PRSC_TE090000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Respond Available Slots	PRSC_MT090101UK08

 

 

Receiver Responsibilities

Reason	Interaction
Application acceptance	Application Acknowledgement MCCI_IN010000UK13

 

6.12    Notify Slot Cancellation - PRSC_IN100000UK06

This is an interaction where the Fulfiller cancels one or more scheduled Service Slots (not yet booked). It cannot be rejected as the Fulfiller is the holder of the Scheduled Appointment. The USRN shall be used as the identifier.

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Cancel Slot Availability	PRSC_TE100000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Notify Slot Cancellation	PRSC_MT100101UK02

 

 

Receiver Responsibilities

Reason	Interaction
Application acceptance	Application Acknowledgement MCCI_IN010000UK13

 

6.13    Notify Appointment Did Not Attends - PRSC_IN110000UK08

The Service Fulfiller will inform the eBS of any Did Not Attend statuses for confirmed Scheduled Services. This may consist of one or more Scheduled Appointment DNAs in a single ‘list’. The UBRN will be used as the identifier for the DNA Appointment

 

Sending Role	eBS Service Fulfiller	PRSC_AR030000UK02
Receiving Role	eBS Appointment Manager	PRSC_AR020000UK02
Trigger Event	Notification of DNAs	PRSC_TE110000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Notify Did Not Attends	PRSC_MT110101UK06

 

 

 

Receiver Responsibilities

Reason	Interaction
The eBooking Service shall acknowledge receipt	Application Acknowledgement MCCI_IN010000UK13

 

6.14    Notify Patient Referral - PRPA_IN030000UK08

The Requestor will notify the eBS of the referral information on the patient

 

Sending Role	eBS Service Requestor	PRPA_AR010000UK01
Receiving Role	eBS Service Request Manager	PRPA_AR020000UK01
Trigger Event	Send Referral	PRPA_TE030000UK01
Transmission Wrapper	Send Message Payload	MCCI_MT010101UK12
Control Act Wrapper	Control Act	MCAI_MT040101UK03
Message Type	Referral	PRPA_MT030101UK05

 

 

 

Receiver Responsibilities

Reason	Interaction
The eBooking Service shall acknowledge receipt	Application Acknowledgement MCCI_IN010000UK13

 

 

7    Message Definitions

7.1    Request Service - PRPA_MT010101UK04

This message is designed to allow the Service Requestor, e.g. the GP, to request a service from the eBooking Service. The eBS responds with a Service Order number called the UBRN. On receipt of this, the Requestor may proceed with a booking of an appointment.

 

NB. Fields depicting those demographic details which will be picked up from PDS shall  NOT be populated, and will be removed in a later version of the MiM.

 

               

 

7.2    Confirm Service Request - PRPA_MT020101UK01

The Confirm Service Request message conveys a UBRN from the eBooking Service to the Service Requestor. This identifier is used to link the referral to the request.

 

               

 

7.3    Request Appointment Confirmation - PRSC_MT040101UK08

Once the Service requestor or Electronic Booking Manager has identified a suitable appointment slot on the eBooking system, a message is sent to the Service Fulfiller to ensure that the appointment slot is still available. In the event that it is, the eBooking service will receive a confirmation message confirming that it is now booked for the patient. If the slot is not available, a Rejection message is sent.

 

NB. Fields depicting those demographic details which will be picked up from PDS shall  NOT be populated, and will be removed in a later version of the MiM.

 

 

               

 

7.4    Request Appointment Response - PRSC_MT050101UK03

This is a response to the Request Appointment Confirmation message and has two functions. It is sent if the appointment is available and has now been booked for the patient or it is sent if the requested appointment slot is no longer available and cannot be booked for the patient.

 

               

 

7.5    Request Appointment Cancellation - PRSC_MT070101UK05

This message is sent from eBS to the Fulfiller in order to cancel a booked appointment. It does not cancel the slot itself but cancels a specific appointment for a patient

 

                

 

7.6    Appointment Cancellation Response - PRSC_MT140101UK02

This is a response to the Request Appointment Cancellation message and has two functions. It is sent to confirm that the appointment has been cancelled by the Fulfiller or it is sent if the appointment has NOT been cancelled by the Fulfiller for some reason.

 

              

 

7.7    Notify Appointment Cancellation - PRSC_MT130101UK03

Appointments booked by the eBS which are cancelled by the Fulfiller are notified to the eBS Appointment Manager. Local arrangements will dictate the business process for notification of the appointment cancellation to the patient.

 

               

 

7.8    Request Available Slots - PRSC_MT080101UK04

This is a message sent by eBS in order to request an update of the available slots for a particular clinic.

 

               

 

7.9    Respond Available Slots - PRSC_MT090101UK08

This message is sent in response to a Request Available Slots message and will either contain a number of available slots or no available slots. The message is returned with no available slots if none are found that meet the criteria passed in the request.

 

               

 

7.10    Notify Slot Cancellation - PRSC_MT100101UK02

The Fulfiller system will send a Notify Slot Cancellation in order to update the eBS if a slot or slots becomes unavailable.

 

               

 

7.11    Notify Did Not Attend - PRSC_MT110101UK06

This message is generated by each Fulfiller following a clinic and passes a list of appointments which have not been kept. The UBRN is used as the identifier.

 

               

 

7.12    Referral - PRPA_MT030101UK05

The Referral message is passed from the Service Requester to the eBS following the receipt of a Confirm Service Request message. The Referral carries a ‘Clinical Statement’ pertaining to the patient and categorises components according to the role that they are playing in the statement (see below) either individually or as members of a Compound Statement.

 

Kind of referral component →	Compound statement (see note above)	Observation	Narrative	Procedure	Medication
Refer. category header ↓
Problem being referred	yes	yes	yes	-	-
Investigation	yes	yes	yes	-	-
Examination	yes	yes	yes	-	-
Current Medication	yes	-	yes	-	yes
Allergy	yes	yes	yes	-	-
Intolerance	yes	yes	yes	-	-
Risk to Others	yes	yes	yes	-	-
Alcohol consumption	yes	yes	yes	-	-
Smoking habit	yes	yes	yes	-	-
Non therapeutic drug use	yes	yes	yes	-	-
Medication	yes	-	yes	-	yes
Condition	yes	yes	yes	-	-
Diagnoses	yes	yes	yes	-	-
Procedure	yes	yes	yes	yes	-
Family History	yes	yes	yes	-	-
Housing	yes	yes	yes	-	-
Employment	yes	yes	yes	-	-
Religion	yes	yes	yes	-	-
Ethnic Origin	yes	yes	yes	-	-
Language	yes	yes	yes	-	-

 

               

---

 

8    Glossary of Terms

Application Acknowledgement	A response from one application to another indicating that a message has been received and is valid.
Application Role	The role played by the application in a particular interaction.
Appointment	A time at which an encounter is scheduled to take place.
Appointment Slot	A Clinic slot that has been assigned to a patient for an appointment encounter.
Business Acknowledgement	A response to a communication initiated by the application for business reasons.
Provider	An alternative term for a fulfiller
Requestor	The HCP responsible for the request.
Service	The actual appointment with a specific HCP at a specific clinic
Service Fulfiller	The clinic within an organisation that will provide the requested service
Service Requestor	The application placing the request with the eBooking Service
Slot	A time span for a specific Clinic which is available for booking as an appointment
Unique Appointment Slot Reference Number (USRN)	An identifier unique to a particular instance of an appointment slot. There may be many concurrent appointment slots for any particular clinic. Each will be uniquely identified.
Unique Booking Reference Number (UBRN)	A unique identifier for a request for a service. In this case it identifies the instance of the request to book an appointment

 

---

 

9    Changes for v3.5

9.1    Changes to Interactions.

 

• Interaction diagrams updated to reference current interactions.

• Changed transmission wrapper to new version - MCCI_MT010101UK12.

• Changed Application Acknowledgement interaction to new version - MCCI_IN010000UK13.

• Changed Control Act Wrapper to new version - MCAI_MT040101UK03.

• Removal of Interaction Index section.