UMC IDMP Request and Publish API
0.1.0 - CI Build

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`
- 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`

### 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 Type | Profile | R | S | U | C | D | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Task |  | y |  |  | y | y | identifier, 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 |  | y |  | y | y | y | _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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | identifier | `string` | Task identifier from requester in format 'sendingSystem|localId'
SHALL | status | `string` | Search Task by status

#### Resource Conformance: supported SubstanceDefinition

Core FHIR Resource
SubstanceDefinition
Reference Policy
Interaction summary

- Supports `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | GSID
SHALL | identifier | `string` | GSID
SHALL | name | `string` | Name of substance (contains search)
SHALL | code | `string` | Code from other code system

#### Resource Conformance: supported AdministrableProductDefinition

Core FHIR Resource
AdministrableProductDefinition
Reference Policy
Interaction summary

- Supports `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | PhPID
SHALL | identifier | `string` | PhPID
SHALL | form-of | `string` | Find PhPIDs for an internal product ID in the
SHALL | form-of:identifier | `string` | Find PhPIds for a MPID
SHALL | dose-form | `string` | Find PhPIDs with a specific dose-form
SHALL | parent-php | `reference` | Search PhPIDs based on 'parent' PhPIDs

#### Resource Conformance: supported MedicinalProductDefinition

Core FHIR Resource
MedicinalProductDefinition
Reference Policy
Interaction summary

- Supports `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | WHODrug record Id
SHALL | identifier | `string` | MPID
SHALL | name | `string` | Product name (contains search)
SHALL | name-jurisdiction | `string` | Jurisdiction according to urn:iso:std:iso:3166
SHALL | name-country | `string` | Country according to urn:iso:std:iso:3166
SHALL | product-classification | `token` | 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | substance-code | `string` | Find by substance (GSID) code
SHALL | strength-presentation-quantity | `token` | 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | Id of the SubscriptionTopic
SHALL | name | `string` | Name of the SubscriptionTopic (contains search)
SHALL | url | `string` | Url of the SubscriptionTopic

#### Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary

- Supports `read`, `create`, `delete`, `update`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | Id of the Subscription
SHALL | identifier | `string` |
SHALL | name | `string` | Name of the Subscription (contains search)
SHALL | topic | `string` | Topic (full url) of the Subscription

#### Resource Conformance: supported SubscriptionStatus

Core FHIR Resource
SubscriptionStatus
Reference Policy
Interaction summary

- Supports `read`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | Id of the Subscription
SHALL | identifier | `string` |
SHALL | name | `string` | Name of the Subscription (contains search)
SHALL | topic | `string` | Topic (full url) of the Subscription

#### Resource Conformance: supported ImplementationGuide

Core FHIR Resource
ImplementationGuide
Reference Policy
Interaction summary

- Supports `read`.