Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Overview

Overview of the use case to send an Online Consultation Report to a care provider

Introduction

When a patient completes an online consultation it is necessary for information from that online consultation to be sent to the appropriate care provider, for example, this could be the patient’s registered GP practice, or a community pharmacy. This is so the online consultation information can be available for the care provider to give the appropriate care to the patient.

The use case listed below are indicative of how Send Document could be used and are not exhaustive.

Online Consultation

Patient survey

This use case follows the following process:

  1. the patient completes the online consultation, in this case a patient survey (this can be initiated by the patient or requested by the patient’s GP)
  2. the Online Consultation (OC) system triages the online consultation based on the content of the consultation and either sends the message to the patient’s registered GP practice, or to an alternative care provider, for example a community pharmacy.
  3. the OC system sends the message (containing a PDF of the online consultation) to the care provider
  4. the care provider receives the message and takes the appropriate action

Admin items

This use case follows the following process:

  1. the patient completes the online consultation, in this case a patient wishes to inform their GP that they have a certain type of family medical history
  2. the Online Consultation (OC) system triages the online consultation based on the content of the consultation and sends the message to the patient’s registered GP practice
  3. the OC system sends the message (containing a PDF of the online consultation) to the patient’s registered GP practice
  4. the patient’s registered GP practice receives the message and takes the appropriate action

Message flows in Online Consultation Report sent to a GP

The following diagram illustrates how a message can flow between the sending (originating) system and the receiving care provider via MESH to fulfil this use case:

"Message received and
 validated"

 Infrastructure ack 
"Message received an...
Sending Organisation
Sending Organisat...
 MESH - Message Send 
 MESH - Message Send 
MESH API
MESH API
MESH Server
MESH Server
MESH API
MESH API
Registered GP Practice
Registered GP Prac...
Online Consultation
Online Consultation
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
Composition
Attachments
Observations
Questionnaire-
Response
Location
Composition...
 MESH - Message Download 
 MESH - Message Download 
 Ingest into workflow 
 Ingest into workflow 
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
OperationOutcome
OperationOutcome
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
OperationOutcome
OperationOutcome
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Send 
 MESH - Message Send 
 MESH - Message Send 
 MESH - Message Send 
 Process acknowledgement 
 Process acknowledgement 
 Process acknowledgement 
 Process acknowledgement 
"Patient matched"

 Business ack 
"Patient matched"...
 MESH - Address Lookup request 
 MESH - Address Lookup request 
Lookup MESH mailbox address
Lookup MESH mailbox address
 MESH - Address Lookup response 
MESH - Address Lookup respons...
For Action
For Acti...
Viewer does not support full SVG 1.1


The diagram above depicts a successful message flow where the receiving care provider (in this example a GP) validates the message successfully and consumes. This involves the following steps:

  1. MESH Address Lookup

    1. After the online consultation is complete, the OC system initiates a MESH Address Lookup request for the patient’s registered GP practice.
    2. The OC system receives a response containing the MESH mailbox ID for the patient’s registered GP practice.
  2. Online Consultation Report message

    1. A trigger at the OC system results in a FHIR Message being constructed which includes a PDF describing the online consultation (as a minimum).
    2. The MESH API Send Message function is used to send the message to the mailbox acquired in step 1.
    3. The MESH server places the message in the GP practice’s MESH mailbox awaiting collection.
    4. The GP practice uses the MESH API Download Message function to retrieve the message from the MESH mailbox.
    5. The message is processed at the GP practice.
  3. Infrastructure acknowledgement ITK Response

    1. When the Online Consultation Report message is passed from MESH for processing at the GP practice, the message is first validated to ensure that its structure is correct. An ITK3 Response message is generated which indicates the success of message processing at a technical level - this is known as an “infrastructure acknowledgement”.
    2. The GP practice uses the MESH API Send Message function to send the acknowledgement message to the MESH server where it awaits collection by the OC system.
    3. The OC system uses the MESH API Download Message function to collect the acknowledgement message. The ITK Response is then available to the OC system components for onward processing.
    4. The acknowledgement message is processed as appropriate by the OC system.
  4. Business acknowledgement ITK Response

    1. When the Online Consultation Report message is passed from MESH for processing at the GP practice, after successful message validation, the subject of the message contents are landed in the workflow of the GP practice. An ITK3 Response message is generated which indicates the success of consuming the message - this is known as a “business acknowledgement”.
    2. The GP practice uses the MESH API Send Message function to send the acknowledgement message to the MESH server where it awaits collection by the OC system.
    3. The OC system uses the MESH API Download Message function to collect the acknowledgement message. The ITK Response is then available to the OC system components for onward processing.
    4. The acknowledgement message is processed as appropriate by the OC system.

Message flows in Online Consultation Report sent to an alternative care provider

The following diagram illustrates how a message can flow between the sending (originating) system and the receiving care provider via MESH to fulfil this use case:

Registered GP Practice
Registered GP Prac...
ITK3 FHIR Message
ITK3 FHIR Message
Sending Organisation
Sending Organisat...
 MESH - Message Send 
 MESH - Message Send 
MESH API
MESH API
MESH Server
MESH Server
MESH API
MESH API
Receiving Care Provider
Receiving Care Pro...
Online Consultation
Online Consultation
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
Composition
Attachments
Observations
Questionnaire-
Response
Location
Composition...
 MESH - Message Download 
 MESH - Message Download 
 Ingest into workflow 
 Ingest into workflow 
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
OperationOutcome
OperationOutcome
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
OperationOutcome
OperationOutcome
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Send 
 MESH - Message Send 
 MESH - Message Send 
 MESH - Message Send 
 Process acknowledgement 
 Process acknowledgement 
 Process acknowledgement 
 Process acknowledgement 
"Message received and
 validated"

 Infrastructure ack 
"Message received an...
"Patient accepted"

 Business ack 
"Patient accepted...
 MESH - Address Lookup request 
 MESH - Address Lookup request 
Lookup MESH mailbox address
Lookup MESH mailbox address
 MESH - Address Lookup response 
MESH - Address Lookup respons...
OperationOutcome
OperationOutcome
MessageHeader
MessageHeader
ITK3 FHIR Message
ITK3 FHIR Message
MessageHeader
MessageHeader
OperationOutcome
OperationOutcome
OperationOutcome
OperationOutcome
MessageHeader
MessageHeader
 MESH - Message Send 
 MESH - Message Send 
Online Consultation
Copy message

Online Consultation...
 MESH - Message Download 
 MESH - Message Download 
 Ingest into workflow 
 Ingest into workflow 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Download 
 MESH - Message Send 
 MESH - Message Send 
 MESH - Message Send 
 MESH - Message Send 
 Process acknowledgement 
 Process acknowledgement 
 Process acknowledgement 
 Process acknowledgement 
"Message received and
 validated"

 Infrastructure ack 
"Message received an...
"Patient matched"

 Business ack 
"Patient matched"...
For Action
For Acti...
For Information
For Informat...
Viewer does not support full SVG 1.1


The diagram above depicts a successful message flow where the receiving care provider (in this example a community pharmacy) validates the message successfully and consumes. This involves the following steps:

  1. MESH Address Lookup

    1. After the online consultation is complete, the OC system initiates a MESH Address Lookup request for the receiving community pharmacy.
    2. The OC system receives a response containing the MESH mailbox ID for the requested community pharmacy.
    3. The OC system initiates a MESH Address Lookup request for the patient’s registered GP practice.
    4. The OC system receives a response containing the MESH mailbox ID for the patient’s registered GP practice.
  2. Online Consultation Report message

    1. A trigger at the OC system results in a FHIR Message being constructed labelled “For Action” which includes a PDF describing the online consultation (as a minimum).
    2. The MESH API Send Message function is used to send the message to the mailbox acquired in step 1.b
    3. The MESH server places the message in the community pharmacy’s MESH mailbox awaiting collection.
    4. The community pharmacy uses the MESH API Download Message function to retrieve the message from the MESH mailbox.
    5. The message is processed at the community pharmacy.
  3. Infrastructure acknowledgement ITK Response

    1. When the Online Consultation Report message is passed from MESH for processing at the community pharmacy, the message is first validated to ensure that its structure is correct. An ITK3 Response message is generated which indicates the success of message processing at a technical level - this is known as an “infrastructure acknowledgement”.
    2. The community pharmacy uses the MESH API Send Message function to send the acknowledgement message to the MESH server where it awaits collection by the OC system.
    3. The OC system uses the MESH API Download Message function to collect the acknowledgement message. The ITK Response is then available to the OC system components for onward processing.
    4. The acknowledgement message is processed as appropriate by the OC system.
  4. Business acknowledgement ITK Response

    1. When the Online Consultation Report message is passed from MESH for processing at the community pharmacy, after successful message validation, the subject of the message contents are landed in the workflow of the GP practice. An ITK3 Response message is generated which indicates the success of consuming the message - this is known as a “business acknowledgement”.
    2. The community pharmacy uses the MESH API Send Message function to send the acknowledgement message to the MESH server where it awaits collection by the OC system.
    3. The OC system uses the MESH API Download Message function to collect the acknowledgement message. The ITK Response is then available to the OC system components for onward processing.
    4. The acknowledgement message is processed as appropriate by the OC system.
  5. Copy Online Consultation Report message

    1. A trigger at the OC system results in a FHIR Message being constructed labelled “For Information” which includes a PDF describing the online consultation (as a minimum).
    2. The MESH API Send Message function is used to send the message to the mailbox acquired in step 1.d
    3. The MESH server places the message in the GP practice’s MESH mailbox awaiting collection.
    4. The GP practice uses the MESH API Download Message function to retrieve the message from the MESH mailbox.
    5. The message is saved at the GP practice.
  6. Infrastructure acknowledgement ITK Response

    1. When the Online Consultation Report message is passed from MESH for processing at the GP practice, the message is first validated to ensure that its structure is correct. An ITK3 Response message is generated which indicates the success of message processing at a technical level - this is known as an “infrastructure acknowledgement”.
    2. The GP practice uses the MESH API Send Message function to send the acknowledgement message to the MESH server where it awaits collection by the OC system.
    3. The OC system uses the MESH API Download Message function to collect the acknowledgement message. The ITK Response is then available to the OC system components for onward processing.
    4. The acknowledgement message is processed as appropriate by the OC system.
  7. Business acknowledgement ITK Response

    1. When the Online Consultation Report message is passed from MESH for processing at the GP practice, after successful message validation, the subject of the message contents are landed in the workflow of the GP practice. An ITK3 Response message is generated which indicates the success of consuming the message - this is known as a “business acknowledgement”.
    2. The GP practice uses the MESH API Send Message function to send the acknowledgement message to the MESH server where it awaits collection by the OC system.
    3. The OC system uses the MESH API Download Message function to collect the acknowledgement message. The ITK Response is then available to the OC system components for onward processing.
    4. The acknowledgement message is processed as appropriate by the OC system.

Message creation at originating organisation

The following processing steps must take place at the originating organisation system (OC system) to create the message - as described in step 2a above.

  1. Initiate process to create for Online Consultation Report message.
  2. Create ITK3 payload: Construct a PDF description of the encounter.
  3. Wrap the payload as an ITK3 message, requesting infrastructure and business acknowledgements.
  4. Create MESH message.

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