Documedis Plateforme API
Une API, d’innombrables applications
L’API Documedis offre une série de fonctions. Vous pouvez par exemple consulter des données de base, scanner des codes-barres ou effectuer des recherches complexes. Sur Documedis, Compendium et PharmaVista, nous avons mis en œuvre toutes les fonctionnalités avec l’API Documedis.
Étendue des fonctions
| Data Services | Medication | Vaccination |
|---|---|---|
| Consulter les données de base structurées des médicaments | Signer, vérifier, accepter et annuler les ordonnances électroniques | Consulter les vaccinations |
| Rechercher des noms de médicaments avec différents filtres | Conversions de format | Conversions de format |
| Rechercher des monographies structurées telles que des informations destinées aux patients et des informations professionnelles | | |
| Récupérer les métadonnées des images pour les boutiques en ligne | | |
| Compléter automatiquement le nom du médicament | | |
| Récupérer des produits ou articles similaires | | |
| Consulter des données de base des prestataires pour votre système CRM | | |
| Trouver des prestataires de services tels que des pharmacies ou des hôpitaux à proximité | | |
| Effectuer des recherches dans les registres thérapeutiques | | |
| Effectuer des recherches dans le registre LiMA | | |
| Consulter les informations sur les prix, y compris l’historique | | |
Faits & chiffres
de jeux de données
bases de données
applications
Avantages
Intégration simple
Intégration aisée dans les systèmes existants grâce à une solution web modulaire
Software as a Service
Aucune infrastructure supplémentaire nécessaire, car il s’agit d’une solution «Software as a Service»
Modulaire
Les modules individuels peuvent être intégrés progressivement
Support
Soutien complet lors de l’implémentation
Normes connues
Nutzung von bekannten Standards, Austauschformate und Convertern wie z.B. SNOMED-CT, FHIR
Actualité
Publication quotidienne des données
Request Documedis Token (English only)
If you do not yet have an access token for the Prod environment, you can request one here. The access token will be sent to you via SMS within 3 working days.
FAQ
Général
Quel est l’URL pour PROD et 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
Comment utiliser l’API Documedis en mode sécurisé?
Pour utiliser notre API Documedis en mode sécurisé, vous pouvez vous autoriser en haut à droite. En outre, le HCI-SoftwareOrgId=UserId doit être indiqué.
Dans quelles langues les contenus sont-ils disponibles?
Toutes les données sont disponibles en allemand ou en français. Si aucun en-tête correspondant n'est indiqué, l'API utilise par défaut des contenus en allemand. Pour les contenus en français, il faut indiquer "fr-CH".
Langue du contenu : String, de-CH / fr-CH.
Différence entre products/autocomplete et product/search
La recherche products/autocomplete n'est pas une vraie recherche. C'est le point d'accès qui fait les propositions de recherche.
Pour la recherche proprement dite, nous recommandons d'utiliser le point d'accès POST/products/search.
Article Type
Comment reconnaître dans le point d'accès GET/products/{id} les articles qui peuvent être commandés?
L'attribut type d'article indique de quel type il s'agit.
articleType
id=0: unité de commande habituelle
id=1: unité de vente
id=2: code de prix
id=3: position LiMA
id=4: unité de remise (Single Dose)
Pour que tous les produits pouvant être commandés soient affichés, le filtre de l'articleType est défini avec id = 0.
<?php
"articleType": {
"id": "4",
"description": "AbgabeEinheit"
}
"articleType": {
"id": "0",
"description": "Package"
}
?>Images
Où puis-je trouver les images Identa et où puis-je trouver les images des articles?
Images des articles
Dans le point d'accès GET/products/{id}, les images des articles sont listées dans le nœud articles/pictures. Dans le nœud articles/hasPhoto, hasPhoto = true permet de savoir si une image est disponible pour un article.
<?php
"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"
}
],
?>Images Identa (images des composants)
L'attribut hasPicture se réfère aux images dans le nœud components/pictures. Le nœud Components contient uniquement des images Identa (images de formes galéniques, par exemple "pilule" et emballage primaire "blister").
<?php
"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"
}
]
?>Quel est le type de données des images de produits et d'articles?
Les images sont toutes disponibles avec le type d'image jpeg
Comment utiliser pictureType dans le point de terminaison GET/products/image/{pictureType}/{idType}/{id}/{quality}?
pictureType doit être utilisé avec le CODETYPE 41.
Entreprises
Comment obtenir le GLN des fabricants de produits (companies) à partir de l'API?
Si un GLN d'un fabricant d'un produit est recherché, le CompanyNumber peut être recherché sous le point d’accès GET/products/{id} au niveau du nœud companies/companyNumber.
PO est le titulaire de l'autorisation et RP le partenaire de facturation.
Le CompanyNumber peut ensuite être utilisé dans le point d’accès Get/products/company /{prtNo}, où l'on obtient le GLN sous globalLocationNumber.
<?php
"companies": [
{
"companyNumber": 301,
"type": {
"id": "PO",
"description": "PO"
},
"name": "Bayer (Schweiz) AG"
},
{
"companyNumber": 301,
"type": {
"id": "RP",
"description": "RP"
},
"name": "Bayer (Schweiz) AG"
}
]
?><?php
{
"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
}
?>Où se trouvent les informations sur l'e-mail, la page d'accueil et le téléphone?
Seuls les attributs pour lesquels des données ont été enregistrées sont affichés:
Email:
GET/serviceProviders/{id} postalAddresses/electronicAddresses/address -> Type: “Mail”
<?php
"electronicAddresses": [
{
"type": "Mail",
"address": "hotline@hcisolutions.ch"
},
{
"type": "Website",
"address": "http://www.hcisolutions.ch"
}
]
?>Téléphone:
GET/serviceProviders/{id} postalAddresses/communicationAddresses -> Type: “Phone”
<?php
electronicAddresses": [
{
"type": "Mail",
"address": "hotline@hcisolutions.ch"
},
{
"type": "Website",
"address": "http://www.hcisolutions.ch"
}
]
?>Homepage:
GET/serviceProviders/{id} postalAddresses/electronicAddresses/address -> Type: “Website”
<?php
"communicationAddresses": [
{
"type": "Fax",
"number": "+41 58 8512700"
},
{
"type": "Phone",
"number": "+41 58 8512600"
}
]
?>Fournisseurs de services
Existe-t-il un point d’accès pour le numéro RCC?
Le numéro RCC est disponible sous le nœud GET/serviceProviders/{id} sous referenceNumbers/value. Toutefois, si le fournisseur de services ne dispose que d'un numéro K, celui-ci n'est pas affiché.
<?php
"referenceNumbers": [
{
"code": "ZSRNR",
"value": "A566417",
"note": "SG"
}
]
?>Prix
Quels types de prix sont présents dans les données ?
Les types de prix courants sont:
- PPUB : seuls les prix publics dont la source est l'OFSP (Office fédéral de la santé publique) sont publiés.
- PPHA : prix d'achat pour le commerce de détail auprès de l'entreprise (hors TVA).
- PEXF: prix ex factory = prix d'achat du grossiste auprès de l'entreprise (hors TVA).
<?php
"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
}
?>Liste des spécialités
Où puis-je trouver des informations sur l'admissibilité d'un produit ou son remboursement par l'AOS (assurance obligatoire des soins)?
Vous trouverez cette indication sous le nœud GET/products/{id} unter articles/insuranceCode/id
10 = LS / LSIC
14 = LiMA (Liste des moyens et appareils)
<?php
"insuranceCode": {
"shortDescription": "LS / LSIC",
"date": "2010-08-01T00:00:00",
"id": "10",
"description": "LS / LSIC"
}
?>Numéro produit
Quelle est la différence entre "Id" et "ProductNumber" (int vs. string). Devons-nous même prendre en compte "Id"?
L'"ID" et le "ProductNumber" sont identiques. L'"Id" ne doit en principe pas être pris en compte.
Substances
Quel est le point d’accès pour la formule chimique des substances?
Le point d’accès est: GET/registers/substance/search unter childern/substanceAbda/formula.
<?php
"formula": "C9H8O4"
?>Où se trouve l'attribut CAS?
Vous trouverez ces données sous le point d’accès GET/registers/substance/search sous childern/substanceAbda/casRegisterId.
<?php
"casRegisterId": "0000050-78-2"
?>Où puis-je trouver l'attribut MMASS ? S'agit-il de mmol?
Il s'agit de la masse molaire avec l'unité g/mol. Ces données sont disponibles sous le point d'accès GET/registers/substance/search sous childern/substanceAbda/relativeMolecularWeight.
<?php
"relativeMolecularWeight": "180,16"
?>Est-ce que "H" dans le nœud substanceAbda/substance dans les points d’accès GET/registers/substance/search et GET/registers/substance/{id} signifie excipient ?
Le "H" dans les points d’accès mentionnés signifie substance principale. D signifie dérivé.
Stupéfiants
Quel est le point d’accès pour les informations sur les mesures de contrôle des stupéfiants ?
Les informations sur les mesures de contrôle des stupéfiants et des substances psychotropes se trouvent sous le point d'accès GET/products/{id} sous narcoticCode.
<?php
"narcoticCode": {
"id": "a",
"description": " Soumis à toutes les mesures de contrôle "},
?>a. Soumis à toutes les mesures de contrôle
b: Soustraits partiellement aux mesures de contrôle
c: Ne sont pas soumis à toutes les mesures de contrôle ; disponibles en petites quantités sans ordonnance
d: Médicaments autorisés contenant des substances soumises à contrôle du tableau d de l'OTStup-DFI
Médicaments vétérinaires
Où peut-on trouver l'information indiquant s'il s'agit d'un médicament vétérinaire?
Les médicaments vétérinaires ont l'id "VET" enregistré dans le point d'accès GET/products/{id} sous
productGroupCode.
<?php
"productGroupCode": {
"id": "VET",
"description": "Tierarzneimittel"
}
?>Voie d’administration
Où puis-je trouver la voie d'administration?
La voie d'administration (Route of Administration) est disponible via le point d'accès GET/products/{id} pour RouteOfAdministration. Nous recommandons d'utiliser l'attribut suivant pour la Route of Administration, car il s'agit des désignations officielles.
<?php
Comonents/routesMethodsOfAdministrationEDQM/route.
"routesMethodsOfAdministrationEdqm": [{
"method": {
"id": "19",
"description": "schlucken"
},
"route": {
"id": "20053000",
"description": "Zum Einnehmen"
}
}]
?>Contact
