UMC IDMP Request and Publish API
0.1.0 - CI Build International flag

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions

CapabilityStatement: API to allow for Requests of PhPIDs and Publishing of PhPIDs, GSIDs and MPDs

Official URL: http://who-umc.org/idmp/CapabilityStatement/UMC-IDMP-API Version: 0.1.0
Draft as of 2025-04-24 Computable Name: UMC IDMP Request and Publish API

The UMC IDMP API supports management and publishing of PhPIDs and publishing of GSIDs as part of the ISO IDMP standard. It also supports publishing of some other related resources as described in the Implementation Guide

Raw OpenAPI-Swagger Definition file | Download

API to allow for Requests of PhPIDs and Publishing of PhPIDs, GSIDs and MPDs

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 5.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2025-04-24
  • Published by: Uppsala Monitoring Centre

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

  • https://build.fhir.org/ig/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
Task yyyidentifier, status
SubstanceDefinition y_id, identifier, name, code
AdministrableProductDefinition y_id, identifier, form-of, form-of:identifier, dose-form, parent-php
MedicinalProductDefinition y_id, identifier, name, name-jurisdiction, name-country, product-classification
Ingredient substance-code, strength-presentation-quantity
CapabilityStatement y
SubscriptionTopic y_id, name, url
Subscription yyyy_id, identifier, name, topic
SubscriptionStatus y_id, identifier, name, topic
ImplementationGuide y

Resource Conformance: supported Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • Supports read, create, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifierstring

Task identifier from requester in format 'sendingSystem|localId'

SHALLstatusstring

Search Task by status

 

Resource Conformance: supported SubstanceDefinition

Core FHIR Resource
SubstanceDefinition
Reference Policy
Interaction summary
  • Supports read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idstring

GSID

SHALLidentifierstring

GSID

SHALLnamestring

Name of substance (contains search)

SHALLcodestring

Code from other code system

 

Resource Conformance: supported AdministrableProductDefinition

Core FHIR Resource
AdministrableProductDefinition
Reference Policy
Interaction summary
  • Supports read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idstring

PhPID

SHALLidentifierstring

PhPID

SHALLform-ofstring

Find PhPIDs for an internal product ID in the

SHALLform-of:identifierstring

Find PhPIds for a MPID

SHALLdose-formstring

Find PhPIDs with a specific dose-form

SHALLparent-phpreference

Search PhPIDs based on 'parent' PhPIDs

 

Resource Conformance: supported MedicinalProductDefinition

Core FHIR Resource
MedicinalProductDefinition
Reference Policy
Interaction summary
  • Supports read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idstring

WHODrug record Id

SHALLidentifierstring

MPID

SHALLnamestring

Product name (contains search)

SHALLname-jurisdictionstring

Jurisdiction according to urn:iso:std:iso:3166

SHALLname-countrystring

Country according to urn:iso:std:iso:3166

SHALLproduct-classificationtoken

Used to search for products given a PhPID

 

Resource Conformance: supported Ingredient

Core FHIR Resource
Ingredient
Reference Policy
Interaction summary

    Documentation

    Only available within the scope of an AdministrableProductDefinition

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLsubstance-codestring

    Find by substance (GSID) code

    SHALLstrength-presentation-quantitytoken

    Search parameter on the format '5.4|http://unitsofmeasure.org|mg'

     

    Resource Conformance: supported CapabilityStatement

    Core FHIR Resource
    CapabilityStatement
    Reference Policy
    Interaction summary
    • Supports read.

    Resource Conformance: supported SubscriptionTopic

    Core FHIR Resource
    SubscriptionTopic
    Reference Policy
    Interaction summary
    • Supports read.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_idstring

    Id of the SubscriptionTopic

    SHALLnamestring

    Name of the SubscriptionTopic (contains search)

    SHALLurlstring

    Url of the SubscriptionTopic

     

    Resource Conformance: supported Subscription

    Core FHIR Resource
    Subscription
    Reference Policy
    Interaction summary
    • Supports read, create, delete, update.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_idstring

    Id of the Subscription

    SHALLidentifierstring
    SHALLnamestring

    Name of the Subscription (contains search)

    SHALLtopicstring

    Topic (full url) of the Subscription

     

    Resource Conformance: supported SubscriptionStatus

    Core FHIR Resource
    SubscriptionStatus
    Reference Policy
    Interaction summary
    • Supports read.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_idstring

    Id of the Subscription

    SHALLidentifierstring
    SHALLnamestring

    Name of the Subscription (contains search)

    SHALLtopicstring

    Topic (full url) of the Subscription

     

    Resource Conformance: supported ImplementationGuide

    Core FHIR Resource
    ImplementationGuide
    Reference Policy
    Interaction summary
    • Supports read.