Welcome to the Endeavour Health knowledge base: Difference between revisions

From Endeavour Knowledge Base
No edit summary
Tags: Manual revert Visual edit
(166 intermediate revisions by 3 users not shown)
Line 1: Line 1:


The articles describe and define Discovery Data Service functionality and technology; the architecture that underpins the data service software, the components that make up the service, the testing and assurance processes, and the resources, technologies, and software that are used to host, develop, and support the service.
These articles describe the Endeavour open source technologies and services.  


= Discovery overview =
The technologies and services cover the following areas


These articles provide background to the ideas, philosophies and approaches that have resulted in the Discovery Data Service. They cover the original objectives, the approach to collaboration and shared tenancy, and the information governance rules that underpin the way privacy and sharing are balanced.
* [[Decision support services|Decision support services,]] for example calculating risks of heart disease or stroke
* [[Information modelling|Information models]] describing the Endeavour information model approach encompassing ontologies, data models, value sets, and queries
* [[Information model service|Ontology services]] for using and managing ontologies , data models, value sets
* [[Information model service|Query and data  set services]] for maintaining feature and query libraries
* [[ASSIGN- UPRN address match application|Address matching and UPRN allocation]] for single individuals, households or large populations.
* [[FHIR Get Structured Record API|Health record APIs.]] Describes a set of APIs for accessing health records using FHIR.


*[[What_is_Discovery|What is Discovery]]? - This article describes what Discovery is and how it is conceptualised at a very high level.
All of these services have live and development deployments and are free to access.  
*[[Case studies]] - An overview of projects that access and utilise data from Discovery; information includes the applicant, project summary, and the latest status (Development/Live).
*[[Release news]] - The latest information for all Discovery releases and changes.


= Information model related topics =
They all operate in three ways:


These articles provide information about the services, structure, and functionality that operate using the Discovery Common Information Model; one of the fundamental tenets of the Discovery Data Service. This is the starting point for those interested in health data and the information derived from it, and why Discovery may be different from other approaches:
# Use of web or online user interfaces to enable users to use the services directly. Provides viewing or downloading facilities
# User of Web APIs for systems to interoperate so that the resources can be used as part of an integrated offering
# Local implementations whereby local code APIs are used instead of Web APIs.  


*[[Common_information_model|Discovery common information model]] - an overview of the components of the common model, leading to details of each component.
These technologies form part of a broader set technologies, many of which have been used by a large scale [https://wiki.discoverydataservice.org/index.php?title=Welcome_to_the_Discovery_Data_Service_knowledge_base NHS  London Data linkage and normalisation Service] Known as Discovery, covering a population of 7 million registered citizens.
*[[Health_data_model_content|Discovery health data model ]] - a very high level overview of the types of data held within the Discovery data stores.
*[[Information_model_service|Information model services]] - the technical services that enable the common information model to be used.
*[[Information modelling language|Discovery information modelling language]] - describes the machine and human readable language used to build the information model and for computers to process or manipulate data
 
= Operational and interoperability topics =
These articles provide information about how systems can interoperate with Discovery and provide further links into test APIs, schemas, and other documentation associated with data formats for sending and receiving data.
 
*[[Secure_publication_to_the_DDS|Secure publication to the DDS]] - lists the technical interfaces in place for receiving data from publishers.
*Compass 1 articles
**[[Remote Subscriber Database (RSD) SQL guide (Compass 1)]] - provides information for subscribers who want to host their own copy of data supplied by Discovery.
**[[Remote Subscriber Database (RSD) Schema (Compass 1)]] - lists the contents and references for each table in the Compass 1 database.
*Compass 2 articles
**[[Remote Subscriber Database (RSD) SQL guide (Compass 2)]] - provides information for subscribers who want to host their own copy of data supplied by Discovery.
**[[Remote Subscriber Database (RSD) Schema (Compass 2)]] - lists the contents and references for each table in the Compass 2 database.
*[[Remote_Subscriber_Database_(RSD)_AWS_hosting_setup_guide|Remote Subscriber Database (RSD) AWS hosting setup guide]] - provides information for subscribers who want to set up their data in AWS.
*[[Generic_publisher_system_data_requirements|Generic publisher system data requirements]] - provides a set of guides for systems that are publishing data through the Discovery Data Service.
*[[Current_data_sets|Current data sets]] - the broad types of data received from various systems.
*[[Current published data]] - provides the latest data publisher information by sector, geographical area, service, and system provider. 
*[[Publishers_and_mapping_to_the_commmon_model|Publishers and mapping to the common model]] - provides the specification for how supplier system information is mapped to the common model, using FHIR as the intermediary.
 
= Services and applications =
 
These articles provide information about the services and applications provided by the Discovery Data Service and the underlying functionality.
 
* Discovery Explorer - a web based application that provides insights into population level and personal health data. It is technically specified in the article [[Discovery Explorer- Specification|Discovery explorer- specification]] and the user guides are accessible at  Discovery Explorer
 
*[[Simple_generic_query_service|Discovery analyser]]  - an application  that provides data on request for data that might be conceptually very complex, but falls into simple common patterns.
*[[Information_model_service|Information model services]] - the technical services that enable the common information model to be used.
*[[FHIR Get Structured Record API]] - returns a complete patient record in a structured format following GP and Care Connect standards.
*[[HL7v2 API]] - Send HL7v2 ADT and ORU (clinical events) data to Discovery.
*Get health record - the service that obtains a fully structured health record about a person, in real time via a standards based API.
*Record publication service - the service that publishes data from health records for specific purposes, often immediately on receipt.
*Data set distribution service - the service that distributes sets of data for populations of patients where the definition is complex or where the subscriber is hosting a copy of the data permanently.
*[[NHS 111 Discovery frailty flagging]] / [[Frailty algorithm]]
 
= Architectures =
These articles provide information about the overall high level software architecture models providing a descriptions and visualisations of the Discovery Data Service and information service components and how they interact.
 
*The [[Data Storage Architecture]] illustrates how data is stored within the service and the various implementation options available for organisations that wish to use some or parts of the services.
*[[Identity Authentication Authorisation|Identity, authentication and authorisation]] specifies the approach taken by Discovery for accessing utilities and controlling some aspects of access to application functionality and some data resources, after all of the other locks have been opened.
*[[Application zone architecture]] illustrates how the data is accessed in different places and in different ways according to different use cases
 
= Technologies =
 
These articles provide information about the technologies used in the Discovery Data services, including summaries of considerations and tests that have been undertaken when selecting technologies.
 
*[[Graph_or_relational_databases|Graph versus relational database ]] - considers two of the approaches for storing the main health care record stores.
 
= Publisher system known issues =
 
This section documents the known long standing problems relating to systems that publish data to Discovery. The issues as categorised by supplier and system. These issues need to be taken into account when configuring the services to process the data. The issues do not include short term glitches or errors.
 
*[[EMIS_known_issues|EMIS]]
*[[TPP_known_issues|TPP]]
 
= Application help =
 
*[[Data_Sharing_Manager|Data Sharing Manager]] - Data Sharing Manager provides a visual representation of data that is being shared and processed and by which organisations, regions, and/or services.
*:You can also amend or cancel data sharing and processing agreements in real time.
*Discovery Explorer
*User Manager
 
= Wiki tips =
 
*[[Adding tables from word documents]]
*[https://www.mediawiki.org/wiki/Help:Tables Mediawiki Help:Tables]
*[[Creating a DDS wiki watchlist]]

Revision as of 09:58, 22 March 2024

These articles describe the Endeavour open source technologies and services.

The technologies and services cover the following areas

All of these services have live and development deployments and are free to access.

They all operate in three ways:

  1. Use of web or online user interfaces to enable users to use the services directly. Provides viewing or downloading facilities
  2. User of Web APIs for systems to interoperate so that the resources can be used as part of an integrated offering
  3. Local implementations whereby local code APIs are used instead of Web APIs.

These technologies form part of a broader set technologies, many of which have been used by a large scale NHS London Data linkage and normalisation Service Known as Discovery, covering a population of 7 million registered citizens.