NHnhs

Virtual Medicinal Product (VMP)

A Virtual Medicinal Product is an abstract concept representing a template of the properties which constitute one or more actual medicinal products.

get/vmp/{vmpid}

Request

  • Base URL
    https://systems.digital.nhs.uk/v0.0.1
  • URL
    https://systems.digital.nhs.uk/v0.0.1/vmp/{vmpid}
  • Auth
    none declared

Path parameters

vmpidnumber required

Virtual medicinal product identifier. This code will be taken from the UK extension namespace section of SNOMED CT.

Query parameters

summaryboolean

Return only a minimal response containing mandatory items

releasestring

The specific version of DM+D to return content from. If not present the current content is returned.

Response

A VMP

vmpidinteger required

Unique identifier for the Virtual Medicinal Product. Snomed CT id

namestring required

The ‘long’ version of the medicinal product name. May change between releases

invalidboolean

True indicates that this dictionary entry is invalid.

vtmidinteger

ID of the associated Virtual Therapeutic Moiety

vmpid_datestring date

date from which the vmpid is applicable

previous_vmpidinteger

Previously allocated unique identifier for the Virtual Medicinal Product. Snomed CT id.

combination_productboolean

Where true denotes a combination product or only available as a component of a combination product (i.e. not available in its own right.

Examples-

  • Combination product - Conjugated Oestrogens 1.25mg tablets and Norgestrel 150microgram tablets.
  • Component only – Norgestrel 150microgram tablets.
name_basisinteger

Basis or source of VMP name expressed as a code value

Values-

  • 1 - Recommended International Non-proprietary Name – rINN
  • 2 - British Approved Name - BAN
  • 3 - British Approved Name (Modified) – BANM
  • 4 - International Non-proprietary Name (Modified) – INNM
  • 5 - Proposed International Non-proprietary Name – pINN
  • 6 - United States Adopted Name – USAN
  • 7 - Other
name_datestring date

Date from which the name became the preferred name for the medicinal product.

prev_namestring

Long name used prior to name_date

prev_name_basis1 | 2 | 3 | 4 | 5 | 6 | 7

Basis or source of prev_name expressed as a code value

Values-

  • 1 - Recommended International Non-proprietary Name – rINN
  • 2 - British Approved Name - BAN
  • 3 - British Approved Name (Modified) – BANM
  • 4 - International Non-proprietary Name (Modified) – INNM
  • 5 - Proposed International Non-proprietary Name – pINN
  • 6 - United States Adopted Name – USAN
  • 7 - Other
name_change_reason1 | 2 | 3 | 4

Reason for change of VMP text name, expressed as a code value

Values-

  • 1 - Replacement of temporary name
  • 2 - ew approved generic name available
  • 3 - Basis of name changed
  • 4 - Other
short_namestring

An abbreviated version of the name up to 60 characters

sugar_freeboolean

Is medicinal product a sugar-free formulation

gluten_freeboolean

Is medicinal product a gluten-free formulation

preservative_freeboolean

Is medicinal product a preservative-free formulation

cfc_freeboolean

Is medicinal product a CFC-free formulation

prescribing_status1 | 2 | 4 | 6 | 7 | 8

Prescribing status of the product expressed as a code value.

Values-

  • 1 - valid as a prescribable product
  • 2 - Invalid to prescribe in NHS primary care
  • 4 - never valid to prescribe as a VMP
  • 6 - VMP not recommended to prescribe - brands not bioequivalent
  • 7 - VMP not recommended to prescribe - patient training required
  • 8 - VMP not recommended to prescribe -no published specification
availability0 | 1 | 9

Indicator of availablity of corresponding Actual Medicinal Products.

Values-

  • 0 - actual products are now available (though not necessarily prescribable in primary care) but have been unavailable in the past.
  • 1 - actual products no longer available
  • 9 - AMPs available now
availability_datestring date

date of availability status

dose_form1 | 2 | 3

This attribute identifies if the VMP has a unit dose form (a discrete unit dose is applicable e.g. tablet, ampoule), if it may be regarded as a continuous substance (that is a consistent physically measurable unit or sub-unit cannot be defined e.g. cream, eye drops) or if it belongs to a category of product for which unit dose form is not appropriate (catheters, colostomy bags, ACBS foods)

Values-

  • 1 - Discrete
  • 2 - Continuous
  • 3 - Not applicable
unit_dose_form_sizenumber

a numerical value

formstring

Product form (from List C in Editorial Policy). Examples- effervescent tablet, sachet, injection

form_routestring[]

The physical conformation of the drug and its mode(s) of administration.

Changes

No recorded changes to this operation across all 1 revision of this API.