UMC IDMP Request and Publish API
1.0.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 1.0.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 and Publishing of PhPIDs and GSIDs

Official URL: https://build.fhir.org/ig/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/CapabilityStatement/WHO-UMC-IDMP-service Version: 1.0.0
Active as of 2026-03-04 Computable Name: UMC IDMP Request and Publish API

The UMC API supports management and publishing of PhPIDs and GSIDs as part of the ISO IDMP standard

Raw OpenAPI-Swagger Definition file | Download

API to allow for Requests and Publishing of PhPIDs and GSIDs

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 5.0.0
  • Supported Formats: xml, json
  • Published on: 2026-03-04 09:18:10+0000
  • 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 TypeProfileRSUCSearches_include_revincludeOperations
Task yyystatus, _id, _elements, page, _count, _format
AdministrableProductDefinition yy_id, _elements, page, _count, _format
MedicinalProductDefinition yyphpid, _id, _elements, page, _count, _format
SubstanceDefinition yy_id, _elements, page, _count, _format
Core FHIR Resource
Task
Reference Policy
Interaction summary
  • Supports read, create, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLstatusstring

Status filter

SHALL_idstring

Comma-separated list of PhPID

SHALL_elementsstring

Limit elements returned in bundle

SHALLpagestring

Page number to return

SHALL_countstring

Page size

SHALL_formatstring

Response format

 
Core FHIR Resource
AdministrableProductDefinition
Reference Policy
Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idstring

Comma-separated list of PhPID

SHALL_elementsstring

Limit elements returned in bundle

SHALLpagestring

Page number to return

SHALL_countstring

Page size

SHALL_formatstring

Response format

 
Core FHIR Resource
MedicinalProductDefinition
Reference Policy
Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLphpidstring

PhPID

SHALL_idstring

Comma-separated list of UMCProductID

SHALL_elementsstring

Limit elements returned in bundle

SHALLpagestring

Page number to return

SHALL_countstring

Page size

SHALL_formatstring

Response format

 
Core FHIR Resource
SubstanceDefinition
Reference Policy
Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idstring

Comma-separated list of GSID

SHALL_elementsstring

Limit elements returned in bundle

SHALLpagestring

Page number to return

SHALL_countstring

Page size

SHALL_formatstring

Response format