Documentation for the eonum catalogue search API

Locales

Available locales are de|fr|it|en. All API calls have to prefixed with one of these locales

Search parameters

For all search calls you can provide the following parameters:
  • search - the search term
  • max_results - maximum number of search results.
  • terminal_only - Only applicable in ICD and CHOP search. Do search for terminal codes only: terminal_only=1
  • highlight - Show highlighted search terms in respective fields: highlight=1
  • simple_search - Use a simplified search with exact matching of code and description field. Empty search terms are also allowed. Order is not based on ranking but on alphabetical order of codes.
Only applicable for certain search calls:
  • date (in the DD.MM.YYYY format) - Only applicable in MiGeL and AL. Yields results active at provided date. If date not specified, only active codes are returned.
  • authorized - Only applicable for Drugs. Default search for authorized drugs. If set to authorized=0, search yields result for all Drugs.
For all code view calls (DRG, ADRG, MDC, Partition, ICD, CHOP, CHOP chapter, ICD chapter, ICD group, MiGeL, AL, Drugs) you can provide the following parameters:
  • show_detail - if set to '1' the requested code is shown with all details including children and parent codes with links.
Only applicable for certain code view calls:
  • date (in the DD.MM.YYYY format) - Only applicable in MiGeL and AL. Yields results active at provided date. If date not specified, only active codes are returned.
  • authorized - Only applicable for Drugs. Default search for authorized drugs. If set to authorized=0, search yields result for all Drugs.
All objects obtained by a code call or in a parent or children field of a detailed code call have at least the fields: code, text, url

DRGs - Diagnosis Related Groups (SwissDRG)

scope: '/:locale/drgs' Versions are in the format [0-z.\-]+, codes are in the format [0-z]+, usually 4 characters

GET /:locale/drgs/versions Get a list of all valid DRG versions as a JSON array of strings.

Sample call: /de/drgs/versions
Example: Populate a dropdown using AJAX

GET /:locale/drgs/:version/:code Get one DRG by its code and version as a JSON object

Sample call: /de/drgs/V3.0/P67A

GET /:locale/mdcs/:version/:code Get one MDC by its code and version as a JSON object

Sample call: /de/mdcs/V3.0/02

GET /:locale/partitions/:version/:code Get one Partition by its code and version as a JSON object

Sample call: /de/partitions/V3.0/B_M

GET /:locale/drgs/:version/search Search for DRGs by code, description text or relevant codes. Retrieve results as a JSON array.

Sample call: /de/drgs/V3.0/search?max_results=2&search=Magen
Result:

ADRGs / Base DRGs (SwissDRG)

scope: '/:locale/adrgs' Versions are identical to the DRG versions, codes are in the format [0-z]+, usually 3 characters

GET /:locale/adrgs/:version/:code Get one ADRG by its code and version as a JSON object.

Sample call: /de/adrgs/V3.0/P67

GET /:locale/adrgs/:version/search Search for ADRGs by code, description text or relevant codes (ICD or CHOP). Retrieve results as a JSON array.

Sample call: /de/adrgs/V3.0/search?max_results=2&search=Magen
Result:

Supplements / Zusatzentgelte (SwissDRG)

scope: '/:locale/supplements' Versions are identical to the DRG versions. However not all old DRG versions (< 6.0) have supplements. Codes are in the format ZE-[0-9]{4}-[0-9]+(\.[0-9]+)?

GET /:locale/supplements/:version/:code Get one supplement by its code and version as a JSON object.

Sample call: /de/supplements/V8.0/ZE-2019-24.11

GET /:locale/supplement/:version/search Search for supplement by code or description text. Retrieve results as a JSON array.

Sample call: /de/supplements/V8.0/search?max_results=2&search=Magen
Result:

CHOPs (Swiss Surgery Classification)

scope: '/:locale/chops' Versions are in the format CHOP_[0-9]+, codes are in the format [0-z.\-]+

GET /:locale/chops/versions Get a list of all valid CHOP versions as a JSON array of strings.

Sample call: /de/chops/versions

GET /:locale/chops/:version/:code Get one CHOP code by its code and version as a JSON object.

Sample call: /de/chops/CHOP_2014/39.49

GET /:locale/chops/:version/search Search for CHOP codes by code, description text or inclusions. Retrieve results as a JSON array.

Sample call: /de/chops/CHOP_2014/search?max_results=2&search=Magen
Result:

GET /:locale/chop_chapters/:version/:code Get one CHOP chapter by its code and version as a JSON object.

Sample call: /de/chop_chapters/CHOP_2014/C3

ICDs (International Classification of Diseases. Mostly the German Modifications)

scope: '/:locale/icds' Codes are in the format [0-z.\-]+

GET /:locale/icds/versions Get a list of all valid ICD versions as a JSON array of strings.

Sample call: /de/icds/versions

GET /:locale/icds/:version/:code Get one ICD code by its code and version as a JSON object.

Sample call: /de/icds/ICD10-GM-2014/T817

GET /:locale/icds/:version/search Search for ICD codes by code, description text, inclusions or synonyms. Retrieve results as a JSON array.

Sample call: /de/icds/ICD10-GM-2014/search?max_results=2&search=Magen
Result:

GET /:locale/icd_groups/:version/:code Get one ICD group by its code and version as a JSON object.

Sample call: /de/icd_groups/ICD10-GM-2014/A00-A09

GET /:locale/icd_chapters/:version/:code Get one ICD chapter by its code and version as a JSON object.

Sample call: /de/icd_chapters/ICD10-GM-2014/II

TARMEDs (Tarif Médical)

scope: '/:locale/tarmeds' Versions are in the format TARMED_[0-9]{2}\.[0-9]{2}, codes are in the format [0-9.]{2,11}

GET /:locale/tarmeds/versions Get a list of all valid TARMED versions as a JSON array of strings.

Sample call: /de/tarmeds/versions

GET /:locale/tarmeds/:version/:code Get one TARMED code by its code and version as a JSON object.

Sample call: /de/tarmeds/TARMED_01.09/05.0910

GET /:locale/tarmeds/:version/search Search for TARMED codes by code, description text, inclusions or synonyms. Retrieve results as a JSON array.

Sample call: /de/tarmeds/TARMED_01.09/search?max_results=2&search=Magen
Result:

GET /:locale/tarmed_chapters/:version/:code Get one TARMED chapter by its code and version as a JSON object.

Sample call: /de/tarmed_chapters/TARMED_01.09/05

GET /:locale/tarmed_groups/:version/:code Get one TARMED group by its code and version as a JSON object.

Sample call: /de/tarmed_groups/TARMED_01.09/05

GET /:locale/tarmed_blocks/:version/:code Get one TARMED block by its code and version as a JSON object.

Sample call: /de/tarmed_blocks/TARMED_01.09/05

MiGeLs (Mittel- und Gegenständeliste)

scope: '/:locale/migels' Version is in the format MIGEL (we do not distinguish different versions but keep track of code changes via active flag), codes are in the format [0-z.]+

GET /:locale/migels/:version/:code Get one MiGeL code by its code and version as a JSON object.

Sample call: /de/migels/MIGEL/01.01.01.00.1

GET /:locale/migels/:version/:code/all Get all MiGeL (active and inactive) by its code and version as a JSON object.

Sample call: /de/migels/MIGEL/01.01.01.00.1/all

GET /:locale/migels/:version/search Search for MiGeL codes by code, title or description text. Retrieve results as a JSON array.

Sample call: /de/migels/MIGEL/search?max_results=2&search=absaug
Result:

Drugs (from SAI-Refdatabase)

scope: '/:locale/drugs' Version is in the format DRUG (we do not distinguish different versions), codes are in the format [0-9]{13}

GET /:locale/drugs/:version/:code Get one Drug code by its code and version as a JSON object.

Sample call: /de/drugs/DRUG/7680517950406

GET /:locale/drugs/:version/search Search for Drug codes by code, title, description text, substance name, field of application, ... Retrieve results as a JSON array.

Sample call: /de/drugs/DRUG/search?max_results=2&search=aspir
Result:

Laboratory Analyses (from Analyseliste (AL))

scope: '/:locale/laboratory_analyses' Version is in the format AL (we do not distinguish different versions but keep track of code changes via active flag), codes are in the format /[0-9]{4}\.?[0-9]{2}/ (Pos.-Nr.) or /[A-D]{1}[0-9]?\.?[0-9]?/i (chapters).

GET /:locale/laboratory_analyses/:version/:code Get one AL code by its code and version as a JSON object.

Sample call: /de/laboratory_analyses/AL/6603.54

GET /:locale/laboratory_analyses/:version/:code/all Get all AL codes (active and inactive) by its code and version as a JSON object.

Sample call: /de/laboratory_analyses/AL/6603.54/all

GET /:locale/laboratory_analyses/:version/search Search for AL codes by code, title, description text, limitation, comment or faculty. Retrieve results as a JSON array.

Sample call: /de/laboratory_analyses/AL/search?max_results=2&search=glukose
Result: