Isabel Software Specification for API Sandbox Symptom Checker (JSON ...

symptomchecker.

Isabel Software Specification for API Sandbox Symptom Checker (JSON/JSONP) December 2021

Private & Confidential

Table of Contents

1. Introduction................................................................................................................................................... 3 1.1 Purpose.................................................................................................................................................... 3 1.2 Scope ....................................................................................................................................................... 3 1.3 Definitions ............................................................................................................................................... 3 1.4 Overview.................................................................................................................................................. 4 1.5 Personnel ................................................................................................................................................. 4

2. Overall Description ........................................................................................................................................ 4 3. Hardware & Software requirements ............................................................................................................. 5

3.1 Hardware Requirements ......................................................................................................................... 5 3.2 Software Requirements........................................................................................................................... 5 4. Isabel's Application Programming Interface (API) ......................................................................................... 6 4.1 Introduction............................................................................................................................................. 6 4.2 Isabel's API Web Service Methods .......................................................................................................... 6

4.2.1 Age Groups ....................................................................................................................................... 7 4.2.2 Regions ............................................................................................................................................. 8 4.2.3 Countries .......................................................................................................................................... 8 4.2.4 Pregnancy ......................................................................................................................................... 9 4.2.5 Ranked Differential Diagnoses ......................................................................................................... 9 4.2.6 Knowledge Window........................................................................................................................ 13 4.2.7 Triage Tool (Where to get care?).................................................................................................... 14 4.2.8 Predictive Text ................................................................................................................................ 17

Private & Confidential

1. Introduction

1.1 Purpose

The purpose of this document is to define the functionality required to extend Isabel's interfacing capabilities with third party software beyond the browser by introducing an Application Programming Interface (API) for the Isabel Symptom Checker (SC).

This document can be used as an implementation guide when integrating Isabel functionality into other third-party applications using Isabel's API.

Please note that all integrations carried out using our API are subject to the approval of Isabel Healthcare prior to the final release of your product. This is to ensure that the final integrated product enables safe and appropriate use of the Isabel system. We are happy to provide informal advice during your integration and development process.

For companies based in the EU: Medical device regulation

The MHRA in the UK has accepted that the Isabel Symptom Checker is not a medical device. One of their key concerns was that the system should not indicate any degree of likelihood to the patient. In our browser version we, therefore, only show all the suggested conditions with no indication of likelihood. We have also made prominent the explanations of what the `common' and `red flag' labels mean. It is therefore important that you follow these guidelines when integrating Isabel to ensure that your system is not classed as device.

If you add any functionality that may indicate some degree of likelihood then this portion of your system may be considered a device and you will be responsible for complying with the relevant regulations in your country.

1.2 Scope

The API is a single software component which is responsible for a query-response system in Isabel. The object returns structured data to the caller so that it may be consumed and rendered in a User Interface (UI) or in a browser.

1.3 Definitions

API: Application Programming Interface, a standardised method by which a defined subset of functionality within a software component can be interacted with.

Clinical Records System: See EMR

EMR: Electronic Medical Record, a Software Product in which medical or related Patient Records can be electronically stored.

UI: User Interface or Graphical User Interface (GUI), the mechanism through which a user interacts with a software application or Website

Vendor: A third party who interfaces with software either via consumption of an API or using some other methodology.

Private & Confidential

1.4 Overview

This document consists of four sections.

Section 1: Introduction, provides details of what this document is and how it is structured

Section 2: Overall Description, describes in brief about Consumers of Isabel System.

Section 3: Hardware & Software Requirements need to integrate an application with Isabel's API, provides a list of requirements an application needs in order to integrate with Isabel's API.

Section 4: Isabel's Application Programming Interface (API), gives an introduction to Isabel's API, integration procedure and description of all the functions of Isabel's API.

1.5 Personnel

Jason Maude CEO & Founder, Isabel Healthcare, UK

Natalie Blanchflower Technical Services Director, Isabel Healthcare, UK

Souvik Mukherjee Technical Representative Webnish Software LLP

Email: Jason.Maude@ Tel: +44 1428644886 Tel: +1 703-879-1890

Email: Natalie.Blanchflower@ Tel: +1 703-879-8955

Email: souvik@

2. Overall Description

Isabel Service Consumers Web Browser Users These users access the product via a Website () and do so using a search tool customised for the domain of differential diagnosis.

? Vendors or EMR Users Users in this group access the same Website, but do so using specially-formed query strings. This causes the search tool to essentially be pre-populated with certain terms which can be further refined. These requirements are addressed specifically to this group.

? Other Applications Isabel's architecture is designed in a way that it can service the requests of other applications. Isabel accepts request in the form of URL and returns the response in a properly structured JSON/JSONP format.

Private & Confidential

Figure 1: Isabel System Workflow

3. Hardware & Software requirements

3.1 Hardware Requirements

The following hardware requirements are needed to access Isabel's API: ? Internet connection. ? All devices configured to access internet.

3.2 Software Requirements

The following software requirements are needed to access Isabel's API: ? Applications that can make a HTTPS request and receive the response. ? Application must be able to read and parse the JSON data from the response.

IMPORTANT: Credentials for the Sandbox account are available from Isabel. This does not include access to the LIVE version for the launch. Once the Sandbox integration has been signed off by Isabel ? the LIVE credentials will be issued (a new authorization key & live domain name). Final release is subject to Isabel approval.

Private & Confidential

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download