Choose and Book Implementation Manual

Programme

NPFIT

DOCUMENT NUMBER

Sub-Prog/Project

Comms & Messaging

NPFIT-FNT-TO-DPM-0602

Prog. Director

Paul Jones

Sub-Prog/Proj Mgr

Ken Lunn

Author

C&M Development Team

Version No.

4.1

Contact

Richard Kavanagh

Status

Issued

 


 

Contents

1    Overview
2    Storyboards
     2.1    Book now - Refer now
     2.2    Book Now - Refer Later
     2.3    Book Later - Refer Later
     2.4    Find the Referrals associated with the patient
3    Application Roles
     3.1    Choose and Book Service Requestor - PRPA_AR010000UK02
     3.2    Choose and Book Service
          3.2.1    Choose and Book Service Request Manager - PRPA_AR020000UK02
          3.2.2    Choose and Book Service Appointment Manager - PRSC_AR020000UK03
     3.3    Choose and Book Service Fulfiller - PRSC_AR030000UK03
     3.4    Choose and Book Referral Queries
          3.4.1    Choose and Book Service Outline Referral Query Placer - QUSC_AR000001UK02
          3.4.2    Choose and Book Service Outline Referral Query Fulfiller - QUSC_AR000002UK02
          3.4.3    Choose and Book Service Detailed Referral Query Placer - QUSC_AR000003UK01
          3.4.4    Choose and Book Service Detailed Referral Query Fulfiller - QUSC_AR000004UK01
4    Trigger Events
     4.1    Request Choose and Book Service - PRPA_TE010000UK01
     4.2    Respond Service Request - PRPA_TE020000UK01
     4.3    Appointment Service Notification - PRSC_TE040000UK01
     4.4    Appointment Confirmation - PRSC_TE050000UK01
     4.5    Appointment Rejection - PRSC_TE060000UK01
     4.6    Appointment Cancellation - PRSC_TE070000UK01
     4.7    Request Appointment Cancellation Success - PRSC_TE140000UK01
     4.8    Request Appointment Cancellation Failure - PRSC_TE150000UK01
     4.9    Appointment Cancellation event - PRSC_TE130000UK01
     4.10    Update Available slots cache - PRSC_TE080000UK01
     4.11    Available Slot Response - PRSC_TE090000UK01
     4.12    Cancel Slot Availability - PRSC_TE100000UK01
     4.13    Notification of DNAs - PRSC_TE110000UK01
     4.14    Send Referral - PRPA_TE030000UK01
     4.15    Outline Referral Query - QUSC_TE000001UK01
     4.16    Outline Referral Response - PRPA_TE000001UK01
     4.17    Detailed Referral Query - QUSC_TE000002UK01
     4.18    Detailed Referral Response - PRPA_TE000002UK01
5    Interaction Diagrams
     5.1    Maintenance Interactions
     5.2    Service Request Interactions
     5.3    Appointment Interactions
     5.4    Referral Query Interactions
          5.4.1    Outline Referral Query Interactions
          5.4.2    Detailed Referral Query Interactions
6    Interactions
     6.1    Request Service - PRPA_IN010000UK09
     6.2    Confirm Service Request - PRPA_IN020000UK08
     6.3    Request Appointment Confirmation - PRSC_IN040000UK11
     6.4    Confirm Appointment - PRSC_IN050000UK08
     6.5    Reject Appointment - PRSC_IN060000UK08
     6.6    Request Appointment Cancellation - PRSC_IN070000UK10
     6.7    Confirm Appointment Cancellation - PRSC_IN140000UK08
     6.8    Reject Appointment Cancellation - PRSC_IN150000UK08
     6.9    Notify Appointment Cancellation - PRSC_IN130000UK09
     6.10    Request Available Slots - PRSC_IN080000UK09
     6.11    Respond Available Slots - PRSC_IN090000UK11
     6.12    Notify Slot Cancellation - PRSC_IN100000UK08
     6.13    Notify Appointment Did Not Attends - PRSC_IN110000UK10
     6.14    Notify Patient Referral - PRPA_IN030000UK10
     6.15    Outline Referral Query - QUSC_IN000001UK02
     6.16    Outline Referral Response - PRPA_IN000001UK02
     6.17    Detailed Referral Query - QUSC_IN000002UK02
     6.18    Detailed Referral Response - PRPA_IN000002UK02
7    Message Definitions
     7.1    Request Service - PRPA_MT010101UK06
     7.2    Confirm Service Request - PRPA_MT020101UK01
     7.3    Request Appointment Confirmation - PRSC_MT040101UK11
     7.4    Request Appointment Response - PRSC_MT050101UK03
     7.5    Request Appointment Cancellation - PRSC_MT070101UK07
     7.6    Appointment Cancellation Response - PRSC_MT140101UK02
     7.7    Notify Appointment Cancellation - PRSC_MT130101UK04
     7.8    Request Available Slots - PRSC_MT080101UK04
     7.9    Respond Available Slots - PRSC_MT090101UK08
     7.10    Notify Slot Cancellation - PRSC_MT100101UK02
     7.11    Notify Did Not Attend - PRSC_MT110101UK07
     7.12    Referral - PRPA_MT030101UK06
     7.13    Outline Referral Query - QUSC_MT000001UK01
     7.14    Outline Referral Response - PRPA_MT000001UK02
     7.15    Detailed Referral Query - QUSC_MT000002UK01
     7.16    Detailed Referral Response - PRPA_MT000002UK02
8    Glossary of Terms
9    Change Log
     9.1    Changes for v4.1
     9.2    Changes for v4.0
     9.3    Changes for v3.7

 


 

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.

3.6

Core Technical Team

15/03/2005

Change requests MIM-CR-0424 and 0456

3.7

Core Technical Team

30/06/2005

Change requests MIM-CR-0553 and 0554

4.0 Core Technical Team 30/06/2006 Changes from W5 v 3.6.
Change requests MIM-CR-0549, MIM-CR-0624, MIM-CR-0637, MIM-CR-0663, MIM-CR-0683

From CIM v 1.2, addition of two new query pairs: OutlineReferralQuery/Response, DetailedReferralQuery/Response
4.1 Core Technical Team 31/10/2006 Changes from W5 v3.7.
Change requests: MIM-CR-0725, MIM-CR-0726, MIM-CR-0727, MIM-CR-0728, MIM-CR-0729, MIM-CR-0730
Changes from CIM v2.2

 


 

1    Overview

The Choose and Book Service provides a mechanism for primary care providers to register a service request for a patient. It allows providers to 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 Service 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 Choose and Book 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 painkillers, 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 outpatient 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 Choose and Book option on his local system. A Request for Service interaction ensues and a message is sent to Choose and Book with Mrs. Alan’s NHS Number. Choose and Book responds with a Confirm Service Request message containing a Unique Booking Reference Number (UBRN).

 

After the UBRN is received, Choose and Book is launched with the UBRN allowing a seamless transition directly into the context of the UBRN.

 

Choose and Book allows Dr. Evans to indicate if the patient has additional requirements. In this case transport is required. Dr. Evans indicates this on the referral.

 

Dr. Evans uses the Choose and Book search facility to locate services in the local 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.

 

Once an appointment has been selected, the Choose and Book 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. Choose and Book sends the local hospital system an Application Acknowledgement message to indicate that it should now book the appointment. Choose and Book can now confirm that the appointment has been booked and Dr. Evans prints out the appointment details and any requirements stipulated by the clinic for Mrs. Alan to take home. The additional requirements manager at the hospital also has an item on his worklist to arrange transport for Mrs. Alan.

 

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

 

The additional requirements manager at the hospital actions the worklist item to arrange transport for Mrs. Alan’s appointment using existing procedures and records this on Choose and Book. He contacts Mrs. Alan to confirm the transport arrangements with her.

 

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 Primary Care Trust (PCT) has chosen to make the orthopaedic services available through Choose and Book, on which the appropriate clinics have been configured, and the Patient Administration System (PAS) in the hospital has been upgraded to receive and send booking messages.

 

In a separate nightly batch process, Choose and Book requests each hospital PAS to send the available slots for each service. In response to the request the PAS notifies Choose and Book of the available slots.

 

The day before the appointment, Mrs. Alan rings the Choose and Book Appointments Line and informs them that she cannot make the appointment as she is suffering from severe diarrhoea. Choose and Book sends a request to the hospital to cancel the appointment and receives a confirmation back. The cancellation of the appointment triggers a worklist item on Choose and Book to inform the additional requirements manager of the need to cancel the transport that has previously been arranged.

 

The Appointments Line agent looks for a new appointment time for Mrs. Alan and books a new appointment a couple of days later as there has been a cancellation. Booking the appointment triggers another new worklist item to arrange transport for the new appointment time.

 

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. Before he drives out, Dr. Evans checks her appointment record on his GP system, which has retrieved the latest status of the referral from Choose and Book, and he sees that she has had an appointment which was not 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 letter 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 Choose and Book.

 

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 to the GP system and selects the patient’s record. She locates the referral to Mr. Daniels using the UBRN and enters the referral information. Dr. Evans logs onto the system the next day before the surgery and reviews the letter before sending. On completion of Dr. Evans’ review, the GP system sends the Referral electronically, as an encrypted communication, to Choose and Book where it is validated and stored. Choose and Book sends the GP system an Application Acknowledgement message to confirm that the referral has been updated. 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 chest pain. Although the symptom has been present for several months, Dr. Green is concerned that his patient may be experiencing angina. 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 GP system, he then searches for the correct SNOMED code for chest pain. Dr. Green selects the Choose and Book option and the SNOMED code is sent in the Request for Service to obtain a UBRN. After obtaining a UBRN from Choose and Book, Dr. Green is able to transition from his GP system to Choose and Book directly into the context of the referral.

 

As a SNOMED code was provided in the request, Choose and Book has already searched for the required services and they are displayed on the Choose and Book screen which is presented to Dr. Green.

 

Mr. Wilson asks for an appointment as soon as possible and is happy to travel to attend as he can drive himself. Dr. Green searches the locally commissioned services and does not find an early appointment, so he widens the search to include the extended choice providers. A Foundation Trust hospital 30 miles away is able to offer an appointment slot in 2 weeks and Mr. Wilson is willing to travel to this hospital. At this time, Mr. Wilson cannot be sure that he can be available for the early slot so Dr. Green prints out information on the locally commissioned services and the extended choice provider without making an appointment. Dr. Green advises Mr. Wilson to telephone the Choose and Book Appointments Line 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 Appointments Line quoting the UBRN as requested. The agent searches for, and finds, the UBRN on Choose and Book. Mr. Wilson provides his patient password to authenticate himself with the Appointments Line. Mr. Wilson agrees an appointment time with the Foundation Trust hospital. Choose and Book 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 agent reviews the other appointments available on Choose and Book 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. Choose and Book sends the local hospital system an Application Acknowledgement message to indicate that it should now book the appointment. The Appointments Line agent confirms with Mr. Wilson that the appointment has been booked and that the clinic requires him to take a sample of urine with him when he attends.

 

The laboratory carries out the tests requested by Dr. Green and sends 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 results significant to the referral. On completion, the referral message is encrypted and sent to Choose and Book where it is validated and stored. As an appointment has already been booked the referral letter is visible immediately on the hospital PAS.

 

The Cardiac Outpatients Clinic review their appointments 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 (the consultant) 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 Choose and Book. As the appointment slot has now been made unavailable by the service provider (the clinic), an additional Slot Cancellation is sent to Choose and Book to ensure that the slot is not offered to anyone else. The administrator searches for new appointments on Choose and Book and contacts Mr. Wilson. They agree on a new appointment time. As before, this is requested by Choose and Book and confirmed electronically by the hospital PAS. Choose and Book sends the local hospital system an Application Acknowledgement message to indicate that it should now book the appointment.

 

Mr. Wilson does not attend his appointment on the agreed date. The hospital PAS notifies Choose and Book with a Did Not Attend communication and an administrator from the hospital contacts 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.

 

2.4    Find the Referrals associated with the patient

Mr. Smythe has recently registered with his General Practitioner, Dr. Oakes. On a recent visit to his previous GP, Mr. Smythe was referred to a urologist for recurrent urinary infection. Mr. Smythe has booked an appointment for this referral but cannot remember the exact date of the appointment. As Mr. Smythe thinks his condition has deteriorated, Dr. Oakes would like to know the exact reason for Mr. Smythe’s referral from his previous GP’s referral letter and the date of the current appointment.

 

Dr. Oakes uses his GP system to request outline information on the current referrals for Mr. Smythe from Choose and Book. Choose and Book responds with the outline information for Mr. Smythe’s referrals. Dr. Oakes’ GP system receives the response from Choose and Book and formats the information for display. Dr. Oakes notices that the appointment for Mr. Smythe’s previous referral is in 10 days' time and decides to review the referral letter. The referral letter is only available when requesting the full detail of the referral. Dr. Oakes' GP system places a request with Choose and Book for the full detail of the referral including the clinical information.

 

Choose and Book sends the full detail of the referral to Dr. Oakes’ GP system which formats the information for display. Dr. Oakes reviews the original referral letter from Mr. Smythe’s previous GP and decides to look on Choose and Book to see if there is an earlier appointment.

 

Dr. Oakes locates Mr. Smythe’s referral on Choose and Book and determines that there is an earlier appointment at the same priority. Dr. Oakes asks Mr. Smythe if he would like to attend an earlier appointment for his original referral. Mr. Smythe agrees and Dr. Oakes rebooks the appointment and prints out a new appointment summary for Mr. Smythe. As part of the rebook operation, Choose and Book automatically cancels the previous booking.

 

3    Application Roles

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

 

3.1    Choose and Book Service Requestor - PRPA_AR010000UK02

The Service Requestor is the initiator of any Choose and Book Service request and will request services from a fulfiller via the intermediary Choose and Book 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 Choose and Book Service.

 

Choose and Book Service Requestor Interactions. View Interaction

 

 

3.2    Choose and Book Service

The Choose and Book 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 Choose and Book 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 Choose and Book 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    Choose and Book Service Request Manager - PRPA_AR020000UK02

In this role, the Choose and Book 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.

 

Choose and Book Service Request Manager Interactions.

 

 

3.2.2    Choose and Book Service Appointment Manager - PRSC_AR020000UK03

In this role, the Choose and Book Service 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

 

Choose and Book Service Appointment Manager Interactions. View Interaction

 

 

3.3    Choose and Book Service Fulfiller - PRSC_AR030000UK03

The Service Fulfiller Application role will provide Appointment services for specific clinics to the Choose and Book 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 Choose and Book Service. No requirement has been identified for the unsolicited updating of the Choose and Book Service either for slots that have been booked or changes to already advertised slots.

 

Choose and Book Service Fulfiller Interactions. View Interaction

3.4    Choose and Book Referral Queries

3.4.1    Choose and Book Service Outline Referral Query Placer - QUSC_AR000001UK02

The Outline Referral Query Placer application role is responsible for placing queries requesting outline information regarding referral status with the Choose and Book system.

 

Choose and Book Service Outline Referral Query Interactions.

3.4.2    Choose and Book Service Outline Referral Query Fulfiller - QUSC_AR000002UK02

The Outline Referral Query Fulfiller application role provides responses to queries for outline information regarding referral status with the Choose and Book system.

 

Choose and Book Service Outline Referral Query Interactions.

 

3.4.3    Choose and Book Service Detailed Referral Query Placer - QUSC_AR000003UK01

The Detailed Referral Query Placer application role is responsible for placing queries requesting detailed information regarding specific referrals with the Choose and Book system.

Choose and Book Service Detailed Referral Query Interactions.

3.4.4    Choose and Book Service Detailed Referral Query Fulfiller - QUSC_AR000004UK01

The Detailed Referral Query Fulfiller application role provides responses to queries for detailed information regarding specific referrals with the Choose and Book system.

The Detailed Referral Query Fulfiller returns either administrative information or administrative and clinical information, depending on what the system user has requested/is authorised to see.

In the case of an error with the response, the fulfiller will return the patient's NHS number, the referral UBRN and an error code (the error code will be contained in the Control Act wrapper MCAI_MT040101UK03).

Choose and Book Service Detailed Referral Query Interactions.


 

4    Trigger Events

4.1    Request Choose and Book Service - PRPA_TE010000UK01

 

Structured Name

Request Choose and Book 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 Choose and Book Service 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 Choose and Book Service 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 Choose and Book Service. 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 the Choose and Book Service. 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 Choose and Book Service 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 Choose and Book Service 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 the Choose and Book Service 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 the Choose and Book Service 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 the Choose and Book Service.

 

4.15    Outline Referral Query - QUSC_TE000001UK01

 

Structured Name

Outline Referral Query

Type 

Query

 

The query originator has initiated a query to obtain outline information about referrals for a specific NHS number.

4.16    Outline Referral Response - PRPA_TE000001UK01

 

Structured Name

Outline Referral Response

Type 

Response

 

Information has been found within the Choose and Book system which satisfies the specified search criteria defined in the Outline Referral Query.

4.17    Detailed Referral Query - QUSC_TE000002UK01

 

Structured Name

Detailed Referral Query

Type 

Query

 

The query originator has initiated a query to obtain detailed information about a referral for a specific UBRN and NHS number.

4.18    Detailed Referral Response - PRPA_TE000002UK01

 

Structured Name

Detailed Referral Response

Type 

Response

 

Information has been found within the Choose and Book system which satisfies the specified search criteria defined in the Detailed Referral Query.

 


 

5    Interaction Diagrams

5.1    Maintenance Interactions

5.2    Service Request Interactions


5.3    Appointment Interactions

5.4    Referral Query Interactions

5.4.1    Outline Referral Query Interactions

5.4.2    Detailed Referral Query Interactions



 

6    Interactions

6.1    Request Service - PRPA_IN010000UK09

A request from a Service Requestor to the Choose and Book Service for a Service Request Number known as a Unique Booking Reference Number (UBRN)

 

Sending Role

Choose and Book Service Requestor

PRPA_AR010000UK02

Receiving Role

Choose and Book Service Request Manager

PRPA_AR020000UK02

Trigger Event

Request Choose and Book Service

PRPA_TE010000UK01

Transmission Wrapper

Send Message Payload

MCCI_MT010101UK12

Control Act Wrapper

Control Act

MCAI_MT040101UK03

Message Type

Request Service

PRPA_MT010101UK06

 

 

Receiver Responsibilities

Reason

Interaction

The Choose and Book Service 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_IN020000UK08

 

6.2    Confirm Service Request - PRPA_IN020000UK08

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

 

Sending Role

Choose and Book Service Request Manager

PRPA_AR020000UK02

Receiving Role

Choose and Book Service Requestor

PRPA_AR010000UK02

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_IN040000UK11

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

 

Sending Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

Receiving Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

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_MT040101UK11

 

 

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_IN050000UK08

OR

Send Reject Appointment

PRSC_IN060000UK08

 

6.4    Confirm Appointment - PRSC_IN050000UK08

This interaction is between the Fulfiller and the Choose and Book Service and confirms the Scheduled service.

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

 

Sending Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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_IN060000UK08

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

 

Sending Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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_IN070000UK10

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

 

Sending Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

Receiving Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

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_MT070101UK07

 

 

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_IN140000UK08

or

PRSC_IN150000UK08

 

6.7    Confirm Appointment Cancellation - PRSC_IN140000UK08

The Fulfiller will notify the Choose and Book Service Appointment Manager of the successful cancellation of the appointment.

 

Sending Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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 Choose and Book Service will acknowledge receipt.

Application Acknowledgement

MCCI_IN010000UK13

 

6.8    Reject Appointment Cancellation - PRSC_IN150000UK08

The Fulfiller will notify the Choose and Book Service Appointment Manager that the appointment cancellation request has been rejected.

 

Sending Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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 Choose and Book Service will acknowledge receipt.

Application Acknowledgement

MCCI_IN010000UK13

 

6.9    Notify Appointment Cancellation - PRSC_IN130000UK09

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

 

Sending Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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_MT130101UK04

 

 

Receiver Responsibilities

Reason

Interaction

An Accept Acknowledgement shall be sent

Application Acknowledgement

MCCI_IN010000UK13

 

6.10    Request Available Slots - PRSC_IN080000UK09

The Choose and Book Service may request an update of available services from a fulfiller.

 

Sending Role

Choose and Book Service Appointment manager

PRSC_AR020000UK03

Receiving Role

Choose and Book Service Service Fulfiller

PRSC_AR030000UK03

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_IN090000UK11

 

6.11    Respond Available Slots - PRSC_IN090000UK11

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

 

Sending Role

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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_IN100000UK08

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

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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_IN110000UK10

The Service Fulfiller will inform the Choose and Book Service 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

Choose and Book Service Fulfiller

PRSC_AR030000UK03

Receiving Role

Choose and Book Service Appointment Manager

PRSC_AR020000UK03

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_MT110101UK07

 

 

 

Receiver Responsibilities

Reason

Interaction

The Choose and Book Service shall acknowledge receipt

Application Acknowledgement

MCCI_IN010000UK13

 

6.14    Notify Patient Referral - PRPA_IN030000UK10

The Requestor will notify the Choose and Book Service of the referral information on the patient

 

Sending Role

Choose and Book Service Requestor

PRPA_AR010000UK02

Receiving Role

Choose and Book Service Request Manager

PRPA_AR020000UK02

Trigger Event

Send Referral

PRPA_TE030000UK01

Transmission Wrapper

Send Message Payload

MCCI_MT010101UK12

Control Act Wrapper

Control Act

MCAI_MT040101UK03

Message Type

Referral

PRPA_MT030101UK06

 


 

 

Receiver Responsibilities

Reason

Interaction

The Choose and Book Service shall acknowledge receipt

Application Acknowledgement

MCCI_IN010000UK13

 

6.15    Outline Referral Query - QUSC_IN000001UK02

This interaction occurs when a system user makes a request for outline information about any referrals for a specific NHS number.

 

Sending Role

Choose and Book Outline Referral Query Placer

QUSC_AR000001UK02

Receiving Role

Choose and Book Outline Referral Query Fulfiller

QUSC_AR000002UK02

Trigger Event

Outline Referral Query

QUSC_TE000001UK01

Transmission Wrapper

Send Message Payload

MCCI_MT010101UK12

Control Act Wrapper

Control Act

MCAI_MT040101UK03

Message Type

Outline Referral Query

QUSC_MT000001UK01

 

 

 

 

 

 

 

This interaction may be batched using the generic batching mechanism described in the Infrastructure domain.

Click here for details of this mechanism.

 

Receiver Responsibilities

Reason

Interaction

Query data found

Outline Referral Response

PRPA_IN000001UK02

Query failed

Query Act Failed

QUQI_IN010000UK14

 

6.16    Outline Referral Response - PRPA_IN000001UK02

This interaction occurs when the Choose and Book Response Fulfiller responds with a message containing outline information about any referrals for a specific NHS number.

 

Sending Role

Choose and Book Outline Referral Query Fulfiller

QUSC_AR000002UK02

Receiving Role

Choose and Book Outline Referral Query Placer

QUSC_AR000001UK02

Trigger Event

Outline Referral Response

PRPA_TE000001UK01

Transmission Wrapper

Send Message Payload

MCCI_MT010101UK12

Control Act Wrapper

Control Act

MCAI_MT040101UK03

Message Type

Outline Referral Response

PRPA_MT000001UK02

 

 

 

 

 

 

 

Reason

Interaction

The Choose and Book Service shall acknowledge receipt

Application Acknowledgement

MCCI_IN010000UK13

 

This interaction may be batched in response to a batched Outline Referral Query interaction, using the generic batching mechanism described in the Infrastructure domain. Click here for details of this mechanism.

 

6.17    Detailed Referral Query - QUSC_IN000002UK02

This interaction occurs when a system user makes a request for detailed information about a referral for a specific UBRN and NHS number.

 

Sending Role

Choose and Book Detailed Referral Query Placer

QUSC_AR000003UK01

Receiving Role

Choose and Book Detailed Referral Query Fulfiller

QUSC_AR000004UK01

Trigger Event

Detailed Referral Query

QUSC_TE000002UK01

Transmission Wrapper

Send Message Payload

MCCI_MT010101UK12

Control Act Wrapper

Control Act

MCAI_MT040101UK03

Message Type

Detailed Referral Query

QUSC_MT000002UK01

 

 

 

 

 

 

 

 

This interaction may be batched using the generic batching mechanism described in the Infrastructure domain.

Click here for details of this mechanism.

 

Receiver Responsibilities

Reason

Interaction

Query data found

Detailed Referral Response

PRPA_IN000002UK02

Query failed

Query Act Failed

QUQI_IN010000UK14

 

6.18    Detailed Referral Response - PRPA_IN000002UK02

 

This interaction occurs when the Choose and Book Response Fulfiller responds with a message containing detailed information about a referral for a specific UBRN and NHS number.

 

Sending Role

Choose and Book Detailed Referral Query Fulfiller

QUSC_AR000004UK01

Receiving Role

Choose and Book Detailed Referral Query Placer

QUSC_AR000003UK01

Trigger Event

Detailed Referral Response

PRPA_TE000002UK01

Transmission Wrapper

Send Message Payload

MCCI_MT010101UK12

Control Act Wrapper

Control Act

MCAI_MT040101UK03

Message Type

Detailed Referral Response

PRPA_MT000002UK02

 

 

 

 

 

 

 

 

 

 

Reason

Interaction

The Choose and Book Service shall acknowledge receipt

Application Acknowledgement

MCCI_IN010000UK13

 

This interaction may be batched in response to a batched Detailed Referral Query interaction, using the generic batching mechanism described in the Infrastructure domain. Click here for details of this mechanism.

 


7    Message Definitions

7.1    Request Service - PRPA_MT010101UK06

This message is designed to allow the Service Requestor, e.g. the GP, to request a service from the Choose and Book Service . The Choose and Book Service 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.

 

View R-MIM     View Tabular View         View Example

 

7.2    Confirm Service Request - PRPA_MT020101UK01

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

 

View R-MIM     View Tabular View         View Example

 

7.3    Request Appointment Confirmation - PRSC_MT040101UK11

Once the Service requestor or Choose and Book Manager has identified a suitable appointment slot on the Choose and Book Service, a message is sent to the Service Fulfiller to ensure that the appointment slot is still available. In the event that it is, the Choose and Book 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.

 

 

View R-MIM     View Tabular View         View Example

 

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.

 

View R-MIM     View Tabular View         View Example

 

7.5    Request Appointment Cancellation - PRSC_MT070101UK07

This message is sent from the Choose and Book Service 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

 

View R-MIM     View Tabular View         View Example 

 

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.

 

View R-MIM     View Tabular View         View Example

 

7.7    Notify Appointment Cancellation - PRSC_MT130101UK04

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

 

View R-MIM     View Tabular View         View Example

 

7.8    Request Available Slots - PRSC_MT080101UK04

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

 

View R-MIM     View Tabular View         View Example

 

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.

 

View R-MIM     View Tabular View         View Example

 

7.10    Notify Slot Cancellation - PRSC_MT100101UK02

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

 

View R-MIM     View Tabular View         View Example

 

7.11    Notify Did Not Attend - PRSC_MT110101UK07

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.

 

View R-MIM     View Tabular View         View Example

 

7.12    Referral - PRPA_MT030101UK06

The Referral message is passed from the Service Requester to the Choose and Book Service 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

Problems & Issues/Conditions

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

-

-

Consultations

yes

yes

yes

yes

yes

 

View R-MIM     View Tabular View         View Example

 

 

7.13    Outline Referral Query - QUSC_MT000001UK01

A user of the calling application wishes to view outline information about the patient’s referrals held in Choose and Book.

             

 

7.14    Outline Referral Response - PRPA_MT000001UK02

A list of the patient’s referrals is returned from Choose and Book.

             

 

7.15    Detailed Referral Query - QUSC_MT000002UK01

The enquirer wishes to view details of a specific referral for a patient and has access to the relevant UBRN and NHS Number.

            

 

7.16    Detailed Referral Response - PRPA_MT000002UK02

Detail of the referral is returned from Choose and Book.

            
(AppointmentRequest)
(AdviceAndGuidanceRequest)
(UninitialisedRequest)
(DiagnosticAppointmentRequest)


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 Choose and Book 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    Change Log

9.1    Changes for v4.1

General changes

This release incorporates changes outlined in the Choose and Book Referral Status CIM v2.2 as well as in the Choose and Book W5 v3.7.

Also included are changes resulting from issues raised following review of the last release by the Choose and Book business team. However, the new CIM and W5 included revised requirements for areas where issues were raised, and any new requirements have superseded Bugzilla issues where appropriate.

Several CRs were raised for this release, to cover issues raised in Bugzilla. These are as follows:

MIM CR-0725 CABAnnotation codes for acts in Choose and Book query responses

MIM CR-0726 Changes to Outline/Detailed referral status models

MIM CR-0727 Tabular view errors

MIM CR-0728 EhrCompoundLevel description change

MIM CR-0729 References to external vocabularies

MIM CR-0730 Vocabulary amendments

 

IM Section Reference

Artefact Type/Name

Details of changes made

2

Storyboards

 

2.4

Find the referrals associated with a patient

Added two hyperlinks to this section

3

Application roles

 

3.4 Choose and Book referral queries An issue was raised regarding the referral application roles; the business team requested that instead of having a generic pair of application roles which could fulfil outline and detailed requests there should be two pairs of application roles. This has been done. The original application IDs have been retained as the outline application role IDs (up-versioned accordingly), and two new application role IDs have been created for the detailed interactions.

 

Choose and Book referral queries

Referral query application roles have been given the prefix QUSC to conform to other MIM domains.

5 Interaction diagrams  

 

All interaction diagrams

All interaction IDs have been up-versioned for this release, as requested. This was to provide a stable batch of IDs for implementers to work with.

5.4 Referral query interactions As mentioned above in the Application Roles section, the referral application roles have been split into two pairs and the interaction diagrams have been amended accordingly.
6 Interactions  
  All interactions All interaction IDs have been up-versioned for this release, as requested. This was to provide a stable batch of IDs for implementers to work with.
All interaction schemas have been regenerated.

7

Message definitions

 

7.1 Request Service PRPA_MT010101UK06 (formerly UK05) Added 'content sensitive indicator', 'specialty', 'referral reason' and 'request type'. All of these items have also been modelled in the Referral Status messages, and they therefore share elements of design and vocabulary. Changes to example, schema and tabular view as required. These changes were specified in W5 v3.7.
7.3 Request Appointment Confirmation PRSC_MT040101UK11 (formerly UK10) Removed 'callback consent' and 'correspondence suppression'. Added 'clock start time'. Changes to example, schema and tabular view as required. These changes were specified in W5 v3.7.
7.5 Request Appointment Cancellation PRSC_MT070101UK07 (formerly UK06) Removed 'correspondence suppression'. Changes to example, schema and tabular view as required. These changes were specified in W5 v3.7.
7.12 Referral PRPA_MT030101UK06 (formerly UK05) Removed 'priority code'. Changes to example, schema and tabular view as required. These changes were specified in W5 v3.7.
7.14 Outline Referral Response PRPA_MT000001UK02 (formerly UK01) Various changes as detailed in the Choose and Book Referral Status CIM v2.2, including the addition of 'diagnostic appointment request' and 'contact details'.  
General HL7-based message improvements also undertaken - e.g. standardised the use of CaBAnnotation/CriteriaCode in order to identify acts.

Also changes applied according to CRs (detailed in 'General changes' section, above) where appropriate.
7.16 Detailed Referral Response PRPA_MT000002UK02 (formerly UK01) Significant changes necessitating remodelling of this message. Changes are detailed in the Choose and Book Referral Status CIM v2.2.
General HL7-based message improvements also undertaken - e.g. standardised the use of CaBAnnotation/CriteriaCode in order to identify acts; added roles and entities to identify items such as 'named clinician' and 'search postcode'.
Also changes applied according to CRs (detailed in 'General changes' section, above) where appropriate.

9.2    Changes for v4.0

General changes

The major change for this release is the addition of two new message pairs (query/response) for requesting/viewing the referral status of a particular patient's referral/s.

Also for this release, several MIM CRs which affect all existing message artefacts have been carried out. These are as follows:

MIM CR-0549 - eBS Remove example fragments from tab views

MIM CR-0637 - eBS Amend relevant MIMS to force use of 10 digit NHS number

MIM CR-0663 - Re-brand Choose and Book

 

 

IM Section Reference

Artefact Type/Name

Details of changes made

2

Storyboards

 

2.4

Find the referrals associated with a patient

This is a new storyboard added in line with the changes for the new referral query/response messages.

3

Application roles

 

3.1

Choose and Book Service Requestor - PRPA_AR010000UK02 (formerly eBS Service Requestor - PRPA_AR010000UK01)

Renamed in line with MIM CR-0663, and up-versioned accordingly.

3.2.1

Choose and Book Service Request Manager - PRPA_AR020000UK02 (formerly eBS Service Request Manager - PRPA_AR020000UK01)

Renamed in line with MIM CR-0663, and up-versioned accordingly.

3.2.2

Choose and Book Service Appointment Manager - PRSC_AR020000UK03 (formerly eBS Appointment Manager - PRSC_AR020000UK02)

Renamed in line with MIM CR-0663, and up-versioned accordingly.

3.3

Choose and Book Service Fulfiller - PRSC_AR030000UK03 (formerly eBS Service Fulfiller - PRSC_AR030000UK02)

Renamed in line with MIM CR-0663, and up-versioned accordingly.

3.4

Choose and Book Service Referral Query Placer - PRPA_AR000001UK01

New application role

3.5

Choose and Book Service Referral Query Fulfiller - PRPA_AR000002UK01

New application role

4

Trigger events

 

4.15

Outline Referral Query - QUSC_TE000001UK01

New trigger event

4.16

Outline Referral Response - PRPA_TE000001UK01

New trigger event

4.17

Detailed Referral Query - QUSC_TE000002UK01

New trigger event

4.18

Detailed Referral Response - PRPA_TE000002UK01

New trigger event

5

Interaction diagrams

 

5.1

Maintenance Interactions

Interaction diagram regenerated to show up-versioned interaction numbers/application role numbers

5.2

Service Request Interactions

Interaction diagram regenerated to show up-versioned interaction numbers/application role numbers

5.3

Appointment Interactions

Interaction diagram regenerated to show up-versioned interaction numbers/application role numbers

5.4

Referral Query Interactions

New interaction diagram

6

Interactions

 

 

All Existing Interactions

All existing interactions have been up-versioned due to re-branding of the domain which necessitated the up-versioning of all application roles.

6.15

Outline Referral Query - QUSC_IN000001UK01

New interaction

6.16

Outline Referral Response - PRPA_IN000001UK01

New interaction

6.17

Detailed Referral Query - QUSC_IN000002UK01

New interaction

6.18

Detailed Referral Response - PRPA_IN000002UK01

New interaction

7

Message definitions

 

7.1

Request Service - PRPA_MT010101UK05 (formerly UK04)

Removed patient demographics detail; added keyword operator search criteria. Visio, tabular view, schema and example updated and up-versioned for this message. Changes to this message were specified in the Choose and Book W5 v3.5. Other (domain-wide) changes were specified in MIM CR-0549, MIM CR-0637 and MIM CR-0663.

7.5

Request Appointment Cancellation - PRSC_MT070101UK06 (formerly UK05)

Amended cardinality of pertinentAppointmentSlot; added patient role to record NHS number. Visio, tabular view, schema and example updated and up-versioned for this message. Changes to this message and associated artefacts were specified in the Choose and Book W5 v3.5. Other (domain-wide) changes were specified in MIM CR-0549, MIM CR-0637 and MIM CR-0663.

7.7

Notify Appointment Cancellation - PRSC_MT130101UK04 (formerly UK03)

Added patient role to record NHS number; added AppointmentSlot to record UBRN. Visio, tabular view, schema and example updated and up-versioned for this message. Changes to this message and associated artefacts were specified in the Choose and Book W5 v3.5. Other (domain-wide) changes were specified in MIM CR-0549, MIM CR-0637 and MIM CR-0663.

7.11

Notify Did Not Attend - PRSC_MT110101UK07 (formerly UK06)

Added patient role to record NHS number; added AppointmentSlot to record UBRN. Visio, tabular view, schema and example updated and up-versioned for this message. Changes to this message and associated artefacts were specified in the Choose and Book W5 v3.5. Other (domain-wide) changes were specified in MIM CR-0549, MIM CR-0637 and MIM CR-0663.

7.13

Outline Referral Query - QUSC_MT000001UK01

Visio, tabular view, schema and example created for this new message.

7.14

Outline Referral Response - PRPA_MT000001UK01

Visio, tabular view, schema and example created for this new message.

7.15

Detailed Referral Query - QUSC_MT000002UK01

Visio, tabular view, schema and example created for this new message.

7.16

Detailed Referral Response - PRPA_MT000002UK01

Visio, tabular view, schema and examples created for this new message.

 

 

 

 

 

9.3    Changes for v3.7