WHO-UMC IDMP Management and Publish API
0.1.0 - CI Build
WHO-UMC IDMP Management and Publish API
0.1.0 - CI Build
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
| Draft as of 2024-09-09 |
{
"resourceType" : "CapabilityStatement",
"id" : "WHO-UMC-IDMP-service",
"text" : {
"status" : "extensions",
"div" : "<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><a name=\"WHO-UMC-IDMP-service-en-US\"> </a><h2 id=\"title\">API to allow for Requests and Publishing of PhPIDs and GSIDs</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>Supported Patch Formats: </li><li>Published on: 2024-09-09 </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 class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></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>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><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>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier, name, code</td><td/><td/><td/></tr><tr><td><a href=\"#AdministrableProductDefinition1-3\">AdministrableProductDefinition</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><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>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><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>\u00a0</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>substance-code, strength-presentation-quantity</td><td/><td/><td/></tr><tr><td><a href=\"#Organization1-6\">Organization</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier, name</td><td/><td/><td/></tr><tr><td><a href=\"#CapabilityStatement1-7\">CapabilityStatement</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#SubscriptionTopic1-8\">SubscriptionTopic</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, name, url</td><td/><td/><td/></tr><tr><td><a href=\"#Subscription1-9\">Subscription</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><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-10\">SubscriptionStatus</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier, name, topic</td><td/><td/><td/></tr><tr><td><a href=\"#ImplementationGuide1-11\">ImplementationGuide</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div><p>GSID</p>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div><p>PhPID</p>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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 product Id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>string</code></td><td><div><p>MPID</p>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Organization</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/organization.html\">Organization</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/></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 organization (contains search)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CapabilityStatement1-7\" 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-8\" 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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Subscription1-9\" 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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"SubscriptionStatus1-10\" 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>\n</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ImplementationGuide1-11\" 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>"
},
"url" : "http://who-umc.org/idmp/CapabilityStatement/WHO-UMC-IDMP-service",
"version" : "0.1.0",
"name" : "WHO-UMC IDMP Management and Publish API",
"title" : "API to allow for Requests and Publishing of PhPIDs and GSIDs",
"status" : "draft",
"date" : "2024-09-09",
"publisher" : "Uppsala Monitoring Centre",
"contact" : [
{
"name" : "Uppsala Monitoring Centre",
"telecom" : [
{
"system" : "url",
"value" : "http://www.who-umc.org"
}
]
},
{
"name" : "Uppsala Monitoring Centre",
"telecom" : [
{
"system" : "url",
"value" : "http://www.who-umc.org"
}
]
}
],
"description" : "The WHO-UMC API supports management and publishing of OhPIDs and GSIDs as part of the ISO IDMP standard",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "capability",
"software" : {
"name" : "WHO-UMC IDMP Management and Publish API",
"version" : "0.5.0"
},
"fhirVersion" : "5.0.0",
"format" : [
"xml",
"json"
],
"implementationGuide" : [
"https://build.fhir.org/ig/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Task",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "delete"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "string",
"documentation" : "Task identifier from requester in format 'sendingSystem|localId'"
},
{
"name" : "status",
"type" : "string",
"documentation" : "Search Task by status"
}
]
},
{
"type" : "SubstanceDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "GSID"
},
{
"name" : "identifier",
"type" : "string",
"documentation" : "GSID"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Name of substance (contains search)"
},
{
"name" : "code",
"type" : "string",
"documentation" : "Code from other code system"
}
]
},
{
"type" : "AdministrableProductDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "PhPID"
},
{
"name" : "identifier",
"type" : "string",
"documentation" : "PhPID"
},
{
"name" : "form-of",
"type" : "string",
"documentation" : "Find PhPIDs for an internal product ID in the"
},
{
"name" : "form-of:identifier",
"type" : "string",
"documentation" : "Find PhPIds for a MPID"
},
{
"name" : "dose-form",
"type" : "string",
"documentation" : "Find PhPIDs with a specific dose-form"
},
{
"name" : "parent-php",
"definition" : "http://who-umc.org/idmp/SearchParameter/parent-php",
"type" : "reference",
"documentation" : "Search PhPIDs based on 'parent' PhPIDs"
}
]
},
{
"type" : "MedicinalProductDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "WHODrug product Id"
},
{
"name" : "identifier",
"type" : "string",
"documentation" : "MPID"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Product name (contains search)"
},
{
"name" : "name-jurisdiction",
"type" : "string",
"documentation" : "Jurisdiction according to urn:iso:std:iso:3166"
},
{
"name" : "name-country",
"type" : "string",
"documentation" : "Country according to urn:iso:std:iso:3166"
},
{
"name" : "product-classification",
"type" : "token",
"documentation" : "Used to search for products given a PhPID"
}
]
},
{
"type" : "Ingredient",
"documentation" : "Only available within the scope of an AdministrableProductDefinition",
"searchParam" : [
{
"name" : "substance-code",
"type" : "string",
"documentation" : "Find by substance (GSID) code"
},
{
"name" : "strength-presentation-quantity",
"type" : "token",
"documentation" : "Search parameter on the format '5.4|http://unitsofmeasure.org|mg'"
}
]
},
{
"type" : "Organization",
"interaction" : [
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string"
},
{
"name" : "identifier",
"type" : "string"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Name of organization (contains search)"
}
]
},
{
"type" : "CapabilityStatement",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "SubscriptionTopic",
"interaction" : [
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "Id of the SubscriptionTopic"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Name of the SubscriptionTopic (contains search)"
},
{
"name" : "url",
"type" : "string",
"documentation" : "Url of the SubscriptionTopic"
}
]
},
{
"type" : "Subscription",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "delete"
},
{
"code" : "update"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "Id of the Subscription"
},
{
"name" : "identifier",
"type" : "string"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Name of the Subscription (contains search)"
},
{
"name" : "topic",
"type" : "string",
"documentation" : "Topic (full url) of the Subscription"
}
]
},
{
"type" : "SubscriptionStatus",
"interaction" : [
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "Id of the Subscription"
},
{
"name" : "identifier",
"type" : "string"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Name of the Subscription (contains search)"
},
{
"name" : "topic",
"type" : "string",
"documentation" : "Topic (full url) of the Subscription"
}
]
},
{
"type" : "ImplementationGuide",
"interaction" : [
{
"code" : "read"
}
]
}
]
}
]
}
IG © 2024+ Uppsala Monitoring Centre. Package idmp.who-umc.org.fhir#0.1.0 based on FHIR 5.0.0. Generated 2024-09-16
