Hauptseite: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
(→‎General)
K (→‎Core Web Services)
 
(32 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
 
{{DISPLAYTITLE:CTS2 Linked Data Edition Terminology Server}}
 
{{DISPLAYTITLE:CTS2 Linked Data Edition Terminology Server}}
  
−
Controlled vocabularies (also known as code systems or terminologies) are common information artefacts in healthcare. They allow for univocally and precisely referencing of concepts and are core foundation of any semantic processing of health data. In particular all electronic communication in healthcare relies on coded concepts for semantic interoperability and automated data processing. The Object Management Group's [[OMG/HL7 CTS2 Standard|Common Terminology Services Version 2 (CTS2) standard]] defines an accepted industry standard representation to share, query and maintain value sets and other terminology artifacts. One method to achieve compliance with the structural profiles of CTS2 is to use semantic web technologies that are widely used for vocabularies. In this way, CTS2 artifacts such as code systems, code system elements (i.e., codes and their designations), associations and value sets (i.e., sets of code system elements) can be processed with semantic technologies.
+
Controlled vocabularies (also known as code systems or terminologies) are common information artefacts in healthcare. They allow for univocally and precisely referencing of concepts and are core foundation of any semantic processing of health data. In particular all electronic communication in healthcare relies on coded concepts for semantic interoperability and automated data processing. The Object Management Group's [[OMG/HL7 CTS2 Standard|Common Terminology Services Version 2 (CTS2) standard]] defines an accepted industry standard representation to share, query and maintain value sets and other terminology artifacts. '''CTS2 was the conceptual background/blueprint for the development of the terminology resource structure of FHIR'''. Therefore CTS2-LE is FHIR-enabled in order to support this standard that will be the main standard in electronic healthcare.
  
−
<!-- The CTS2 specification is structured within a platform independent model that provides two profiles:
+
One method to achieve compliance with the structural profiles of FHIR terminologies and value sets is to use semantic web technologies that are widely used for vocabularies. In this way, artifacts such as code systems, code system elements (i.e., codes and their designations), associations and value sets (i.e., sets of code system elements) can be processed with semantic technologies. The '''CTS2 Linked Data Edition (CTS2-LE)''' terminology server provided by Fraunhofer FOKUS follows that foundation. It relies on the the [http://www.w3.org/standards/techs/rdf#w3c_all Resource Description Framework (RDF)] in conjunction with a [http://www.w3.org/TR/2014/REC-rdf-schema-20140225/ RDFS]-based schema vocabulary oriented towards the Frame Logic. So-called RDF signatures, based on this schema vocabulary, describe structural constraints according to the information model. Likewise, arbitrary object graphs can be processed and stored with these RDF signatures.
−
# Structural profiles define how code systems, associations, or value sets are organized;
 
−
# Functional profiles define fundamental operations of persistent storage (CRUD) in an information system that change these structures. -->
 
  
−
<!-- reasoning engines including code member validations. -->
 
  
−
The '''CTS2 Linked Data Edition (CTS2-LE)''' terminology server provided by Fraunhofer FOKUS follows that foundation. It relies on the the [http://www.w3.org/standards/techs/rdf#w3c_all Resource Description Framework (RDF)] in conjunction with a [http://www.w3.org/TR/2014/REC-rdf-schema-20140225/ RDFS]-based schema vocabulary oriented towards the Frame Logic. So-called RDF signatures, based on this schema vocabulary, describe structural constraints according to the CTS2 information model. Likewise, arbitrary object graphs can be processed and stored with these RDF signatures.
+
== Overview ==
−
 
+
This section provides an overview about CTS2-LE. It introduces the building blocks and summarizes the most important functional features.
−
== CTS2-LE Overview ==
 
−
This section provides an overview about CTS2-LE. It introduces the CTS2-LE building blocks and summarizes the most important functional features provided by CTS2-LE.
 
 
;[[CTS2-LE Fact Sheet]] (German)
 
;[[CTS2-LE Fact Sheet]] (German)
−
:The CTS2-LE Fact Sheet provides an overview of CTS2-LE considering the implemented CTS2 functionalities and additional usability related features.
+
:The Fact Sheet provides an overview considering the implemented functionalities and additional usability related features.
 
;[[CTS2-LE Building Blocks]]
 
;[[CTS2-LE Building Blocks]]
−
:The foundation of CTS2-LE features a structural compliance to the OMG CTS2 Information Model, is linked-data ready by the means of W3C RDF, and is accessible through a HL7 FHIR and REST API as well as supporting the definition, composition and import of value sets. The knowledge base functionality is implemented with RDF as the representation language providing linkage capabilities for intra- or cross-domain artifacts such as HL7 CDA and HL7 FHIR. This section describes the architecture and internal design of CTS2-LE.
+
:Building blocks feature a structural compliance to the Information Model, is linked-data ready by the means of W3C RDF, and is accessible through a HL7 FHIR and REST API as well as supporting the definition, composition and import of value sets. The knowledge base functionality is implemented with RDF as the representation language providing linkage capabilities for terminological entities. This section describes the architecture and internal design.  
−
;[[CTS2-LE Supported Terminologies]]
 
−
:CTS2-LE is highly suitable for representing netlike vocabularies of varying complexity. Thus, it facilitates the integration of several healthcare relevant terminologies. This section gives an overview of the vocabularies that can be loaded so far.
 
 
;[[CTS2-LE Interoperability]]  
 
;[[CTS2-LE Interoperability]]  
−
:CTS2-LE is build upon international standards and provides multiple standard interfaces for connecting to external services. This section gives an overview on the standards supported by CTS2-LE and how these can be utilized for integrating CTS2-LE with third party products.
+
:The system is build upon international standards and provides multiple standard interfaces for connecting to external services. This section gives an overview on the standards supported and how these can be utilized for integrating with third party products.
 
;[[Further Information Sources for CTS2-LE]]
 
;[[Further Information Sources for CTS2-LE]]
−
:Fraunhofer FOKUS has published various papers and brochures about CTS2-LE in particular and terminology services in general. This section provides links to online resources related to CTS2 and CTS2-LE.
+
:Fraunhofer FOKUS has published various papers and brochures about CTS2-LE in particular and terminology services in general.  
 +
 
 +
== Installation, Deployment, and Setup ==
 +
This section covers the installation and initial setup of CTS-LE within an organization. The installation is performed via a deployment to a Kubernetes system.
 
<!--
 
<!--
−
;[[Licence and Availability Notes]]
+
;[[Prerequisites V2|Prerequisites]]
−
:When distributing CTS2-LE along with its supported terminologies, licence restrictions have to be considered. This section outlines the terminology specific terms of distribution.
+
:This section describes the hardware, OS and network requirements for installing CTS2-LE.  
 
-->
 
-->
−
 
−
== CTS2-LE Installation, Deployment, and Setup ==
 
−
This section covers the installation and initial setup of CTS-LE within an organization.
 
−
;[[Prerequisites V2|Prerequisites]]
 
−
:This section describes the hardware, OS and network requirements for installing CTS2-LE as a stand-alone-system on a server.
 
−
<!-- ;[[Installation and Setup V2|Installation, Deployment, and Setup V2]]
 
−
:CTS2-LE is provided as a set of libraries and executables for the various system building blocks. This section describes how to deploy, configure and activate these components for specific usage scenarios. -->
 
  
 
;[[Installation and Setup V3|Installation, Deployment, and Setup V3]]
 
;[[Installation and Setup V3|Installation, Deployment, and Setup V3]]
Zeile 39: Zeile 28:
  
 
;[[Installation and Setup V3 (2020 versions)|Installation, Deployment, and Setup V3 (2020 versions)]]
 
;[[Installation and Setup V3 (2020 versions)|Installation, Deployment, and Setup V3 (2020 versions)]]
−
:V3 is designed to run in embedded mode (jena TDB quadstore, Lucene) and in distributed mode (Fuseki, Solr).
+
<!-- :V3 is designed to run in embedded mode (jena TDB quadstore, Lucene) and in distributed mode (Fuseki, Solr). -->
 +
: '''DEPRECATED'''
 +
 
 +
;[[Installation and Setup V3 (2021 versions)|Installation, Deployment, and Setup V3 (2021 versions)]]
 +
: '''DEPRECATED'''
 +
 
 +
;[[Installation and Setup V4 (2025)|Installation, Deployment, and Setup V4 (2025)]]
 +
:V4 (version >= 4.0.0) with full HELM and BfArM support.
 +
 
 +
;[[CTS2-LE Supported Terminologies|Supported Terminologies]]
 +
:Overview of the '''main''' standard vocabularies/versions.
  
−
;[[CTS2-LE Security Configuration|Security Configuration]]
 
−
:CTS2-LE standard configuration allows unrestricted read access while administrative functionalities (e. g. loading/updating terminologies) is restricted to registered named users. This section describes how to configure these defaut security settings and how enhanced security services (e. g. full access control) may be linked with CTS2-LE.
 
 
<!--
 
<!--
−
;[[CTS2-LE Update Procedures]]
+
;[[BfArM Terminologies|BfArM Terminologies]]
−
:Fraunhofer FOKUS will provide regular updates to the CTS2-LE software and loaders. These updates will include bug fixes, adaptations to changes on the CTS2 standard, and additional functionality. This section describes how to install an update.  to an already deployed CTS2-LE.-->
+
:Terminologies of BfArM (Bundesinstitut für Arzneimittel und Medizinprodukte).
 +
 
  
−
<!--
+
== Navigator ==
−
== CTS2-LE Navigator ==
 
 
The CTS2-LE Navigator provides a graphical user interface for online browsing. This sections describes the functionalites of the CTS2-LE Navigator and how to use these.
 
The CTS2-LE Navigator provides a graphical user interface for online browsing. This sections describes the functionalites of the CTS2-LE Navigator and how to use these.
 
;[[CTS2-LE Navigator: Browsing through Terminologies|Browsing through Terminologies]]
 
;[[CTS2-LE Navigator: Browsing through Terminologies|Browsing through Terminologies]]
Zeile 65: Zeile 62:
 
-->
 
-->
  
−
== CTS2-LE Web Services ==  
+
== Core Web Services ==  
−
CTS2-LE provides a simple REST interface for integrating CTS2-LE terminology services with custom and third-party applications. This section provides the technical specification of the CTS2-LE REST Application Programming Interface.
+
CTS2-LE provides a REST interface for integrating terminology services with custom and third-party applications. This section provides the technical specification of the REST Application Programming Interface.
  
−
<!-- including sample code snippets for each interface. -->
 
  
 
=== General ===
 
=== General ===
Zeile 75: Zeile 71:
 
: The suggester '''has to be updated''' whenever a code system is loaded. The suggester is used for searches within the navigation frontend.  
 
: The suggester '''has to be updated''' whenever a code system is loaded. The suggester is used for searches within the navigation frontend.  
 
* [[CTS2-LE REST API: General#GET_service.2Fmanage.2Findex.2Fupdate|Search index update]]
 
* [[CTS2-LE REST API: General#GET_service.2Fmanage.2Findex.2Fupdate|Search index update]]
−
: Update only has to be invoked for RDF triple loading or if elements of a resource are modified via editing. The search index '''is automatically updated''' whenever a code system is loaded (exclusive bulk loading).  
+
: Update only has to be invoked for RDF triple loading or if elements of a resource are modified via editing. The search index '''is automatically updated''' whenever a code system is loaded.
 +
* [[CTS2-LE REST API: General#GET_service.2Fcrud.2Fcts2.2Fresources|List resources]]
 +
: List all rersources (code systems, value sets, concept maps).
 
* [[CTS2-LE REST API: General#DELETE_service.2Fcrud.2Fcts2.2Fresource|Delete resource]] by uri and version
 
* [[CTS2-LE REST API: General#DELETE_service.2Fcrud.2Fcts2.2Fresource|Delete resource]] by uri and version
  
Zeile 84: Zeile 82:
 
* [https://www.hl7.org/fhir/valueset.html value sets] and
 
* [https://www.hl7.org/fhir/valueset.html value sets] and
 
* [https://www.hl7.org/fhir/conceptmap.html concept maps]
 
* [https://www.hl7.org/fhir/conceptmap.html concept maps]
−
that will deprecate most of the [[#FHIR-oriented_.28deprecated.2C_use_FHIR_R4_instead.29|API below]]. Not all parameters are supported, but in the context of customization for a project it will be enhanced. The following operations are supported:
+
<!-- that will deprecate most of the [[#FHIR-oriented_.28deprecated.2C_use_FHIR_R4_instead.29|API below]]. -->
 +
 
 +
Not all parameters are supported, but in the context of customization for a project it will be enhanced. The following operations are supported.
 +
 
 +
The fhir base path is <code><host>/WebCts2LE/hapi-fhir</code>.
  
 
==== Resource-type-independent ====
 
==== Resource-type-independent ====
  
−
* [https://www.hl7.org/fhir/http.html#read read] (currently, only for code systems and value sets)
+
* [https://www.hl7.org/fhir/http.html#read read]
 
* [https://www.hl7.org/fhir/http.html#update update]  
 
* [https://www.hl7.org/fhir/http.html#update update]  
−
<!-- ([[Special Parameters for FHIR update|special parameters]]) -->
 
 
* [https://www.hl7.org/fhir/http.html#delete delete] by resource id (unconditional)
 
* [https://www.hl7.org/fhir/http.html#delete delete] by resource id (unconditional)
  
Zeile 113: Zeile 114:
 
* [https://www.hl7.org/fhir/conceptmap-operation-translate.html translate]
 
* [https://www.hl7.org/fhir/conceptmap-operation-translate.html translate]
 
: supported parameters: ''url'', ''code'', ''system'', ''version'', ''coding'', ''codeableConcept'', ''targetsystem''
 
: supported parameters: ''url'', ''code'', ''system'', ''version'', ''coding'', ''codeableConcept'', ''targetsystem''
−
 
  
 
=== OWL ===
 
=== OWL ===
Zeile 121: Zeile 121:
  
  
 +
<!--
 
=== FHIR-oriented ''(deprecated, use [[#FHIR_R4|FHIR R4]] instead)'' ===
 
=== FHIR-oriented ''(deprecated, use [[#FHIR_R4|FHIR R4]] instead)'' ===
  
Zeile 129: Zeile 130:
 
;[[CTS2-LE REST API: Resolve Value Set|Resolve Complete Value Set]]
 
;[[CTS2-LE REST API: Resolve Value Set|Resolve Complete Value Set]]
 
:provides means to resolve and/or fetch an FHIR origined value set (or code system) which is identified by it's URI.
 
:provides means to resolve and/or fetch an FHIR origined value set (or code system) which is identified by it's URI.
−
<!--
 
−
:Example: [[CTS2-LE REST API Example: Loading a Value Set into a HTML Form DropDown-Box|Loading a Value Set into a HTML Form DropDown-Box]] ''(- - > Ben)''
 
−
-->
 
 
;[[CTS2-LE REST API: Requesting Concept Details|Request Concept Details]]
 
;[[CTS2-LE REST API: Requesting Concept Details|Request Concept Details]]
 
:used for fetching the details of a concept which is identified through a codesystem and code.
 
:used for fetching the details of a concept which is identified through a codesystem and code.
Zeile 140: Zeile 138:
 
;[[CTS2-LE REST API: Delete Value Set / Code System|Delete Value Set / Code System]]
 
;[[CTS2-LE REST API: Delete Value Set / Code System|Delete Value Set / Code System]]
 
:allows to delete a FHIR coded value set (or code system).
 
:allows to delete a FHIR coded value set (or code system).
 +
 +
-->
  
 
=== SPARQL ===
 
=== SPARQL ===
Zeile 147: Zeile 147:
  
 
<!--
 
<!--
−
=== OWL (preliminary) ===
+
=== CTS2 REST-API ''(deprecated, use [[#FHIR_R4|FHIR R4]] instead)'' ===
−
;[[CTS2-LE REST API: OWL Update|Update]]
 
−
;[[CTS2-LE REST API: OWL Delete|Delete]]
 
−
-->
 
−
=== CTS2 REST-API ''(deprecated in future)'' ===
 
  
 
Most of the API below is supported by the FHIR R4 API. FHIR is emerging as a modern standard to cover all aspects of interoperable communication between all agents (human or machine) in eHealth.
 
Most of the API below is supported by the FHIR R4 API. FHIR is emerging as a modern standard to cover all aspects of interoperable communication between all agents (human or machine) in eHealth.
Zeile 161: Zeile 157:
 
;[[CTS2-LE REST API: Read Maps and Map Versions | Read Maps and Map Versions]]
 
;[[CTS2-LE REST API: Read Maps and Map Versions | Read Maps and Map Versions]]
 
;[[CTS2-LE REST API: Read Value Set Definitions | Read Value Set Definitions]]
 
;[[CTS2-LE REST API: Read Value Set Definitions | Read Value Set Definitions]]
−
<!--
 
−
;[[CTS2-LE REST API: Classify Text|REST API: Classify Text]]
 
−
:''(Andreas)''
 
−
:The ClassifyText API allows to index full text snippets using one or multiple terminologies. The request results in a set of concepts that best define the content of the provided text
 
−
;[[CTS2-LE REST API: Server Administration|Server Administration]]
 
−
:''(- - > Andreas, Raik)''
 
−
:tbd
 
−
-->
 
  
−
<!--
+
 
−
=== Sharing Value Sets (SVS) ===
 
−
;[[CTS2-LE SVS API: Update|Update Codesystem or Value Set]]
 
−
;[[CTS2-LE SVS API: Retrieve Codesystem or Value Set|Retrieve Codesystem or Value Set]]
 
−
-->
 
 
=== Classification Markup Language (ClaML) ===
 
=== Classification Markup Language (ClaML) ===
 
;[[CTS2-LE ClaML API: Update|Update Codesystem]]
 
;[[CTS2-LE ClaML API: Update|Update Codesystem]]
 
;[[CTS2-LE ClaML API: Retrieve Codesystem|Retrieve Codesystem]]
 
;[[CTS2-LE ClaML API: Retrieve Codesystem|Retrieve Codesystem]]
 +
-->
  
 
<!--
 
<!--
Zeile 246: Zeile 231:
 
-->
 
-->
  
−
== CTS2-LE Solution Management ==
+
== Navigator ==
 +
 
 +
;[[Grouping|Grouping]]
 +
:Grouping of terminologies in the navigator
 +
 
 +
<!--
 +
== Solution Management ==
 
;[[Licence and Availability Notes|CTS2-LE Licensing]]  
 
;[[Licence and Availability Notes|CTS2-LE Licensing]]  
 
:CTS2-LE is distributed by Fraunhofer FOKUS under a commercial license. This section provides information about the licensing terms and conditions for various CTS2-LE usage scenarios.
 
:CTS2-LE is distributed by Fraunhofer FOKUS under a commercial license. This section provides information about the licensing terms and conditions for various CTS2-LE usage scenarios.
Zeile 252: Zeile 243:
 
;[[CTS2-LE Release Management]]
 
;[[CTS2-LE Release Management]]
 
:Fraunhofer FOKUS is continuosly maintaining and further developing CTS2-LE. This section gives insight into the CTS2-LE development roadmap by sketching CTS2-LE add-ons and improvements which are under development at Fraunhofer FOKUS.
 
:Fraunhofer FOKUS is continuosly maintaining and further developing CTS2-LE. This section gives insight into the CTS2-LE development roadmap by sketching CTS2-LE add-ons and improvements which are under development at Fraunhofer FOKUS.
 +
-->
  
 
<!--
 
<!--

Aktuelle Version vom 8. Januar 2026, 14:31 Uhr


Controlled vocabularies (also known as code systems or terminologies) are common information artefacts in healthcare. They allow for univocally and precisely referencing of concepts and are core foundation of any semantic processing of health data. In particular all electronic communication in healthcare relies on coded concepts for semantic interoperability and automated data processing. The Object Management Group's Common Terminology Services Version 2 (CTS2) standard defines an accepted industry standard representation to share, query and maintain value sets and other terminology artifacts. CTS2 was the conceptual background/blueprint for the development of the terminology resource structure of FHIR. Therefore CTS2-LE is FHIR-enabled in order to support this standard that will be the main standard in electronic healthcare.

One method to achieve compliance with the structural profiles of FHIR terminologies and value sets is to use semantic web technologies that are widely used for vocabularies. In this way, artifacts such as code systems, code system elements (i.e., codes and their designations), associations and value sets (i.e., sets of code system elements) can be processed with semantic technologies. The CTS2 Linked Data Edition (CTS2-LE) terminology server provided by Fraunhofer FOKUS follows that foundation. It relies on the the Resource Description Framework (RDF) in conjunction with a RDFS-based schema vocabulary oriented towards the Frame Logic. So-called RDF signatures, based on this schema vocabulary, describe structural constraints according to the information model. Likewise, arbitrary object graphs can be processed and stored with these RDF signatures.


Overview

This section provides an overview about CTS2-LE. It introduces the building blocks and summarizes the most important functional features.

CTS2-LE Fact Sheet (German)
The Fact Sheet provides an overview considering the implemented functionalities and additional usability related features.
CTS2-LE Building Blocks
Building blocks feature a structural compliance to the Information Model, is linked-data ready by the means of W3C RDF, and is accessible through a HL7 FHIR and REST API as well as supporting the definition, composition and import of value sets. The knowledge base functionality is implemented with RDF as the representation language providing linkage capabilities for terminological entities. This section describes the architecture and internal design.
CTS2-LE Interoperability
The system is build upon international standards and provides multiple standard interfaces for connecting to external services. This section gives an overview on the standards supported and how these can be utilized for integrating with third party products.
Further Information Sources for CTS2-LE
Fraunhofer FOKUS has published various papers and brochures about CTS2-LE in particular and terminology services in general.

Installation, Deployment, and Setup

This section covers the installation and initial setup of CTS-LE within an organization. The installation is performed via a deployment to a Kubernetes system.

Installation, Deployment, and Setup V3
DEPRECATED
Installation, Deployment, and Setup V3 (2020 versions)
DEPRECATED
Installation, Deployment, and Setup V3 (2021 versions)
DEPRECATED
Installation, Deployment, and Setup V4 (2025)
V4 (version >= 4.0.0) with full HELM and BfArM support.
Supported Terminologies
Overview of the main standard vocabularies/versions.


Core Web Services

CTS2-LE provides a REST interface for integrating terminology services with custom and third-party applications. This section provides the technical specification of the REST Application Programming Interface.


General

The suggester has to be updated whenever a code system is loaded. The suggester is used for searches within the navigation frontend.
Update only has to be invoked for RDF triple loading or if elements of a resource are modified via editing. The search index is automatically updated whenever a code system is loaded.
List all rersources (code systems, value sets, concept maps).

FHIR R4

CTS2-LE supports essential parts of the FHIR REST API for

Not all parameters are supported, but in the context of customization for a project it will be enhanced. The following operations are supported.

The fhir base path is <host>/WebCts2LE/hapi-fhir.

Resource-type-independent

Code Systems

supported parameters: code, system, version, coding, displayLanguage
supported parameters: url, code, version, display, coding, codeableConcept, displayLanguage
supported parameters: codeA, codeB, system, version, codingA, codingB

Value Sets

supported parameters: url, valueSetVersion, includeDesignations
supported parameters: url, valueSetVersion, code, system, systemVersion, display, coding, codeableConcept, displayLanguage

Concept Maps

supported parameters: url, code, system, version, coding, codeableConcept, targetsystem

OWL

For index updating and deletion see General


SPARQL

SPARQL Query
Due to the full RDF-encoding of all terminology artifacts, CTS2-LE allows for arbitrary queries within and across terminologies, value sets, concepts, and concept relationships. This API provides means to transmit a standard SPARQL query to CTS2-LE. The query result is provided in standard SPARQL Query Results XML Format.


Futher Services

Concept Suggestion
retrieve results from suggestion (plain, restricted)
Concept Search
perform search operations (plain, restricted, similar)


Navigator

Grouping
Grouping of terminologies in the navigator


Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=Hauptseite&oldid=1387“