BfArM Terminologies: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
K
 
(4 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
−
            <h1 id="loading-bfarm-terminologies">Loading BfArM Terminologies</h1>
 
 
<p>BfArM (Bundesinstitut für Arzneimittel und Medizinprodukte) provides the standard terminologies for Germany. To load these standard terminologies the customer has to create a dedicated directory (called <strong>LD</strong> in the following) together with a specification json file (<strong>SF</strong>). In context of docker, kubernetes etc. a dedicated volume should be used.</p>
 
<p>BfArM (Bundesinstitut für Arzneimittel und Medizinprodukte) provides the standard terminologies for Germany. To load these standard terminologies the customer has to create a dedicated directory (called <strong>LD</strong> in the following) together with a specification json file (<strong>SF</strong>). In context of docker, kubernetes etc. a dedicated volume should be used.</p>
 
<h2 id="packages">Packages</h2>
 
<h2 id="packages">Packages</h2>
−
<p>The packages downloaded from bfarm must be located in directory <strong>LD</strong><code>/packages</code>. The following structure is an example for two packages (ICDGM, OPS) with the specification file <code>fhir-pack-icd.jsonc</code> (<strong>SF</strong>).</p>
+
<p>The packages downloaded from bfarm must be located in directory <strong>LD</strong><code>/packages</code> (e.g. <strong>LD</strong> = <code>bfarm</code>). The following structure is an example for two packages (ICDGM, OPS) with the specification file <code>fhir-pack-icd.jsonc</code> (<strong>SF</strong>).</p>
 
<pre>
 
<pre>
 
bfarm
 
bfarm
Zeile 16: Zeile 15:
 
</pre>
 
</pre>
 
<h2 id="specification-file-sf">Specification File (<strong>SF</strong>)</h2>
 
<h2 id="specification-file-sf">Specification File (<strong>SF</strong>)</h2>
−
<pre>
+
<syntaxhighlight lang="json" line>
 
{
 
{
 
     "terminologyDesignator": "fhir-package",
 
     "terminologyDesignator": "fhir-package",
 
     "canonicalUrlRegex": "<regex>", // optional
 
     "canonicalUrlRegex": "<regex>", // optional
−
     "canonicalPackageRegex": "<regex>", // optional
+
     "packageRegex": "<regex>", // optional
 
     "loadGrouping": true // optional
 
     "loadGrouping": true // optional
 
}
 
}
−
</pre>
+
</syntaxhighlight>
 +
<ul>
 +
<li>
 +
<p><code>terminologyDesignator</code></p>
 
<ul>
 
<ul>
 +
<li>has to be set to <code>fhir-package</code></li>
 +
</ul>
 +
</li>
 
<li>
 
<li>
 
<p><code>canonicalUrlRegex</code></p>
 
<p><code>canonicalUrlRegex</code></p>
Zeile 37: Zeile 42:
 
</li>
 
</li>
 
<li>
 
<li>
−
<p><code>canonicalPackageRegex</code></p>
+
<p><code>packageRegex</code></p>
 
<ul>
 
<ul>
 
<li>this filter loads only packages whose <em>canonical package name</em> conforms to <code>&lt;regex&gt;</code>. The <em>canonical package name</em> ist defined as the form <code>&lt;name&gt;|&lt;version&gt;</code> where <code>name</code> and <code>version</code> are the properties in the package definition file
 
<li>this filter loads only packages whose <em>canonical package name</em> conforms to <code>&lt;regex&gt;</code>. The <em>canonical package name</em> ist defined as the form <code>&lt;name&gt;|&lt;version&gt;</code> where <code>name</code> and <code>version</code> are the properties in the package definition file
Zeile 55: Zeile 60:
 
</ul>
 
</ul>
 
<h3 id="example">Example</h3>
 
<h3 id="example">Example</h3>
−
<pre>
+
<syntaxhighlight lang="json" line>
 
{
 
{
 
     "terminologyDesignator": "fhir-package",
 
     "terminologyDesignator": "fhir-package",
 
     "canonicalUrlRegex": ".*(agerejec|exotic|einmalk).*",
 
     "canonicalUrlRegex": ".*(agerejec|exotic|einmalk).*",
−
     "canonicalPackageRegex": ".*(icd10gm\\|2025|ops\\|2025).*",
+
     "packageRegex": ".*(icd10gm\\|2025|ops\\|2025).*",
 
     "loadGrouping": true
 
     "loadGrouping": true
 
}
 
}
−
</pre>
+
</syntaxhighlight>
 
<p>In this example only the terminologies for age rejection and the exotic one of the ICD as well as the one-time codes of the OPS package will be loaded.</p>
 
<p>In this example only the terminologies for age rejection and the exotic one of the ICD as well as the one-time codes of the OPS package will be loaded.</p>
 
<h2 id="rest-interface">REST interface</h2>
 
<h2 id="rest-interface">REST interface</h2>
−
<p>The interface is exactly the same as described in section <code>[https://websites.fraunhofer.de/CTS2-LE/index.php/CTS2-LE_Supported_Terminologies#REST_interface here]</code>.</p>
+
<p>The interface is exactly the same as described the context of <code>[https://websites.fraunhofer.de/CTS2-LE/index.php/CTS2-LE_Supported_Terminologies#REST_interface classical loading]</code> (non-BfArM).</p>
 +
<h2 id="remark">Remark</h2>
 +
<p>Standard terminologies should preferably be loaded in accordance with the specification described here, if they are offered by BfArM. For terminologies that are not included in BfArM, the <code>[https://websites.fraunhofer.de/CTS2-LE/index.php/CTS2-LE_Supported_Terminologies previous specification]</code> can be used.</p>

Aktuelle Version vom 28. Oktober 2025, 23:30 Uhr

BfArM (Bundesinstitut für Arzneimittel und Medizinprodukte) provides the standard terminologies for Germany. To load these standard terminologies the customer has to create a dedicated directory (called LD in the following) together with a specification json file (SF). In context of docker, kubernetes etc. a dedicated volume should be used.

Packages

The packages downloaded from bfarm must be located in directory LD/packages (e.g. LD = bfarm). The following structure is an example for two packages (ICDGM, OPS) with the specification file fhir-pack-icd.jsonc (SF).

bfarm
|_ packages
|  |_ bfarm.terminologien.icd10gm-2025.0.0.tar.gz
|  |  |_ package/CodeSystem-icd10gm-agelow-2025.json
|  |  |_ package/CodeSystem-icd10gm-agereject-2025.json
|  |  |_ package/package.json
|  |  |_ ...
|  |_ bfarm.terminologien.ops-2025.0.0.tar.gz
|  |  |_ ...
|_ fhir-pack-icd.jsonc

Specification File (SF)

1 {
2     "terminologyDesignator": "fhir-package",
3     "canonicalUrlRegex": "<regex>", // optional
4     "packageRegex": "<regex>", // optional
5     "loadGrouping": true // optional
6 }

  • terminologyDesignator

    • has to be set to fhir-package

  • canonicalUrlRegex

    • this filter loads only terminologies whose canonical URL (https://hl7.org/fhir/R4/datatypes.html#canonical) conforms to <regex>. E.g., regex .*(agerejec|agelow).* will only load the terminologies CodeSystem-icd10gm-agereject-2025.json and CodeSystem-icd10gm-agelow-2025.json because its canonical URLs are
      • https: //terminologien.bfarm.de/fhir/CodeSystem/icd10gm-agereject|2025 and
      • https: //terminologien.bfarm.de/fhir/CodeSystem/icd10gm-agelow|2025, respectively.

  • packageRegex

    • this filter loads only packages whose canonical package name conforms to <regex>. The canonical package name ist defined as the form <name>|<version> where name and version are the properties in the package definition file
      • bfarm/packages/bfarm.terminologien.icd10gm-2025.0.0.tar.gz/package/package.json (see section Packages above).
      • E.g., regex .*(icd10gm\\|2025|ops\\|2025).* will only load the ICD and OPS package.

  • loadGrouping

    • if enabled the grouping for the navigator is automatically set. Note that it overwrites the present grouping. If the grouping has to be integrated into an existing one, the REST interface for read and write groupings can be used.

Example

1 {
2     "terminologyDesignator": "fhir-package",
3     "canonicalUrlRegex": ".*(agerejec|exotic|einmalk).*",
4     "packageRegex": ".*(icd10gm\\|2025|ops\\|2025).*",
5     "loadGrouping": true
6 }

In this example only the terminologies for age rejection and the exotic one of the ICD as well as the one-time codes of the OPS package will be loaded.

REST interface

The interface is exactly the same as described the context of classical loading (non-BfArM).

Remark

Standard terminologies should preferably be loaded in accordance with the specification described here, if they are offered by BfArM. For terminologies that are not included in BfArM, the previous specification can be used.

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