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

## : API to allow for Requests of PhPIDs and Publishing of PhPIDs, GSIDs and MPDs - XML Representation

Draft as of 2025-04-24

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="UMC-IDMP-API"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement UMC-IDMP-API</b></p><a name="UMC-IDMP-API"> </a><a name="hcUMC-IDMP-API"> </a><h2 id="title">API to allow for Requests of PhPIDs and Publishing of PhPIDs, GSIDs and MPDs</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 5.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Published on: 2025-04-24 </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 class="text-center"><b title="DELETE a resource (delete interaction)">D</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"/><td class="text-center"/><td class="text-center">y</td><td class="text-center">y</td><td>identifier, status</td><td/><td/><td/></tr><tr><td><a href="#SubstanceDefinition1-2">SubstanceDefinition</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td>_id, identifier, name, code</td><td/><td/><td/></tr><tr><td><a href="#AdministrableProductDefinition1-3">AdministrableProductDefinition</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td>_id, identifier, form-of, form-of:identifier, dose-form, parent-php</td><td/><td/><td/></tr><tr><td><a href="#MedicinalProductDefinition1-4">MedicinalProductDefinition</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td>_id, identifier, name, name-jurisdiction, name-country, product-classification</td><td/><td/><td/></tr><tr><td><a href="#Ingredient1-5">Ingredient</a></td><td> </td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td>substance-code, strength-presentation-quantity</td><td/><td/><td/></tr><tr><td><a href="#CapabilityStatement1-6">CapabilityStatement</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#SubscriptionTopic1-7">SubscriptionTopic</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td>_id, name, url</td><td/><td/><td/></tr><tr><td><a href="#Subscription1-8">Subscription</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>_id, identifier, name, topic</td><td/><td/><td/></tr><tr><td><a href="#SubscriptionStatus1-9">SubscriptionStatus</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td>_id, identifier, name, topic</td><td/><td/><td/></tr><tr><td><a href="#ImplementationGuide1-10">ImplementationGuide</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><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: supported </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>delete</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>identifier</td><td><code>string</code></td><td><div><p>Task identifier from requester in format 'sendingSystem|localId'</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>string</code></td><td><div><p>Search Task by status</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-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </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>.</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>GSID</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div><p>GSID</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Name of substance (contains search)</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>code</td><td><code>string</code></td><td><div><p>Code from other code system</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-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </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>.</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>PhPID</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div><p>PhPID</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>form-of</td><td><code>string</code></td><td><div><p>Find PhPIDs for an internal product ID in the</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>form-of:identifier</td><td><code>string</code></td><td><div><p>Find PhPIds for a MPID</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>dose-form</td><td><code>string</code></td><td><div><p>Find PhPIDs with a specific dose-form</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-parent-php.html">parent-php</a></td><td><code>reference</code></td><td><div><p>Search PhPIDs based on 'parent' PhPIDs</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-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </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>.</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>WHODrug record Id</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div><p>MPID</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Product name (contains search)</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>name-jurisdiction</td><td><code>string</code></td><td><div><p>Jurisdiction according to urn:iso:std:iso:3166</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>name-country</td><td><code>string</code></td><td><div><p>Country according to urn:iso:std:iso:3166</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>product-classification</td><td><code>token</code></td><td><div><p>Used to search for products given a PhPID</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="Ingredient1-5" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Ingredient</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/ingredient.html">Ingredient</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/></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Only available within the scope of an AdministrableProductDefinition</p>
    </div></blockquote></div></div><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>substance-code</td><td><code>string</code></td><td><div><p>Find by substance (GSID) code</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>strength-presentation-quantity</td><td><code>token</code></td><td><div><p>Search parameter on the format '5.4|http://unitsofmeasure.org|mg'</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="CapabilityStatement1-6" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>CapabilityStatement</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/capabilitystatement.html">CapabilityStatement</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>.</li></ul></div></div><p/><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="SubscriptionTopic1-7" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>SubscriptionTopic</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/subscriptiontopic.html">SubscriptionTopic</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>.</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>Id of the SubscriptionTopic</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Name of the SubscriptionTopic (contains search)</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>string</code></td><td><div><p>Url of the SubscriptionTopic</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="Subscription1-8" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Subscription</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/subscription.html">Subscription</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>delete</code>, <code>update</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>Id of the Subscription</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Name of the Subscription (contains search)</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>topic</td><td><code>string</code></td><td><div><p>Topic (full url) of the Subscription</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="SubscriptionStatus1-9" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>SubscriptionStatus</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/subscriptionstatus.html">SubscriptionStatus</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>.</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>Id of the Subscription</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Name of the Subscription (contains search)</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>topic</td><td><code>string</code></td><td><div><p>Topic (full url) of the Subscription</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="ImplementationGuide1-10" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>ImplementationGuide</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/implementationguide.html">ImplementationGuide</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>.</li></ul></div></div><p/><p/></div></div></div></div>
      </text>
      <url value="http://who-umc.org/idmp/CapabilityStatement/UMC-IDMP-API"/>
      <version value="0.1.0"/>
      <name value="UMC IDMP Request and Publish API"/>
      <title
             value="API to allow for Requests of PhPIDs and Publishing of PhPIDs, GSIDs and MPDs"/>
      <status value="draft"/>
      <date value="2025-04-24"/>
      <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 IDMP API supports management and publishing of PhPIDs and publishing of GSIDs as part of the ISO IDMP standard. It also supports publishing of some other related resources as described in the Implementation Guide"/>
      <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="0.5.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="delete"/>
          </interaction>
          <searchParam>
            <name value="identifier"/>
            <type value="string"/>
            <documentation
                           value="Task identifier from requester in format 'sendingSystem|localId'"/>
          </searchParam>
          <searchParam>
            <name value="status"/>
            <type value="string"/>
            <documentation value="Search Task by status"/>
          </searchParam>
        </resource>
        <resource>
          <type value="SubstanceDefinition"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="string"/>
            <documentation value="GSID"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <type value="string"/>
            <documentation value="GSID"/>
          </searchParam>
          <searchParam>
            <name value="name"/>
            <type value="string"/>
            <documentation value="Name of substance (contains search)"/>
          </searchParam>
          <searchParam>
            <name value="code"/>
            <type value="string"/>
            <documentation value="Code from other code system"/>
          </searchParam>
        </resource>
        <resource>
          <type value="AdministrableProductDefinition"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="string"/>
            <documentation value="PhPID"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <type value="string"/>
            <documentation value="PhPID"/>
          </searchParam>
          <searchParam>
            <name value="form-of"/>
            <type value="string"/>
            <documentation value="Find PhPIDs for an internal product ID in the"/>
          </searchParam>
          <searchParam>
            <name value="form-of:identifier"/>
            <type value="string"/>
            <documentation value="Find PhPIds for a MPID"/>
          </searchParam>
          <searchParam>
            <name value="dose-form"/>
            <type value="string"/>
            <documentation value="Find PhPIDs with a specific dose-form"/>
          </searchParam>
          <searchParam>
            <name value="parent-php"/>
            <definition
                        value="http://who-umc.org/idmp/SearchParameter/parent-php"/>
            <type value="reference"/>
            <documentation value="Search PhPIDs based on 'parent' PhPIDs"/>
          </searchParam>
        </resource>
        <resource>
          <type value="MedicinalProductDefinition"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="string"/>
            <documentation value="WHODrug record Id"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <type value="string"/>
            <documentation value="MPID"/>
          </searchParam>
          <searchParam>
            <name value="name"/>
            <type value="string"/>
            <documentation value="Product name (contains search)"/>
          </searchParam>
          <searchParam>
            <name value="name-jurisdiction"/>
            <type value="string"/>
            <documentation
                           value="Jurisdiction according to urn:iso:std:iso:3166"/>
          </searchParam>
          <searchParam>
            <name value="name-country"/>
            <type value="string"/>
            <documentation value="Country according to urn:iso:std:iso:3166"/>
          </searchParam>
          <searchParam>
            <name value="product-classification"/>
            <type value="token"/>
            <documentation value="Used to search for products given a PhPID"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Ingredient"/>
          <documentation
                         value="Only available within the scope of an AdministrableProductDefinition"/>
          <searchParam>
            <name value="substance-code"/>
            <type value="string"/>
            <documentation value="Find by substance (GSID) code"/>
          </searchParam>
          <searchParam>
            <name value="strength-presentation-quantity"/>
            <type value="token"/>
            <documentation
                           value="Search parameter on the format '5.4|http://unitsofmeasure.org|mg'"/>
          </searchParam>
        </resource>
        <resource>
          <type value="CapabilityStatement"/>
          <interaction>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="SubscriptionTopic"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="string"/>
            <documentation value="Id of the SubscriptionTopic"/>
          </searchParam>
          <searchParam>
            <name value="name"/>
            <type value="string"/>
            <documentation
                           value="Name of the SubscriptionTopic (contains search)"/>
          </searchParam>
          <searchParam>
            <name value="url"/>
            <type value="string"/>
            <documentation value="Url of the SubscriptionTopic"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Subscription"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="string"/>
            <documentation value="Id of the Subscription"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <type value="string"/>
          </searchParam>
          <searchParam>
            <name value="name"/>
            <type value="string"/>
            <documentation value="Name of the Subscription (contains search)"/>
          </searchParam>
          <searchParam>
            <name value="topic"/>
            <type value="string"/>
            <documentation value="Topic (full url) of the Subscription"/>
          </searchParam>
        </resource>
        <resource>
          <type value="SubscriptionStatus"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="string"/>
            <documentation value="Id of the Subscription"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <type value="string"/>
          </searchParam>
          <searchParam>
            <name value="name"/>
            <type value="string"/>
            <documentation value="Name of the Subscription (contains search)"/>
          </searchParam>
          <searchParam>
            <name value="topic"/>
            <type value="string"/>
            <documentation value="Topic (full url) of the Subscription"/>
          </searchParam>
        </resource>
        <resource>
          <type value="ImplementationGuide"/>
          <interaction>
            <code value="read"/>
          </interaction>
        </resource>
      </rest>
    </CapabilityStatement>