Documedis^® API – Frequently Asked Questions

Allgemein

Wie lautet die URL für PROD und INT?

URL PROD: https://documedis.hcisolutions.ch/2020-01/api/docs/index.html
URL INT: https://int.documedis.hcisolutions.ch/2020-01/api/docs/index.html

Wie kann die Documedis API im gesicherten Zustand genutzt werden?

Um unsere Documedis API im gesicherten Zustand zu nutzen, können Sie sich oben rechts authorisieren. Zudem muss die HCI-SoftwareOrgId=UserId mitgegeben werden.

In welchen Sprachen sind die Inhalte verfügbar?

Alle Daten sind in Deutsch oder Französisch verfügbar. Wird kein entsprechender Header angegeben, verwendet die API standardmässig deutsche Inhalte. Für französische Inhalte muss "fr-CH" hinterlegt werden.

Sprache des Inhalts: String, de-CH / fr-CH.

Unterschied products/autocomplete und product/search

Die Suche products/autocomplete ist keine wirkliche Suche. Es ist derjenige Endpoint, der die Suchvorschläge macht:

Für die eigentliche Suche empfehlen wir den Endpoint POST/products/search zu verwenden.

Artikeltyp

Wie erkennt man im Endpoint GET/products/{id} Artikel, welche bestellbar sind?

Im Attribut Artikeltyp ist ersichtlich, um welchen Typ es sich handelt.

articleType
id=0: übliche Bestelleinheit
id=1: Verkaufseinheit
id=2: Preiscode
id=3: MiGeL-Position
id=4: Abgabeeinheit (Single Dose)

Damit alle bestellbaren Produkte angezeigt werden, wird beim articleType der Filter mit id = 0 hinterlegt.


"articleType": {
  "id": "4",
  "description": "AbgabeEinheit"
}

"articleType": {
  "id": "0",
  "description": "Package"
}

Betäubungsmittel

Welches ist der Endpoint für die Informationen zu den Kontrollmassnahmen von Betäubungsmittel?

Die Informationen zu den Kontrollmassnahmen von Betäubungsmittel und psychotropen Stoffen finden sich unter dem Endpoint GET/products/{id} unter narcoticCode.


"narcoticCode": {
    "id": "a",
    "description": "Unterstehen allen Kontrollmassnahmen"
  },

a. Unterstehen allen Kontrollmassnahmen
b: Unterstehen nicht allen Kontrollmassnahmen
c: Unterstehen nicht allen Kontrollmassnahmen; in kleinen Mengen ohne Verschreibung erhältlich
d: Zugelassene Arzneimittel, die kontrollierte Substanzen des Verzeichnisses d gemäss BetmVV-EDI enthalten

Bilder

Wo finde ich die Identa Bilder und wo die Artikelbilder?

Artikelbilder
Im Endpoint GET/products/{id} werden Artikelbilder im Knoten articles/pictures gelistet. Im Knoten articles/hasPhoto wird mit hasPhoto = true informiert, ob ein Bild zu einem Artikel vorhanden ist.


"hasPhoto":true"
pictures":[
   {
      "elementNumber":163423,
      "source":"Industry",
      "type":"PICBACK",
      "typeDescription":"Artikel 2D: die flache Rückansicht (z.B. geeignet für Category Management, üblicherweise französisch beschriftet)\r\n",
      "photoDate":"2019-09-17T08:31:00"
   },
   {
      "elementNumber":179739,
      "source":"HCI",
      "type":"CONTENTFRONT",
      "typeDescription":"Verpackungsinhalt, Frontansicht",
      "photoDate":"2020-01-28T10:54:39.783"
   },
   {
      "elementNumber":179725,
      "source":"HCI",
      "type":"PICBACK3DPLUS",
      "typeDescription":"Artikel mit Inhalt: die schräge Rückansicht mit Inhalt, üblicherweise französisch beschriftet\r\n",
      "photoDate":"2020-01-27T10:06:30.55"
   },
   {
      "elementNumber":133284,
      "source":"Industry",
      "type":"PICFRONT3D",
      "typeDescription":"Artikel: die schräge Frontansicht (z.B. geeignet für Webshops, üblicherweise deutsch beschriftet)\r\n",
      "photoDate":"2023-06-20T15:02:00"
   },
   {
      "elementNumber":274096,
      "source":"Industry",
      "type":"PICBACK3DPLUS",
      "typeDescription":"Artikel mit Inhalt: die schräge Rückansicht mit Inhalt, üblicherweise französisch beschriftet\r\n",
      "photoDate":"2023-06-20T15:02:00"
   },
   {
      "elementNumber":163423,
      "source":"Industry",
      "type":"PICFRONT",
      "typeDescription":"Artikel 2D: die flache Frontansicht (z.B. geeignet für Category Management, üblicherweise deutsch beschriftet)\r\n",
      "photoDate":"2019-09-17T08:31:00"
   },
   {
      "elementNumber":179739,
      "source":"HCI",
      "type":"CONTENTBACK",
      "typeDescription":"Verpackungsinhalt, Rückansicht",
      "photoDate":"2020-01-28T10:54:47.47"
   },
   {
      "elementNumber":179725,
      "source":"HCI",
      "type":"PICFRONT3DPLUS",
      "typeDescription":"Artikel mit Inhalt: die schräge Frontansicht mit Inhalt, üblicherweise deutsch beschriftet\r\n",
      "photoDate":"2020-01-27T10:06:50.37"
   },
   {
      "elementNumber":163424,
      "source":"Industry",
      "type":"PICFRONTTOP",
      "typeDescription":"Artikel 2D mit Aufsicht: die flache Frontseite mit Aufsicht, üblicherweise deutsch beschriftet\r\n",
      "photoDate":"2019-09-17T08:31:00"
   },
   {
      "elementNumber":274096,
      "source":"Industry",
      "type":"PICFRONT3DPLUS",
      "typeDescription":"Artikel mit Inhalt: die schräge Frontansicht mit Inhalt, üblicherweise deutsch beschriftet\r\n",
      "photoDate":"2023-06-20T15:02:00"
   },
   {
      "elementNumber":163424,
      "source":"Industry",
      "type":"PICBACKTOP",
      "typeDescription":"Artikel 2D mit Aufsicht: die flache Rückseite mit Aufsicht, üblicherweise französisch beschriftet\r\n",
      "photoDate":"2019-09-17T08:31:00"
   },
   {
      "elementNumber":133284,
      "source":"Industry",
      "type":"PICBACK3D",
      "typeDescription":"Artikel: die schräge Rückansicht (z.B. geeignet für Webshops, üblicherweise französisch beschriftet)\r\n",
      "photoDate":"2023-06-20T15:02:00"
   },
   {
      "source":"HCI",
      "type":"VIEWER360",
      "typeDescription":"360°-Ansicht des Artikels (via separatem Viewer)",
      "photoDate":"2020-01-06T00:00:00"
   }
],

Identa Bilder (Komponentenbilder)
Das hasPicture Attribut bezieht sich auf die Bilder im Knoten components/pictures. Im Components Knoten sind ausschliesslich Identa Bilder (Bilder von Darreichungsformen bspw. "Pille" und Primärverpackung "Blister") vorhanden.


"hasPicture": true
"pictures": [
  {
    "elementNumber": 25733,
    "source": "HCI",
    "type": "DOSEFORMFRONT",
    "typeDescription": "Darreichungsform, Frontansicht",
    "photoDate": "2012-03-27T12:53:00"
  },
  {
    "elementNumber": 25733,
    "source": "HCI",
    "type": "DOSEFORMBACK",
    "typeDescription": "Darreichungsform, Rückansicht",
    "photoDate": "2012-03-27T12:53:00"
  }
]

Welchen Daten Typ haben die Produkt- und Artikelbilder?

Die Bilder sind alle mit dem Bildtyp jpeg verfügbar.

Wie verwende ich pictureType im Endpoint GET/products/image/{pictureType}/{idType}/{id}/{quality}?

pictureType ist mit dem CODETYPE 41 zu verwenden.

Firmen

Wie erhalte ich die GLN der Produktehersteller (companies) aus der API?

Falls eine GLN eines Produkteherstellers eines Produktes gesucht wird, kann unter dem Endpoint GET/products/{id} beim Knoten companies/companyNumber die CompanyNumber gesucht werden.

PO ist jeweils der Zulassungsinhaber und RP der Rechnungspartner.

Die CompanyNumber kann dann im Endpoint Get/products/company /{prtNo} eingesetzt werden, dort erhält man die GLN unter globalLocationNumber.


"companies": [
  {
    "companyNumber": 301,
    "type": {
      "id": "PO",
      "description": "PO"
    },
    "name": "Bayer (Schweiz) AG"
  },
  {
    "companyNumber": 301,
    "type": {
      "id": "RP",
      "description": "RP"
    },
    "name": "Bayer (Schweiz) AG"
  }
]


{
  "id": "301",
  "companyName": "Bayer (Schweiz) AG",
  "street": "Uetlibergstrasse 132",
  "zip": "8045",
  "location": "Zürich",
  "country": "CH",
  "phoneNumber": "+41444658111",
  "faxNumber": "+41444620754",
  "emailAdress": "info@bayer.ch",
  "internetAddress": "http://www.bayer.ch",
  "globalLocationNumber": "7601001002593",
  "hasProduct": true
}

Wo finden sich die Informationen zu E-Mail, Homepage und Telefon?

Es werden nur diejenigen Attribute angezeigt, bei welchen Daten hinterlegt sind:

Email:
GET/serviceProviders/{id} postalAddresses/electronicAddresses/address -> Type: “Mail”


"electronicAddresses": [
  {
    "type": "Mail",
    "address": "hotline@hcisolutions.ch"
  },
  {
    "type": "Website",
    "address": "http://www.hcisolutions.ch"
  }
]

Telefon:
GET/serviceProviders/{id} postalAddresses/communicationAddresses -> Type: “Phone”


electronicAddresses": [
  {
    "type": "Mail",
    "address": "hotline@hcisolutions.ch"
  },
  {
    "type": "Website",
    "address": "http://www.hcisolutions.ch"
  }
]

Homepage:
GET/serviceProviders/{id} postalAddresses/electronicAddresses/address -> Type: “Website”


"communicationAddresses": [
  {
    "type": "Fax",
    "number": "+41 58 8512700"
  },
  {
    "type": "Phone",
    "number": "+41 58 8512600"
  }
]

Leistungserbringer

Gibt es einen Endpoint für die ZSR-Nummer?

Die ZSR-Nummer ist unter dem Knotenpunkt GET/serviceProviders/{id} unter referenceNumbers/value verfügbar. Falls der Service Provider jedoch lediglich über eine K-Nummer verfügt, wird diese nicht angezeigt.


"referenceNumbers": [
  {
    "code": "ZSRNR",
    "value": "A566417",
    "note": "SG"
  }
]

Preise

Welche Preistypen sind in den Daten vorhanden

Gebräuchliche Preistypen sind:

PPUB: es werden ausschliesslich Publikumspreise publiziert, die als Preisquelle BAG (Bundesamt für Gesundheit) haben.
PPHA: Einkaufspreis für Detailhandel bei der Firma (exkl. MWST)
PEXF: Ex factory Preis = Einkaufspreis des Grossisten bei der Firma (exkl. MWST)


"publicPrice": {
  "price": 6.45,
  "type": {
    "id": "PPUB",
    "description": "Publikumspreis"
  },
  "company": {
    "id": "10498",
    "description": "Bundesamt für Gesundheit (BAG)"
  },
  "fromDate": "2021-12-01T00:00:00",
  "isCurrent": true
}

Produktnummer

Was ist der Unterschied zwischen “Id” und “ProductNumber” (int vs. string). Sollen wir “Id” überhaupt berücksichtigen?

Die "ID" und "ProductNumber" sind identisch. Die «Id» muss grundsätzlich nicht berücksichtigt werden.

Spezialitätenliste

Wo finde ich die Information, ob ein Produkt Kassenzulässig ist, resp. ob es von der OKP (Obligatorische Krankenpflegeversicherung) rückvergütet wird?

Sie finden diese Angabe unter dem Knotenpunkt GET/products/{id} unter articles/insuranceCode/id

10 = SL / GGSL
14 = MiGeL (Mittel- und Gegenständeliste)


"insuranceCode": {
  "shortDescription": "SL / GGSL",
  "date": "2010-08-01T00:00:00",
  "id": "10",
  "description": "SL / GGSL"
}

Substanzen

Wie lautet der Endpoint für die chemische Formel der Substanzen?

Der Endpoint lautet: GET/registers/substance/search unter childern/substanceAbda/formula.


"formula": "C9H8O4"

Wo findet sich das Attribut CAS?

Sie finden diese Daten unter dem Endpoint GET/registers/substance/search unter childern/substanceAbda/casRegisterId.


"casRegisterId": "0000050-78-2"

Wo finde ich das Attribut MMASS? Ist das mmol?

Es handelt sich hierbei um die molare Masse mit der Einheit g/mol. Diese Daten sind unter dem Endpoint GET/registers/substance/search unter childern/substanceAbda/relativeMolecularWeight zu finden.


"relativeMolecularWeight": "180,16"

Steht "H" im Knoten substanceAbda/substance in den Endpoints GET/registers/substance/search und GET/registers/substance/{id} für Hilfsstoff?

Das «H» in den erwähnten Endpoints steht für Hauptsubstanz. D steht für Derivate.

Tierarzneimittel

Wo findet sich die Information, ob es sich um ein Tierarzneimittel handelt?

Tierarzneimittel haben im Endpoint GET/products/{id} unter productGroupCode die id „VET“ hinterlegt:


"productGroupCode": {
  "id": "VET",
  "description": "Tierarzneimittel"
}

Verabreichungsweg

Wo finde ich den Verabreichungsweg?

Der Verabreichungsweg (Route of Administration) ist über den Endpoint GET/products/{id} für RouteOfAdministration verfügbar. Wir empfehlen für die Route of Administration folgendes Attribut zu verwenden, da es sich hier um die offiziellen Bezeichnungen handelt:
Comonents/routesMethodsOfAdministrationEDQM/route.


Comonents/routesMethodsOfAdministrationEDQM/route. 
"routesMethodsOfAdministrationEdqm": [{
  "method": {
    "id": "19",
    "description": "schlucken"
  },
  "route": {
    "id": "20053000",
    "description": "Zum Einnehmen"
  }
}]

Documedis® API – Frequently Asked Questions