BfArM Terminologies

Loading BfArM Terminologies

BfArM (Bundesinstitut für Arzneimittel und Medizinprodukte) provides the standard terminologies for Germany. To simplify the loading process, an extra Y is defined, which can be executed with the existing interface for loading standard terminologies. Due to license policies of standard terminology providers we do not make available provider input files. Customers have to download these files from provider sites.

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. The following structure is an example for two packages (ICDGM, OPS) with the specification file fhir-pack-icd.jsonc (SF).

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

Specification File (SF)

<code class="language-json"><span class="hljs-punctuation">{</span>
    <span class="hljs-attr">"terminologyDesignator"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"fhir-package"</span><span class="hljs-punctuation">,</span>
    <span class="hljs-attr">"canonicalUrlRegex"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"<regex>"</span><span class="hljs-punctuation">,</span> <span class="hljs-comment">// optional</span>
    <span class="hljs-attr">"canonicalPackageRegex"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"<regex>"</span><span class="hljs-punctuation">,</span> <span class="hljs-comment">// optional</span>
    <span class="hljs-attr">"loadGrouping"</span><span class="hljs-punctuation">:</span> <span class="hljs-keyword">true</span> <span class="hljs-comment">// optional</span>
<span class="hljs-punctuation">}</span>
</code>

• canonicalUrlRegex: this filter loads only terminologies whose <a href="https://hl7.org/fhir/R4/datatypes.html#canonical">canonical URL</a> 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%7C2025 and https://terminologien.bfarm.de/fhir/CodeSystem/icd10gm-agelow%7C2025, respectively.

• canonicalPackageRegex: this filter loads only terminologies whose canonical package regex conforms to <regex>. The canonical package regex 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 <a href="#packages">Packages</a>). E.g., regex .*(icd10gm\\|2025|ops\\|2025).*

• loadGrouping: if enabled the grouping for the navigator is automatically set.

Example

<code class="language-json"><span class="hljs-punctuation">{</span>
    <span class="hljs-attr">"terminologyDesignator"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"fhir-package"</span><span class="hljs-punctuation">,</span>
    <span class="hljs-attr">"canonicalUrlRegex"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">".*(agerejec|exotic|einmalk|icf-q-anatomische-lokalisation).*"</span><span class="hljs-punctuation">,</span>
    <span class="hljs-attr">"canonicalPackageRegex"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">".*(icd10gm\\|2025|ops\\|2025).*"</span><span class="hljs-punctuation">,</span>
    <span class="hljs-attr">"loadGrouping"</span><span class="hljs-punctuation">:</span> <span class="hljs-keyword">true</span>
<span class="hljs-punctuation">}</span>
</code>

REST interface

see !!!