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
Official URL: http://who-umc.org/idmp/CapabilityStatement/WHO-UMC-IDMP-service | Version: 0.1.0 | |||
Draft as of 2024-09-09 | Computable Name: WHO-UMC IDMP Management and Publish API |
The WHO-UMC API supports management and publishing of OhPIDs and GSIDs as part of the ISO IDMP standard
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement WHO-UMC-IDMP-service
xml
, json
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.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
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 | |||||||||
Organization | y | _id, identifier, name | ||||||||
CapabilityStatement | y | |||||||||
SubscriptionTopic | y | _id, name, url | ||||||||
Subscription | y | y | y | y | _id, identifier, name, topic | |||||
SubscriptionStatus | y | _id, identifier, name, topic | ||||||||
ImplementationGuide | y |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | string | Task identifier from requester in format 'sendingSystem|localId' |
SHALL | status | string | Search Task by status |
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 |
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 |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | string | WHODrug product 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 |
Only available within the scope of an AdministrableProductDefinition
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' |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | string | |
SHALL | identifier | string | |
SHALL | name | string | Name of organization (contains search) |
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 |
read
, create
, delete
, update
.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 |
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 |