API to allow for Requests and Publishing of PhPIDs and GSIDs - XML Representation

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
: API to allow for Requests and Publishing of PhPIDs and GSIDs - XML Representation

Active as of 2026-03-04
Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="WHO-UMC-IDMP-service"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement WHO-UMC-IDMP-service</b></p><a name="WHO-UMC-IDMP-service"> </a><a name="hcWHO-UMC-IDMP-service"> </a><h2 id="title">API to allow for Requests and Publishing of PhPIDs and GSIDs</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 5.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Published on: 2026-03-04 09:18:10+0000 </li><li>Published by: Uppsala Monitoring Centre </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li>https://build.fhir.org/ig/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service</li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"/></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Task1-1">Task</a></td><td> </td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center">y</td><td>status, _id, _elements, page, _count, _format</td><td/><td/><td/></tr><tr><td><a href="#AdministrableProductDefinition1-2">AdministrableProductDefinition</a></td><td> </td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>_id, _elements, page, _count, _format</td><td/><td/><td/></tr><tr><td><a href="#MedicinalProductDefinition1-3">MedicinalProductDefinition</a></td><td> </td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>phpid, _id, _elements, page, _count, _format</td><td/><td/><td/></tr><tr><td><a href="#SubstanceDefinition1-4">SubstanceDefinition</a></td><td> </td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>_id, _elements, page, _count, _format</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Task1-1" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Task</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/task.html">Task</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>status</td><td><code>string</code></td><td><div><p>Status filter</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>Comma-separated list of PhPID</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_elements</td><td><code>string</code></td><td><div><p>Limit elements returned in bundle</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>page</td><td><code>string</code></td><td><div><p>Page number to return</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_count</td><td><code>string</code></td><td><div><p>Page size</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_format</td><td><code>string</code></td><td><div><p>Response format</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="AdministrableProductDefinition1-2" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>AdministrableProductDefinition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/administrableproductdefinition.html">AdministrableProductDefinition</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>Comma-separated list of PhPID</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_elements</td><td><code>string</code></td><td><div><p>Limit elements returned in bundle</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>page</td><td><code>string</code></td><td><div><p>Page number to return</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_count</td><td><code>string</code></td><td><div><p>Page size</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_format</td><td><code>string</code></td><td><div><p>Response format</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicinalProductDefinition1-3" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>MedicinalProductDefinition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/medicinalproductdefinition.html">MedicinalProductDefinition</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>phpid</td><td><code>string</code></td><td><div><p>PhPID</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>Comma-separated list of UMCProductID</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_elements</td><td><code>string</code></td><td><div><p>Limit elements returned in bundle</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>page</td><td><code>string</code></td><td><div><p>Page number to return</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_count</td><td><code>string</code></td><td><div><p>Page size</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_format</td><td><code>string</code></td><td><div><p>Response format</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="SubstanceDefinition1-4" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>SubstanceDefinition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/substancedefinition.html">SubstanceDefinition</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>Comma-separated list of GSID</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_elements</td><td><code>string</code></td><td><div><p>Limit elements returned in bundle</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>page</td><td><code>string</code></td><td><div><p>Page number to return</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_count</td><td><code>string</code></td><td><div><p>Page size</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_format</td><td><code>string</code></td><td><div><p>Response format</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="https://build.fhir.org/ig/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/CapabilityStatement/WHO-UMC-IDMP-service"/>
  <version value="1.0.0"/>
  <name value="UMC IDMP Request and Publish API"/>
  <title
         value="API to allow for Requests and Publishing of PhPIDs and GSIDs"/>
  <status value="active"/>
  <date value="2026-03-04T09:18:10.065Z"/>
  <publisher value="Uppsala Monitoring Centre"/>
  <contact>
    <name value="Uppsala Monitoring Centre"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.who-umc.org"/>
    </telecom>
  </contact>
  <contact>
    <name value="Uppsala Monitoring Centre"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.who-umc.org"/>
    </telecom>
  </contact>
  <description
               value="The UMC API supports management and publishing of PhPIDs and GSIDs as part of the ISO IDMP standard"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <kind value="capability"/>
  <software>
    <name value="UMC IDMP Request and Publish API"/>
    <version value="1.0.0"/>
  </software>
  <fhirVersion value="5.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <implementationGuide
                       value="https://build.fhir.org/ig/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Task"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="status"/>
        <type value="string"/>
        <documentation value="Status filter"/>
      </searchParam>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="Comma-separated list of PhPID"/>
      </searchParam>
      <searchParam>
        <name value="_elements"/>
        <type value="string"/>
        <documentation value="Limit elements returned in bundle"/>
      </searchParam>
      <searchParam>
        <name value="page"/>
        <type value="string"/>
        <documentation value="Page number to return"/>
      </searchParam>
      <searchParam>
        <name value="_count"/>
        <type value="string"/>
        <documentation value="Page size"/>
      </searchParam>
      <searchParam>
        <name value="_format"/>
        <type value="string"/>
        <documentation value="Response format"/>
      </searchParam>
    </resource>
    <resource>
      <type value="AdministrableProductDefinition"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="Comma-separated list of PhPID"/>
      </searchParam>
      <searchParam>
        <name value="_elements"/>
        <type value="string"/>
        <documentation value="Limit elements returned in bundle"/>
      </searchParam>
      <searchParam>
        <name value="page"/>
        <type value="string"/>
        <documentation value="Page number to return"/>
      </searchParam>
      <searchParam>
        <name value="_count"/>
        <type value="string"/>
        <documentation value="Page size"/>
      </searchParam>
      <searchParam>
        <name value="_format"/>
        <type value="string"/>
        <documentation value="Response format"/>
      </searchParam>
    </resource>
    <resource>
      <type value="MedicinalProductDefinition"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="phpid"/>
        <type value="string"/>
        <documentation value="PhPID"/>
      </searchParam>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="Comma-separated list of UMCProductID"/>
      </searchParam>
      <searchParam>
        <name value="_elements"/>
        <type value="string"/>
        <documentation value="Limit elements returned in bundle"/>
      </searchParam>
      <searchParam>
        <name value="page"/>
        <type value="string"/>
        <documentation value="Page number to return"/>
      </searchParam>
      <searchParam>
        <name value="_count"/>
        <type value="string"/>
        <documentation value="Page size"/>
      </searchParam>
      <searchParam>
        <name value="_format"/>
        <type value="string"/>
        <documentation value="Response format"/>
      </searchParam>
    </resource>
    <resource>
      <type value="SubstanceDefinition"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="Comma-separated list of GSID"/>
      </searchParam>
      <searchParam>
        <name value="_elements"/>
        <type value="string"/>
        <documentation value="Limit elements returned in bundle"/>
      </searchParam>
      <searchParam>
        <name value="page"/>
        <type value="string"/>
        <documentation value="Page number to return"/>
      </searchParam>
      <searchParam>
        <name value="_count"/>
        <type value="string"/>
        <documentation value="Page size"/>
      </searchParam>
      <searchParam>
        <name value="_format"/>
        <type value="string"/>
        <documentation value="Response format"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>