Medipim FR - API V4

Developer documentation

Field Glossary

(Last updated: )

Languages

The platform supports the native spoken languages for FR
We have also included English as this is the most common language among web development.

Possible values are: fr, en

Localized fields will always look like:

  • xxx:
    • language_iso2: ...

Country regions

The platforms supports the following country regions for FR.
code label
FR-01 Ain
FR-02 Aisne
FR-03 Allier
FR-04 Alpes-de-Haute-Provence
FR-05 Hautes-Alpes
FR-06 Alpes-Maritimes
FR-07 Ardèche
FR-08 Ardennes
FR-09 Ariège
FR-10 Aube
FR-11 Aude
FR-12 Aveyron
FR-13 Bouches-du-Rhône
FR-14 Calvados
FR-15 Cantal
FR-16 Charente
FR-17 Charente-Maritime
FR-18 Cher
FR-19 Corrèze
FR-20R Corse
FR-21 Côte-d'Or
FR-22 Côtes-d'Armor
FR-23 Creuse
FR-24 Dordogne
FR-25 Doubs
FR-26 Drôme
FR-27 Eure
FR-28 Eure-et-Loir
FR-29 Finistère
FR-2A Corse-du-Sud
FR-2B Haute-Corse
FR-30 Gard
FR-31 Haute-Garonne
FR-32 Gers
FR-33 Gironde
FR-34 Hérault
FR-35 Ille-et-Vilaine
FR-36 Indre
FR-37 Indre-et-Loire
FR-38 Isère
FR-39 Jura
FR-40 Landes
FR-41 Loir-et-Cher
FR-42 Loire
FR-43 Haute-Loire
FR-44 Loire-Atlantique
FR-45 Loiret
FR-46 Lot
FR-47 Lot-et-Garonne
FR-48 Lozère
FR-49 Maine-et-Loire
FR-50 Manche
FR-51 Marne
FR-52 Haute-Marne
FR-53 Mayenne
FR-54 Meurthe-et-Moselle
FR-55 Meuse
FR-56 Morbihan
FR-57 Moselle
FR-58 Nièvre
FR-59 Nord
FR-60 Oise
FR-61 Orne
FR-62 Pas-de-Calais
FR-63 Puy-de-Dôme
FR-64 Pyrénées-Atlantiques
FR-65 Hautes-Pyrénées
FR-66 Pyrénées-Orientales
FR-67 Bas-Rhin
FR-68 Haut-Rhin
FR-69 Rhône
FR-69M Métropole de Lyon
FR-6AE Alsace
FR-70 Haute-Saône
FR-71 Saône-et-Loire
FR-72 Sarthe
FR-73 Savoie
FR-74 Haute-Savoie
FR-75C Paris
FR-76 Seine-Maritime
FR-77 Seine-et-Marne
FR-78 Yvelines
FR-79 Deux-Sèvres
FR-80 Somme
FR-81 Tarn
FR-82 Tarn-et-Garonne
FR-83 Var
FR-84 Vaucluse
FR-85 Vendée
FR-86 Vienne
FR-87 Haute-Vienne
FR-88 Vosges
FR-89 Yonne
FR-90 Territoire de Belfort
FR-91 Essonne
FR-92 Hauts-de-Seine
FR-93 Seine-Saint-Denis
FR-94 Val-de-Marne
FR-95 Val-d'Oise
FR-971 Guadeloupe
FR-972 Martinique
FR-973 Guyane (française)
FR-974 La Réunion
FR-976 Mayotte
FR-ARA Auvergne-Rhône-Alpes
FR-BFC Bourgogne-Franche-Comté
FR-BL Saint-Barthélemy
FR-BRE Bretagne
FR-CP Clipperton
FR-CVL Centre-Val de Loire
FR-GES Grand-Est
FR-HDF Hauts-de-France
FR-IDF Île-de-France
FR-MF Saint-Martin
FR-NAQ Nouvelle-Aquitaine
FR-NC Nouvelle-Calédonie
FR-NOR Normandie
FR-OCC Occitanie
FR-PAC Provence-Alpes-Côte-d’Azur
FR-PDL Pays-de-la-Loire
FR-PF Polynésie française
FR-PM Saint-Pierre-et-Miquelon
FR-TF Terres australes françaises
FR-WF Wallis-et-Futuna

Product identifier codes

  • ean[]: EAN stands for European Article Number, which is a global trade number (GTIN) issued by GS1. GTINs are usually 8, 12, 13, or 14 digits long.
    This field is designed to hold current and legacy EAN-info about the product, thus it can contain multiple values.
  • gtin: GTIN stands for Global Trade Number, it's a globally recognised number issued by GS1 that's tied to a specific product. GTINs are usually 8, 12, 13, or 14 digits long.
    This field is designed to hold legacy GTIN-info about the product. (⚠️ deprecated use eanGtin14 instead)
  • eanGtin8: EAN 8 is used to identify products using 8-digit global trade number (GTIN 8). It is typically used outside the US and Canada.
  • eanGtin12: EAN12 is used to identify products using a 12-digit global trade number (GTIN 12). It is typically used within the US and Canada though.
  • eanGtin13: EAN13 is used to identify products using a 13-digit global trade number (GTIN 13). It is typically used outside the US and Canada.
  • eanGtin14: EAN 14 / GTIN is used to identify products using a 14-digit global trade number (GTIN 14). It is typically used outside the US and Canada.
  • ospId: Ospharéa ID
  • acl13: The structure of the 13-character ACL code is based on the use of:
    • a prefix 3401 which identifies the health product other than medicine;
    • an additional position to differentiate families;
    • the 7-character ACL code (which will eventually disappear);
    • a control key.
  • cip13: The outer packaging of medicinal products shall bear the CIP13 code, batch number and expiry date, marked in plain text. This code always starts with 3400
  • cip7OrAcl7: Presentation identifier code or "Code Identifiant de Présentation". This code is always 7 characters long.

Target groups

The content on Medipim is designed for multiple target groups.

  • public
  • pharmacist
  • doctor
  • homecare
  • hospital
  • nurse
  • physiotherapist
  • webshop

Media

Photo types

A photo can have one of the following types:

  • packshot
  • productshot
  • lifestyle_image
  • pillshot

Visible sides

The following sides of the product can be visible on a photo:

  • front
  • left
  • right
  • back
  • bottom
  • top

Link types

Links on Medipim can have one of the following types:

  • app
  • brochure
  • video
  • website

Product descriptions

Description types

code fr en
full_description Description générale General description
faq Questions fréquemment posées Frequently asked questions
measurements Dimensions Measurements
legal_text Texte légal Legal text
indication Indications Indications
contra_indication Contre-indications Contra indications
usage Usage Uses
usage_extended Utilisation prolongée Uses extended
composition Composition Composition
properties Propriétés Properties
side_effects Effets secondaires Side effects
nutritional_value Valeur nutritionnelle Nutritional value
usage_type Type d'utilisation Usage type
pregnancy_description Descriptif de grossesse Pregnancy description
pregnancy_description_extended Description de la grossesse étendue Pregnancy description extended
breastfeeding_description Description de l'allaitement Breastfeeding description
breastfeeding_description_extended Description détaillée de l'allaitement Breastfeeding description extended
interactions Interactions Interactions
warnings Avertissements Warnings
keywords Mots clés Keywords

hasContent

The hasContent filter allows you to filter products if they have a specific field. Let's say you want to get all products which have a weight value. Then you would just use this filter in the body:

"hasContent": {
 "flag" : "weight"
}

This is a very effective way to refine your selection and get optimized results. Of course, this can be combined with different filters. Such as the AND, NOT, OR filters. You can use the get-fields] endpoint to get a list of all the possible flags to filter on.

Add a locale parameter for fields that have localized values.

"hasContent": {
 "flag": "descriptions.usage",
 "locale": "fr"
}

See below for an advanced use case involving the hasContent filter.

HTML content

Tags that are not allowed (or invalid HTML) are stripped from the content.
Allowed HTML tags and their allowed properties:

  • <b>:
  • <i>:
  • <p>: `style`
  • <table>: `style`, `border`
  • <tbody>:
  • <thead>:
  • <tfoot>:
  • <tr>:
  • <th>: `style`, `colspan`, `rowspan`
  • <td>: `style`, `colspan`, `rowspan`
  • <ol>:
  • <ul>:
  • <li>:
  • <span>: `style`
  • <strong>:
  • <em>:
  • <div>: `class`, `style`
  • <h1>:
  • <h2>:
  • <h3>:
  • <h4>:
  • <h5>:
  • <h6>:
  • <dl>:
  • <dt>:
  • <dd>:
  • <blockquote>:
  • <sup>:
  • <sub>:

Numerical operators

Numerical operators are used in specific filters on Medipim; Their value can be one of the following:

  • eq
  • gt
  • gte
  • lt
  • lte
  • neq