Medipim AU - API V4

Developer documentation

Field Glossary

(Last updated: )

Languages

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

Possible values are: en

Localized fields will always look like:

  • xxx:
    • language_iso2: ...

Country regions

The platforms supports the following country regions for AU.
code label
AU-ACT Australian Capital Territory
AU-NSW New South Wales
AU-NT Northern Territory
AU-QLD Queensland
AU-SA South Australia
AU-TAS Tasmania
AU-VIC Victoria
AU-WA Western Australia

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.
  • Fred: Fred POS Code.
  • Z Code: ZRegister POS Code.
  • PBS: Pharmaceutical Benefits Scheme Code.
  • SNOMED-MP: Medicinal Product Code.
  • SNOMED-MPP: Medicinal Product Pack Code.
  • SNOMED-MPUU: Medicinal Product Units of Use Code.
  • SNOMED-TP: Trade Product Code.
  • SNOMED-TPP: Trade Product Pack Code.
  • SNOMED-TPUU: Trade Product Unit of Use Code.
  • SNOMED-CTPP: Contained Trade Product Pack Code.

Target groups

The content on Medipim is designed for multiple target groups.

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

Media

Media types

We have different media types available:

  • photo
  • frontal
  • link

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 en
full_description General description
faq Frequently asked questions
measurements Measurements
legal_text Legal text
indication Indications
contra_indication Contra indications
usage Uses
usage_extended Uses extended
composition Composition
properties Properties
side_effects Side effects
nutritional_value Nutritional value
usage_type Uses type
pregnancy_description Pregnancy description
pregnancy_description_extended Pregnancy description extended
breastfeeding_description Breastfeeding description
breastfeeding_description_extended Breastfeeding description extended
interactions Interactions
warnings Warnings
keywords 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": "en"
}

For descriptions you can also specify who generated the content.
Possible values are: system_generated, user_generated, ai_generated

"hasContent": {
 "flag": "user_generated.descriptions.usage",
 "locale": "en"
}

ARTG ID

Australian Register of Therapeutic Goods ID (corresponding to AUST R)

Dietary Restrictions

code en
alcohol_free Alcohol-free
allergens_free Allergens free
bio Bio
dairy_free Dairy free
fragrance_free Fragrance free
gluten_free Gluten free
halal Halal
kosher Kosher
lactose_free Lactose free
latex_free Latex free
low_carbs Poor in carbohydrates
low_in_purine Low in purine
no_nuts Nut free
protein_rich Protein rich
salt_free_diet Salt free
soy_free Soy free
sugar_free Sugar free
vegan Vegan
vegetarian Vegetarian
without_dyes Without dyes
without_fructose Without fructose
without_palm_oil Without palm oil
without_preservatives Without preservatives
yeast_free Yeast free

Colors

code en
beige Beige
black Black
blue Blue
bordeaux Bordeaux
brown Brown
gold Gold
gray Gray
green Green
khaki Khaki
multicolor Multicolor
ocher Ocher
orange Orange
pink Pink
purple Purple
red Red
transparent Transparent
white White
yellow Yellow

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