Documedis® API – Frequently Asked Questions

Documedis TecDoc

Général

Loading

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

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é.

Documedis API authorize

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.

La recherche products/autocomplete n'est pas une vraie recherche. C'est le point d'accès qui fait les propositions de recherche.

products/autocomplete

Pour la recherche proprement dite, nous recommandons d'utiliser le point d'accès POST/products/search.

Article Type

Loading

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.


"articleType": {
  "id": "4",
  "description": "unité de remise"
}

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

Entreprises

Loading

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.


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

Seuls les attributs pour lesquels des données ont été enregistrées sont affichés:

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

"electronicAddresses": [
  {
    "type": "Mail",
    "address": "hotline@hcisolutions.ch"
  },
  {
    "type": "Website",
    "address": "http://www.hcisolutions.ch"
  }
]
  • Homepage:
    GET/serviceProviders/{id} postalAddresses/electronicAddresses/address -> Type: “Website”

"electronicAddresses": [
  {
    "type": "Mail",
    "address": "hotline@hcisolutions.ch"
  },
  {
    "type": "Website",
    "address": "http://www.hcisolutions.ch"
  }
]
  • Telefon:
    GET/serviceProviders/{id} postalAddresses/communicationAddresses -> Type: “Phone”

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

Forme d’administration

Loading

Le point d’accès est GET/products/{id}. Nous recommandons d'utiliser l'attribut "pharmaceuticalDoseFormEdqm" pour la forme galénique.


"pharmaceuticalDoseFormEdqm": { "id": "10222000",
"description": "Comprimé effervescent"}

Fournisseurs de services

Loading

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é.


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

Images

Loading

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.


"hasPhoto": true

"pictures": [
  {
    "elementNumber": 8779,
    "source": "HCI",
    "type": "PICBACK3D",
    "typeDescription": "Article: l’image de la face oblique arrière de l’article (par ex. adaptée au Webshops, libellé habituellement en français)\r\n",
    "photoDate": "2012-02-15T12:49:00"
  },
  {
    "elementNumber": 30679,
    "source": "HCI",
    "type": "CONTENTFRONT",
    "typeDescription": "Contenu de l'emballage, vue frontale",
    "photoDate": "2021-06-17T11:40:13.323"
  },
  {
    "elementNumber": 8779,
    "source": "HCI",
    "type": "PICFRONT3D",
    "typeDescription": "Article: l’image de la face oblique avant de l’article (par ex. adaptée au Webshops, libellé habituellement en allemand)\r\n",
    "photoDate": "2012-02-15T12:49:00"
  },
  {
    "elementNumber": 30679,
    "source": "HCI",
    "type": "CONTENTBACK",
    "typeDescription": "Contenu de l'emballage, vue arrière",
    "photoDate": "2021-06-17T11:40:28.847"
  }
]

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").


"hasPicture": true

"pictures": [
  {
    "elementNumber": 25733,
    "source": "HCI",
    "type": "DOSEFORMFRONT",
    "typeDescription": "Forme d'administration, vue frontale",
    "photoDate": "2012-03-27T12:53:00"
  },
  {
    "elementNumber": 25733,
    "source": "HCI",
    "type": "DOSEFORMBACK",
    "typeDescription": "Forme d'administration, vue arrière",
    "photoDate": "2012-03-27T12:53:00"
  }
]

Les images sont toutes disponibles avec le type d'image jpeg

pictureType doit être utilisé avec le CODETYPE 41.

Liste des spécialités

Loading

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)


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

Numéro produit

Loading

L'"ID" et le "ProductNumber" sont identiques. L'"Id" ne doit en principe pas être pris en compte.

Médicaments vétérinaires

Loading

Les médicaments vétérinaires ont l'id "VET" enregistré dans le point d'accès GET/products/{id} sous
productGroupCode.


"productGroupCode": {
  "id": "VET",
  "description": "Médicaments vétérinaires"
}

Stupéfiants

Loading

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.


"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

Prix

Loading

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)


"publicPrice": {
  "price": 6.45,
  "type": {
    "id": "PPUB",
    "description": "prix public"
  },
  "company": {
    "id": "10498",
    "description": "Bundesamt für Gesundheit (BAG)"
  },

Substances

Loading

Le point d’accès est: GET/registers/substance/search unter childern/substanceAbda/formula.


"formula": "C9H8O4"

Vous trouverez ces données sous le point d’accès GET/registers/substance/search sous childern/substanceAbda/casRegisterId.


"casRegisterId": "0000050-78-2"

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.


"relativeMolecularWeight": "180,16"

Le "H" dans les points d’accès mentionnés signifie substance principale. D signifie dérivé.

Voie d’administration

Loading

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 :


"routesMethodsOfAdministrationEdqm": [
  {
    "method": {
      "id": "19",
      "description": "avaler"
    },
    "route": {
      "id": "20053000",
      "description": "Voie orale"
    }
  }
]