Ontology services: Difference between revisions

From Endeavour Knowledge Base
m (DavidStables moved page Information model server to Information model service: Server is just one component of the service)
No edit summary
Line 2: Line 2:
<font color="#e74c3c">DRAFT - this article is in a very draft state and must not be relied upon as being up to date or an actual reflection of the world's true state.</font>
<font color="#e74c3c">DRAFT - this article is in a very draft state and must not be relied upon as being up to date or an actual reflection of the world's true state.</font>


The Information model service is a set of services that enables the common information model to be created, updated and distributed.
The Information model service is a set of services that enables the Discovery common information model to be created, updated, distributed and accessed.


One of the components of the information model service is the information model server.&nbsp; The information model server provides a set of APIs&nbsp;that help&nbsp;systems and users access the content of the Discovery common information model.
The service includes a set of web applications and a set of APIs to an information model server.


&nbsp;The following lists the functional groupings of the IM Service:
All components of the service are open source and available at the Discovery Endeavour githubs&nbsp;[https://github.com/endeavourhealth https://github.com/endeavourhealth]&nbsp;and&nbsp;[https://github.com/endeavourhealth-discovery https://github.com/endeavourhealth-discovery]


== Value sets ==
The information model server provides a set of APIs&nbsp;that help&nbsp;systems and users access the content of the Discovery common information model.
 
The information model itself is internally defined via the [[Discovery_information_model_language|Discovery_information_model_language]] which is a group of standards based languages with some pragmatic additions that enable the service to operate.&nbsp; Externally, the Information model can be accessed via standards based APIs or by Discovery language based APIs that are supported by the Information model server.
 
The following lists the functional groupings of the IM Service. Some of these use web applications , some use the information model server, and some use the information model distribution service components that maintain locally owned copies of the information model.
 
__TOC__
 
== Support for Value sets ==
 
The service supports the creation of, maintenance of, distribution of, and access to value set definitions and value sets.
 
A value set definition&nbsp;is a collection of&nbsp;concept expressions&nbsp;that have been brought together for particular business purposes. They are different from standard concept definitions because the meaning of some members of a value set may not be subsumed by the implied meaning of the value set. Value set definitions are desribed in more detail in the [[Discovery_Information_model_language.]]
 
=== Value set editor ===
 
The value set editor enables people to create and maintain value set definitions.


=== Value set run time generator&nbsp; ===
=== Value set run time generator&nbsp; ===


The value set generator returns a list of concepts that are defined by a value set definition, thus supporting advanced [[Subsumption_testing|subsumption_testing]] against health care records.
The value set generator returns a list of concepts that are defined by a value set definition for use in queries,&nbsp;thus supporting advanced [[Subsumption_testing|subsumption_testing]] against health care records.


The [[Value_set_generator_API|value set&nbsp;]][[Generator_AP|generator AP]][[Value_set_generator_API|I accepts]] the IRI of a&nbsp;value set either in full, or relative to a baseline IRI e.g. [http://DiscoveryDataService/InformationModel#VSET_Covid1 http://DiscoveryDataService/InformationModel#VSET_Covid1] and returns a list of concepts to be used in the query. The API supports both core concepts and original codes that have been mapped to the core concepts.
The [[Value_set_generator_API|value set&nbsp;]][[Generator_AP|generator AP]][[Value_set_generator_API|I accepts]] the IRI of a&nbsp;value set either in full, or relative to a baseline IRI e.g. [http://DiscoveryDataService/InformationModel#VSET_Covid1 http://DiscoveryDataService/InformationModel#VSET_Covid1] and returns a list of concepts to be used in the query. The API supports both core concepts and original codes that have been mapped to the core concepts.
Line 21: Line 37:


This is part of the [[Information_model_distribution_service|information_model_distribution_service]] that runs on an application server,&nbsp;&nbsp;and is designed to detect changes to the content of the information model and regenerate the value sets from the value set definitions. The value sets are regenerated whenever a value set definition changes or whenever there is an update to the concepts within the information model.
This is part of the [[Information_model_distribution_service|information_model_distribution_service]] that runs on an application server,&nbsp;&nbsp;and is designed to detect changes to the content of the information model and regenerate the value sets from the value set definitions. The value sets are regenerated whenever a value set definition changes or whenever there is an update to the concepts within the information model.
&nbsp;
&nbsp;


&nbsp;
&nbsp;


&nbsp;
&nbsp;

Revision as of 10:13, 1 May 2020

DRAFT - this article is in a very draft state and must not be relied upon as being up to date or an actual reflection of the world's true state.

The Information model service is a set of services that enables the Discovery common information model to be created, updated, distributed and accessed.

The service includes a set of web applications and a set of APIs to an information model server.

All components of the service are open source and available at the Discovery Endeavour githubs https://github.com/endeavourhealth and https://github.com/endeavourhealth-discovery

The information model server provides a set of APIs that help systems and users access the content of the Discovery common information model.

The information model itself is internally defined via the Discovery_information_model_language which is a group of standards based languages with some pragmatic additions that enable the service to operate.  Externally, the Information model can be accessed via standards based APIs or by Discovery language based APIs that are supported by the Information model server.

The following lists the functional groupings of the IM Service. Some of these use web applications , some use the information model server, and some use the information model distribution service components that maintain locally owned copies of the information model.

Support for Value sets

The service supports the creation of, maintenance of, distribution of, and access to value set definitions and value sets.

A value set definition is a collection of concept expressions that have been brought together for particular business purposes. They are different from standard concept definitions because the meaning of some members of a value set may not be subsumed by the implied meaning of the value set. Value set definitions are desribed in more detail in the Discovery_Information_model_language.

Value set editor

The value set editor enables people to create and maintain value set definitions.

Value set run time generator 

The value set generator returns a list of concepts that are defined by a value set definition for use in queries, thus supporting advanced subsumption_testing against health care records.

The value set generator API accepts the IRI of a value set either in full, or relative to a baseline IRI e.g. http://DiscoveryDataService/InformationModel#VSET_Covid1 and returns a list of concepts to be used in the query. The API supports both core concepts and original codes that have been mapped to the core concepts.

Value set distributor

The value set distributor maintains tables of value sets for databases that use local instances of the Discovery information model. 

This is part of the information_model_distribution_service that runs on an application server,  and is designed to detect changes to the content of the information model and regenerate the value sets from the value set definitions. The value sets are regenerated whenever a value set definition changes or whenever there is an update to the concepts within the information model.