IBM Custom Connectors for NHS.

Appendix

Development Blog


Bi-Weekly Updates


10/10/2022 - 23/10/2022

Goal: Team allocation
We were assigned as a team to develop connectors specifically using IBM Watson APIs and Services and Microsoft Power Platforms

The task is to develop a Power Platform Independent connector for IBM Watson Cognitive Services. We created a github repository for the project and set up communication channels on Discord

24/10/2022 - 06/11/2022

Goal: Complete Human-Computer Interaction(HCI) part of the project by the end of this week and produce a PowerPoint presentation slides

  • Interviewed stakeholders to collect user requirements for our project (General practitioner and patient)
  • Produced sketches for users to review
  • Collected feedback and produce first prototype graphically
  • Finalised prototype and recorded it by producing presentation slides

Blocker: Project Clients were not introduced. Minimum user data could be collected.

Links to the PowerPoint sildes
Download here
View here

07/11/2022 - 20/11/2022

Goal: Introduction to our projct partners and familiarise ourselves with the project requirements and deliverables

First team meeting with client completed with Microsoft Power Platform and IBM Watson team. Project requirements, timeline and the deliverables were discussed. We received introduction and guidance on building a custom connector on power platform

21/11/2022 - 04/12/2022

Goal: Research on building a Custom Connector on Microsoft Power Platform

  • Received introduction on building a custom connector on power platform.
  • Researched and learnt the process of building a custom connector
  • Researched and learnt the open APIs and services IBM Watson provides
  • Decided on which IBM Watson APIs and services to use for our project

Blocker: Unable to access IBM Watson's API resources without a verified IBM Watson account. Unclear about the building process of a custom connector

05/12/2022 - 18/12/2022

Goal: Build our first prototype

  • After a few meetings with the client team, multiple custom connectors were expected to be built.
  • A trial IBM Watson account was created to access API resources after meeting with the IBM team.
  • To try out the building process, a simple Watson API, Text to Speech, was decided to be our first prototype.
  • IBM Watson Text to Speech API resources was created using IBM Cloud for development.
  • A prototype Text to Speech connector was built with functional canvas app as demonstration using Microsoft Power App, able to convert text into an audio file of reading the typed words aloud

19/12/2022 - 01/01/2023

Christmas break. Not much work is done.

02/01/2023 - 15/01/2023

Goal: Further research on Watson API and plan for the next custom connector

  • After discussing with the client team and understanding our End to End scenario was to help healthcare systems to develop their own automated system, we narrowed our choices down to IBM Watson’s clinical data analysis API, IBM Watson Assistant API and IBM Watson Discovery.
  • IBM Watson's clinical data analysis API is designed to analyse a patience's past medical data and record using a database and determines a suitable treatment for his/her current illness.
  • IBM Watson Assistant is an automated chat bot that can be customised to recognize specific text and keywords to carry out specific action and produce corresponding response. This can be used, for example, an automated appointment making system.
  • IBM Watson Discovery can recognize specific text pattern and keywords to produce a likely answer to a problem. This can be utilized by allowing patients to input how they feel right now for Discovery to analyse their current situation and rephrase them into more technical statement for doctors to analyse.
  • IBM Watson Discovery can recognize specific text pattern and keywords to produce a likely answer to a problem. This can be utilized by allowing patients to input how they feel right now for Discovery to analyse their current situation and rephrase them into more technical statement for doctors to analyse.
  • IBM Watson Assistant became our final choice for developing our second custom connector.

Blocker: Access to Clinical data analysis API is restricted by third party company. Access to IBM Watson discovery is restricted by IBM Cloud’s paid services.

16/01/2023 - 29/01/2023

Goal: Complete Elevator Pitch Presentation

A short presentation was completed towards our client and project lead explaining our development progress and demonstrating our functioning text to speech connector.

Links to the PowerPoint sildes
Download here
View here

30/01/2023 - 12/02/2023

Goal: Complete IBM Watson Assistant Connectors

  • Set up a simple IBM Watson Assistant to model an automated healthcare appointment making system for testing using IBM Cloud resources.
  • The assistant was able to recognise text that refers to making an appointment, confirm personal data, and list out the made appointment date and time.
  • An IBM Watson Assistant connector is built using our appointment making model, demonstrated by a functional canvas app built using Microsoft Power App. It can receive text input, pass it to our Assistant in IBM Cloud, and display retrieved output produced by the Assistant.
  • Bug checking and fixing for both connectors, ready to be submitted.

13/02/2023 - 26/02/2023

Goal: Submit both connectors to the Microsoft team.

Both functioning connectors were submitted onto the Microsoft custom connector Github, waiting for deployment.
Both connectors were verified and deployed for public use on Microsoft Power Platform by our client (16/2/2023)

27/02/2023 - 12/03/2023

Goal: Complete further deliverables

  • After meeting with our client, two templates demonstrating our produced connectors were asked to be made, thus a short tutoring video demonstrating the use of the IBM Watson Assistant connector should be produced.
  • Template submitted as an automating flow of reading out newly received outlook email's subject for our Text to Speech connector.
  • Template submitted as an automating flow of appointment making with email confirmation for our Assistant connector.

13/03/2023 - 26/03/2023

Goal: Complete final presentation and individual report.

  • continued filling up our portfolio website with content and information about our project
  • Created an end-to-end user manual video for using our setting up and utilising our connectors
  • Presentation - presented our final product to industry project partners
  • Submission - submitted our final product to industry project partners

Monthly Development Videos


December
January
February
March

Deployment Manual

Legal Issues & Processes

Note: Our group was informed by both Microsoft and IBM that no legal requirements are required for creating the custom connector. The EULA included can serve as a refrence for any individual/parties who wishes to further develop our connector and subsequent product


END USER LICENSE AGREEMENT ("EULA") FOR SOFTWARE
IMPORTANT - PLEASE READ CAREFULLY:
This EULA is a legal agreement between you (either an individual or a single entity) and [Software Company Name] ("Licensor") for the software product identified above, which includes computer software and may include associated media, printed materials, and "online" or electronic documentation ("Software Product").

BY INSTALLING, COPYING, OR OTHERWISE USING THE SOFTWARE PRODUCT, YOU AGREE TO BE BOUND BY THE TERMS OF THIS EULA. IF YOU DO NOT AGREE TO THE TERMS OF THIS EULA, DO NOT INSTALL OR USE THE SOFTWARE PRODUCT.

GRANT OF LICENSE.
Subject to the terms and conditions of this EULA, Licensor hereby grants to you a non-exclusive, non-transferable license to use the Software Product on a single computer or device owned or controlled by you.

RESTRICTIONS.
You may not copy, modify, distribute, sell, or transfer the Software Product, or any copy thereof, except as expressly permitted by this EULA.

OWNERSHIP.
The Software Product is owned by Licensor and is protected by applicable copyright and other intellectual property laws. Licensor retains all rights, title, and interest in and to the Software Product, including all intellectual property rights.

DISCLAIMER OF WARRANTIES.
The Software Product is provided "AS IS" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. Licensor does not warrant that the Software Product will meet your requirements or that the operation of the Software Product will be uninterrupted or error-free.

LIMITATION OF LIABILITY.
In no event shall Licensor be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use the Software Product, even if Licensor has been advised of the possibility of such damages.

TERMINATION.
This EULA is effective until terminated. You may terminate this EULA at any time by destroying all copies of the Software Product. Licensor may terminate this EULA immediately if you fail to comply with any of the terms and conditions of this EULA. Upon termination, you must destroy all copies of the Software Product.

GENERAL PROVISIONS.
This EULA shall be governed by and construed in accordance with the laws of [State/Country]. This EULA contains the entire agreement between you and Licensor with respect to the Software Product and supersedes all prior or contemporaneous communications and proposals, whether oral or written, between you and Licensor. If any provision of this EULA is held to be invalid or unenforceable, the remaining provisions shall remain in full force and effect.


Privacy Notice

Note: A Privacy Notice Policy must be included if the connector put to use, since the system collects users' personal data. The following points should be explained

According to the GDPR, personal data is defined as "any information relating to an identified, or identifiable natural person (the data subject)".

  • WHO WE ARE
  • DATA COLLECTED
  • HOW DATA IS COLLECTED AND USED
  • DISCOSURE OF liERSONAL DATA
  • DATA SECURITY
  • DATA RETENTION
  • INTERNATIONAL TRANSFER
  • LEGAL RIGHTS

Terms and Conditions

This part should be completed with professional legal advice