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

## UMC IDMP Request and Publish API

Official URL: http://who-umc.org/idmp/ImplementationGuide/idmp.who-umc.org.fhir | Version: 0.1.0
Active as of 2025-11-19 | Computable Name: UmcIDMPManagement

### Scope

The scope of this Implementation Guide is to document the UMC IDMP API FHIR service, by describing the context in which the API can be used as well as the technical overview for using the API.

### Introduction

This Implementation Guide has a target audience of system integrators to the UMC IDMP API. The API is based on the HL7 FHIR standard and this guide describes supported FHIR resources.

The Implementation Guide describes how FHIR standard is used to exchange data for ISO IDMP standards for global PhPIDs and GSIDs. For information about ISO IDMP, see the Background section in this guide.

The main resources maintained by the service are the Pharmaceutical Product IDs, PhPIDs, (manifested through the AdministrableProductDefinition resource) and the Global Substance IDs, GSIDs, (manifested through the SubstanceDefinition resource). However, the MedicinalProductDefinition resource is also vital since it serves as input for PhPID generation. The Implementation Guide describes how new global PhPIDs are requested using asynchronous FHIR requests, and how they are delivered through FHIR.

#### Access to the UMC IDMP FHIR server

##### Production

The production FHIR server can be reached at https://idmp.who-umc.org/fhir. To get access to the production server, please contact asa.parnaste [at] who-umc.org.

##### Preview

The preview FHIR server can be reached at https://preview-idmp.who-umc.org/fhir. To get access to the preview server, please contact asa.parnaste [at] who-umc.org.

##### Proof of Concept

The PoC FHIR server can be reached at https://api.umcterminologies.org/idmp. A tutorial with examples is found at https://api.umcterminologies.org/

### Dependencies

IG | Package | FHIR | Comment
--- | --- | --- | ---
UMC IDMP Request and Publish API | idmp.who-umc.org.fhir#0.1.0 | R5 |
HL7 Terminology (THO) | hl7.terminology.r5#7.0.0 | R5 | Automatically added as a dependency - all IGs depend on HL7 Terminology
FHIR Extensions Pack | hl7.fhir.uv.extensions.r5#5.2.0 | R5 |
FHIR Tooling Extensions IG | hl7.fhir.uv.tools.r5#0.8.0 | R5 | for example references

Package hl7.fhir.uv.extensions.r5#5.2.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

Package hl7.fhir.uv.tools.r5#0.8.0 This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Aug 5, 2025 20:09+1000+10:00)

### Cross Version Analysis

### Global Profiles

There are no Global profiles defined

### IP statements

This publication includes IP covered under the following statements.

- This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  - SNOMED Clinical Terms&reg; (SNOMED CT&reg;): MedicinalProductDefinitionWhoPhP, MedicinalProductDefinitionWhoPhPRequest and VsRouteOfAdministration
- This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  - Organization type: Task/task-completed-phpid and Task/template-generated-by-server-phpid-req
  - SubscriptionChannel Type Codes: Demo end point, SubscriptionIdmpEvent and channelType
- Unless otherwise indicated, reproduction of material posted on Council of Europe websites, and reproduction of photographs for which the Council of Europe holds copyright – see legal notice \“photo credits\” – is authorised for private use and for informational and educational uses relating to the Council of Europe’s work. This authorisation is subject to the condition that the source be indicated and no charge made for reproduction. Persons wishing to make some other use than those specified above, including commercial use, of information and text posted on these sites are asked to apply for prior written authorisation to the Council of Europe, Directorate of Communication.
  Show Usage
  - EDQM Standard Terms: MedicinalProductDefinitionWhoPhP, MedicinalProductDefinitionWhoPhPRequest and pharmaceuticalForm
- Uppsala Monitoring Centre
  Show Usage
  - WHODrug DrugCode: MedicinalProductDefinition/1266520E021 and MedicinalProductDefinition/1A0661AE2A40
  - EDQM dose form attributes: AME, AdministrableProductDefinition/6C4563BB76BE7967594979196EC91CD8... Show 8 more, AdministrableProductDefinition/91B3CA582581F57E4092F13AAF476215, BDF, ISI, RCA, edqm-AME, edqm-BDF, edqm-ISI and edqm-RCA
  - Additional jurisdictional areas compolementing the ISO 3166 country codes: MedicinalProductDefinitionWhoPhP, MedicinalProductDefinitionWhoPhPRequest, Task/task-completed-phpid, Task/template-generated-by-server-phpid-req and VsJurisdiction
  - PhPId level: AdministrableProductDefinition/6C4563BB76BE7967594979196EC91CD8, AdministrableProductDefinition/8195D4AF1287CCE3442C2F308F61DBBC... Show 5 more, AdministrableProductDefinition/91B3CA582581F57E4092F13AAF476215, AdministrableProductDefinition/93FE88350C2E8868F7E8BD220C4E0010, AdministrableProductDefinitionWhoPhP, Task/task-completed-phpid and VsPhpIdLevels
  - Strength units applicable in the IDMP PhPID service: IngredientWhoPhPPublish, Task/task-completed-phpid, Task/template-generated-by-server-phpid-req and VsStrengthUnit
  - Task input type: Task/task-completed-phpid, Task/template-generated-by-server-phpid-req... Show 4 more, TaskGeneratePhPID, TaskGeneratePhPIDStatus, VsGSIDTaskInputTypes and VsPhPIDTaskInputTypes
  - Task output type: Task/task-completed-phpid, TaskGeneratePhPIDStatus, VsGSIDTaskOutputTypes and VsPhPIDTaskOutputTypes
  - Task request code: Task/task-completed-phpid, Task/template-generated-by-server-phpid-req, TaskGeneratePhPID and TaskGeneratePhPIDStatus
- WHO Collaborating Centre for Drug Statistics Methodology, Oslo, Norway. Use of all or parts of the material requires reference to the WHO Collaborating Centre for Drug Statistics Methodology. Copying and distribution for commercial purposes is not allowed. Changing or manipulating the material is not allowed.
  Show Usage
  - ATC classification system: MedicinalProductDefinition/1266520E021, MedicinalProductDefinition/1A0661AE2A40, MedicinalProductDefinitionWhoPhP, MedicinalProductDefinitionWhoPhPRequest and VsAtcClassification

### Authors and Contributors

Roles | Name | Organization | Contact
--- | --- | --- | ---
Author | Magnus Wallberg | Uppsala Monitoring Centre | magnus.wallberg [at] who-umc.org
Author | Giorgio Cangioli | HL7 Europe | giorgio.cangioli [at] gmail.com
Author | Åsa Pärnaste | Uppsala Monitoring Centre | asa.parnaste [at] who-umc.org
Author | João Almeida | HL7 Europe | joaofilipe90 [at] gmail.com
Author | Mikael Nilsson | Uppsala Monitoring Centre | mikael.nilsson [at] who-umc.org