Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

User stories

User stories for Send Consultation Report

Purpose

The purpose of this page is to document the user stories that apply across all of GP Connect Send Document capability. To avoid duplication, links to the requirements within the specification have been provided where applicable.

User stories

Send report for correct patient

ID: GPC-SD01 Source: Process 4.1

Description

As a clinician at a practice...

I want to send a document containing a patient's consultation notes when the patient is registered at another practice...

so that the patient's medical record is kept up to date with a full treatment history.


Acceptance criteria - sender

  1. the sender system must send a consultation report when the patient in question is registered at another GP practice
    1. the sender system must follow the method stated in the specification to determine whether a patient is registered at another GP practice. Details can be found here
  2. where the sender system supports an alternative method for communicating the consultation information back to the patient's registered GP practice, this method may be used in the place of GP Connect Messaging (based on local agreement)
    1. where an alternative method is used, the GP Connect Messaging requirements do not apply

Acceptance criteria - receiver

N/A

Linked requirements

GPCM-SD-083  GPCM-SD-084 


Routing the report to the correct practice

ID: GPC-SD02 Source: Process 4.1

Description

As a clinician...

I want the consultation report to be routed to the patient's registered practice...

so that the patient's medical record is kept up to date with a full history.


Acceptance criteria - sender

  1. all consultation reports will use MESH automated message routing in order to ensure that the message is routed correctly to the registered practice of the patient. It is not necessary for the sender system to specify a destination MESH mailbox ID
  2. the sender system must specify the patient's NHS Number, Surname and Date of Birth in the message header and use these to populate the Mex-To HTTP header in the MESH endpoint lookup service
  3. the sender system must use the allocated MESH Workflow ID associated solely with the GP Connect Send Document capability

Acceptance criteria - receiver

  1. where the message received is for a patient who is not registered at the GP practice, the receiver system must send a response back to the sending GP practice
  2. the receiver system must use the allocated MESH Workflow ID associated solely with the GP Connect Send Document capability

Linked requirements

GPCM-C-01  GPCM-C-02  GPCM-SD-056  GPCM-SD-057  GPCM-SD-058 


Generate PDF and associated metadata

ID: GPC-SD03 Source: Process 4.1

Description

As a clinician...

I want a full and complete record of the consultation to be sent and the data entered in to the local record to exactly match what is received at the patient's registered GP practice...

so that the patient's medical record is kept up to date with a full history.


Acceptance criteria - sender

  1. the sender system must include all data entered by the clinician at the originating practice into the 'Clinical notes [notes]' section of the PDF document; this includes all free text, clinical/SNOMED CT codes, dm+d codes and any other data entered relating to the consultation
  2. the sender system must include in the message all attachments relating to the consultation
  3. where the system does not have a concept of a consultation in its architecture, then the sender system will consider all data asserted about the patient for a specified date as part of the same consultation (this follows the same model as GP2GP)
  4. the layout and content of the PDF must conform to the template and logical field model contained within this requirements catalogue
  5. the version number must be displayed in the PDF in the relevant field and within the Subject of the MESH .CTL file
    1. version 1 is the original report with each subsequent report that relates to the same consultation incrementing by 1

Acceptance criteria - receiver

N/A

Supporting technical requirements

GPCM-SD-124  GPCM-SD-125 


Receiving the consultation report

ID: GPC-SD04 Source: Process 4.1

Description

As a member of staff at the registered practice...

I want a full and complete report of our patient's consultation when they are receiving care at another practice...

so that the patient's medical record is kept up to date with a full history.


Acceptance criteria - sender

N/A

Acceptance criteria - receiver

  1. the receiver system must route consultation reports into the practice workflow and display it as a task
  2. when displaying the consultation report in the practice workflow/task list, the receiver system must display the Subject from the MESH .CTL file: "Consultation report for {patient name}, NHS Number {NHS Number}, seen at {Practice name}, {ODS Code}, Version {Version Number}"
  3. the receiver system must display all data in the same form as supplied by the sender system
  4. the receiver system must make any attachments included with the consultation report available to the end user

Linked requirements

GPCM-SD-090  GPCM-SD-093 

Supporting technical requirements

GPCM-SD-092 


Alert staff of errors

ID: GPC-SD05 Source: Process 4.1

Description

As a member of the admin staff at the originating practice...

I want to be informed when a consultation report is not sent successfully...

so that I can take appropriate measures to get the data to the patient's registered practice.


Acceptance criteria - sender

  1. where a consultation report is not successfully received/managed by the receiver system, the sender system must inform an appropriate person
  2. where either the infrastructure or business acknowledgements, or both, are not received for a consultation report, the sender system must inform an appropriate person

Acceptance criteria - receiver

  1. the receiver system must return an error code when the processing of the message is unsuccessful

Linked requirements

GPCM-SD-066  GPCM-SD-094  GPCM-SD-095 

Supporting technical requirements

GPCM-SD-065  GPCM-SD-066  GPCM-SD-074  GPCM-SD-075 


Report version number

ID: GPC-SD06 Source: Process 4.1

Description

As a clinician at the receiving GP practice...

I want to know what version/iteration of the PDF document has been received...

so that I am informed of updates to previous consultation reports and to understand that there are earlier versions that can be discarded/updated.


Acceptance criteria - sender

  1. the sender system must identify if there are multiple consultation report documents sent for a specific consultation and patient. The version number must be displayed within the relevant section of the PDF document and in the subject of the MESH .CTL file in the format "Consultation report for {patient name}, NHS Number {NHS Number}, seen at {Practice code}, {ODS Code}, Version {Version Number}"
    1. version 1 is the original report with each subsequent report that relates to the same consultation incrementing by 1

Acceptance criteria - receiver

  1. when displaying the consultation report in the practice workflow/task list, the receiving system must display the Subject of the MESH .CTL file in the format "Consultation report for {patient name}, NHS Number {NHS Number}, seen at {Practice code}, {ODS Code}, Version {Version Number}"

Linked requirements

GPCM-SD-091  GPCM-SD-092 

Supporting technical requirements

GPCM-SD-098 


Send consultation report

ID: GPC-SD07 Source: Process 4.1

Description

As the authoring clinician...

I want the system to automate the process of generating and sending the consultation report to the registered practice...

so that the consultation report document is sent for 100% of consultations.


Acceptance criteria - sender

  1. the sender system must send the consultation report a configurable time period after the consultation was created or last updated
    1. where a consultation is updated within the configurable time period of the last update, the time delay to sending the consultation report will be from the later update
    2. where a consultation is updated after the configurable time period (and therefore the consultation report has already been sent) a new consultation report will be sent (after the configurable time period)
    3. each GP practice must be able to set its own a configurable time period
    4. where a GP practice has not set its own configurable time period the value will default to three hours

Acceptance criteria - receiver

N/A

Linked requirements

GPCM-SD-096 

Supporting technical requirements

None 


Patient confidentiality

ID: GPC-SD08 Source: Process 4.1

Description

As a patient...

I want to be able to request that the details of the consultation are kept private...

so that the data is not shared with someone I do not want to see it.


Acceptance criteria - sender

  1. the clinician must be able to set a consultation as confidential (or the clinical system's equivalent)
  2. the consultation record held at the GP practice is recorded as confidential (or equivalent) and its access restricted to the clinician who made the record
  3. where a consultation has been marked as confidential, the message is still sent to the patient's GP practice stating the consultation took place; it will contain no information on what took place in the consultation
    1. information on the patient and when the consultation took place are still included
    2. information on the clinician and where the consultation took place are not included
    3. the clinical notes are replaced by the text 'The details of this consultation have been set as confidential'
  4. confidentially is applied on a per consultation basis. A request for confidentiality for one consultation will have no impact on the messages sent for any other consultation

Acceptance criteria - receiver

N/A

Notes

This is the equivalent of a clinician setting a consultation as confidential and restricting the members of the GP practice who can view the details

Linked requirements

GPCM-SD-102 

Supporting technical requirements

GPCM-SD-092 


Local record retention

ID: GPC-SD09 Source: Process 4.1

Description

As a clinician...

I want the original record of the consultation recorded on the local system...

so that it is available to support ongoing care of the patient and to review if there are any legal or clinical challenges about the care given.


Acceptance criteria - sender

  1. the sender system must retain a copy of every consultation report that is sent
  2. for every consultation where a consultation report is produced, the sender system must retain a copy of the consultation in the format is was originally recorded

Acceptance criteria - receiver

N/A

Linked requirements

GFR  ITK 

Supporting technical requirements

None 


Data sharing

ID: GPC-SD10 Source: Process 4.1

Description

As a clinician (and data controller) sending a point-to-point targeted communication...

I want sending and receiving the consultation report to not be restricted by any data sharing controls...

so that the consultation report document is sent and received for 100% of consultations.


Acceptance criteria - sender

  1. data sharing controls must not prevent the consultation message being sent

Acceptance criteria - receiver

  1. data sharing controls must not prevent the consultation message being received and made available to the GP practice

Linked requirements

None 

Supporting technical requirements

None 


Patient confidentiality

ID: GPC-SD11 Source: Process 4.1

Description

As a patient...

I want to be able to request that the details of the consultation are kept private...

so that the data is not shared with someone I do not want to see it.


Acceptance criteria - sender

  1. the clinician may be able to set items in a consultation as confidential (this will depend on the local clinical system)
  2. the items in the consultation record held at the originating GP practice are recorded as confidential (or equivalent) and its access restricted following the local clinical system's processes and standards
  3. each confidential item in a consultation will be replaced in the consultation report with the warning text "Confidential item"
  4. where there are multiple confidential items in a consultation, the warning text will be repeated for each item

Acceptance criteria - receiver

N/A

Linked requirements

GPCM-SD-133  GPCM-SD-134 

Supporting technical requirements

None 


Deleted consultation

ID: GPC-SD12 Source: Process 4.1

Description

As a clinician at the originating practice...

I want the patient's registered GP practice to be informed if I delete a consultation...

so that the patient's medical record is kept up-to-date.


Acceptance criteria - sender

  1. when a user deletes a consultation where a consultation report has been sent, the sending system must give a warning message to the user
    1. the warning message must include the patient name and NHS number, the consultation date and the GP practice the consultation report has been sent to(the patient's registered GP practice)
  2. where a consultation is deleted it is the responsibility of the GP practice that recorded the consultation to inform the registered GP practice
    1. there is no requirement for the sending system to send an automated messages to inform the registered GP practice about the deletion
    2. the sending system should assist the GP practice in managing and tracking the process of informing other organisations

Acceptance criteria - receiver

N/A

Linked requirements

GPCM-SD-135 

Supporting technical requirements

None 


Tags: use-case

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