WHO-UMC IDMP Management 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

Authentication

This part of the specification is only available in the preview API

Introduction

The PhPIDs (APD) and GSIDs (SD) is publicly available. Requesting new PhPIDs and GSIDs requires authentication and the access to detailed drug information through the MedicinalProductDefinition API requires a special license. It is also only possible to request the status of and delete a request (Task) for tasks generated using the same authentication credentials. Deletion of requests are only allowed as long as it is not completed.

Also all Subscription handling (create, update, delete and retrieval) requires authentication. Subscriptions on Task events will only apply to Tasks created by the same account as the Subscription.

It is possible to search APDs using MPD attributes, like MPD identifier, without a license to retrieve the actual MPD.

Some information/attributes on the SD that is not within the public domain also requires a special license. Without the license the information will be hidden from the SD resource.

Authentication process

To authenticate when using for example the Task and Subscription API an http header should be supplied named Ocp-Apim-Subscription-Key. In the demo version of the API any guid on the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx can be used. However, it is important to always use the same guid for one user since the guid will identify the "owner" of the Task.

Requesting access

This process has yet to be developed.

Abbreviations

• SD - SubstanceDefinition
• APD - AdministrableProductDefinition
• MPD - MedicinalProductDefinition