Documents by active ingredient api

URL - endpoint

https://apim.medicines.org.uk/public_api/v1/activeIngredients/{activeIngredient}/documents

Metadata returned 

• id (Content id - unique identifier)
• Version (The current version number of the SmPC/PIL/RMM)
• Title (Content title - The title of the document )
• Type (SPC/PIL)
• Active Ingredients (A list of name(s) of the active ingredient(s) )
  • id (ingredient id - unique identifier)
  • name (ingredient name)
• Company
  • id (company id - unique identifier)
  • name (company name)
• Authorisation date (date published to emc)
• Retired date (date removed from emc)
• Last modified date 
• is Black triangle (Is this product subject to additional monitoring)
• is discontinued
• State (Whether the SmPC/PIL is published (authorised) or removed (retired) from the emc)
• Legal categories
  
  • Id (Legal Category id - unique identifier
  • name (Category name)
• emc url
• Discontinued items
• Has Xpil
• Content url
• Versions
• Rmms
  • id
  • Title
  • Description
  • Media Type
  • Content
  • Audience
  • CPN
  • Company id
• Has Rmm boolean (true/false)
• Cpn (Product Family)
• Related AMPs
  
  • AMP id
  • AMP description

Settings 

query parameters

• type
• limit integer (the maximum number of results that will be returned)
• offset integer (this is used to exclude from a response the first N results from being returned)
• publishedDateTo date (yyyy/mm/dd)
• daysOffset 
• state authorised/retired
• lastModifiedDateTo date (yyyy/mm/dd)

Request/Response Formats

Request options

GET 

Response formats

JSON, XML 

example 

 {
            "Id": 21377,
            "Version": 21,
            "Title": "Abstral Sublingual Tablets",
            "Type": "PIL",
            "ActiveIngredients": [
                {
                    "Id": 1749,
                    "Name": "fentanyl citrate"
                }
            ],
            "Company": {
                "Id": 4258,
                "Name": "Grunenthal Meds"
            },
            "AuthorisationDate": "2024-12-20T13:53:49.1027436",
            "RetiredDate": "0001-01-01T00:00:00",
            "LastModifiedDate": "2024-12-20T13:53:49.1027436",
            "IsBlackTriangle": false,
            "IsDiscontinued": false,
            "State": "Authorised",
            "LegalCategories": [
                {
                    "Id": 1,
                    "Name": "POM"
                }
            ],
            "EmcUrl": "https://www.medicines.org.uk/emc/medicine/21377/pil",
            "DiscontinuedItems": [],
            "HasXpil": true,
            "ContentUrl": "https://api.medicines.org.uk/v1/files/PIL.21377.21.pdf",
            "Versions": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20,
                21
            ],
            "Rmms": [
                {
                    "Id": 101006,
                    "Title": "Abstral - UK Pharmacist Guide",
                    "Description": "Important risk minimisation information, on Abstral (fentanyl citrate) sublingual tablet, for pharmacists",
                    "MediaType": "Document",
                    "Content": "files/RMM.101006.pdf",
                    "Audience": [
                        "HCP"
                    ],
                    "Cpn": "Abstral",
                    "CompanyId": 4258
                },
                {
                    "Id": 2894,
                    "Title": "Abstral - UK Patient and Carer guide",
                    "Description": "Important risk minimisation information, on Abstral (fentanyl citrate) sublingual tablet, for patients prescribed Abstral and their carers",
                    "MediaType": "Document",
                    "Content": "files/RMM.2894.pdf",
                    "Audience": [
                        "Public"
                    ],
                    "Cpn": "Abstral",
                    "CompanyId": 4258
                },
                {
                    "Id": 2893,
                    "Title": "Abstral - UK Prescriber Guide",
                    "Description": "Important risk minimisation information, on Abstral (fentanyl citrate) sublingual tablet, for physicians",
                    "MediaType": "Document",
                    "Content": "files/RMM.2893.pdf",
                    "Audience": [
                        "HCP"
                    ],
                    "Cpn": "Abstral",
                    "CompanyId": 4258
                }
            ],
            "HasRmm": true,
            "Cpn": "Abstral",
            "RelatedAmps": []
        }

Authentication

apiKey