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

## : Example of a completed Task - XML Representation

Raw xml | Download

    <Task xmlns="http://hl7.org/fhir">
      <id value="task-completed-phpid"/>
      <meta>
        <versionId value="1"/>
        <lastUpdated value="2021-03-21T08:24:09.8508147+00:00"/>
        <source value="https://poc-idmp.who-umc.org/fhir"/>
        <profile
                 value="http://who-umc.org/idmp/StructureDefinition/Task-who-php-phpid-status"/>
      </meta>
      <text>
        <status value="empty"/>
        <div xmlns="http://www.w3.org/1999/xhtml">Template for PhPID request Task</div>
      </text>
      <contained>
        <MedicinalProductDefinition>
          <id value="3e8d3895-d37c-41da-8372-face4978b4d5"/>
          <meta>
            <source value="https://poc-idmp.who-umc.org/fhir"/>
            <profile
                     value="http://who-umc.org/idmp/StructureDefinition/MedicinalProductDefinition-who-php-req"/>
          </meta>
          <identifier>
            <system value="http://ema.europa.eu/example/mpid"/>
            <value value="MPID-123"/>
          </identifier>
          <type>
            <coding>
              <system value="http://hl7.org/fhir/medicinal-product-type"/>
              <code value="MedicinalProduct"/>
            </coding>
          </type>
          <domain>
            <coding>
              <system value="http://hl7.org/fhir/medicinal-product-domain"/>
              <code value="Human"/>
            </coding>
            <text value="Human use"/>
          </domain>
          <status>
            <coding>
              <system value="http://hl7.org/fhir/publication-status"/>
              <code value="active"/>
            </coding>
            <text value="Active"/>
          </status>
          <combinedPharmaceuticalDoseForm>
            <text value="tablet"/>
          </combinedPharmaceuticalDoseForm>
          <attachedDocument>
            <display value="SPC/123"/>
          </attachedDocument>
          <name>
            <productName value="Marvelol"/>
            <usage>
              <country>
                <coding>
                  <system value="urn:iso:std:iso:3166"/>
                  <code value="NLD"/>
                </coding>
              </country>
              <jurisdiction>
                <coding>
                  <system
                          value="http://who-umc.org/idmp/CodeSystem/jurisdiction"/>
                  <code value="EU"/>
                </coding>
              </jurisdiction>
              <language>
                <coding>
                  <system value="urn:ietf:bcp:47"/>
                  <code value="nl"/>
                </coding>
              </language>
            </usage>
          </name>
        </MedicinalProductDefinition>
      </contained>
      <contained>
        <Ingredient>
          <id value="cd7f7d98-75eb-4a6f-9252-dc57c0ee9e34"/>
          <meta>
            <source value="https://poc-idmp.who-umc.org/fhir"/>
            <profile
                     value="http://who-umc.org/idmp/StructureDefinition/Ingredient-who-php"/>
          </meta>
          <status value="active"/>
          <for>
            <reference value="#3e8d3895-d37c-41da-8372-face4978b4d5"/>
          </for>
          <role>
            <coding>
              <system value="http://hl7.org/fhir/ingredient-role"/>
              <code value="100000072072"/>
            </coding>
            <text value="Active"/>
          </role>
          <substance>
            <code>
              <concept>
                <coding>
                  <system value="http://who-umc.org/idmp/gsid"/>
                  <code value="GSID23G92UMX93H45"/>
                </coding>
                <text value="Methotrexate"/>
              </concept>
            </code>
            <strength>
              <presentationRatio>
                <numerator>
                  <value value="1.5"/>
                  <unit value="mg"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="mg"/>
                </numerator>
                <denominator>
                  <value value="1"/>
                  <unit value="IU"/>
                  <system
                          value="http://who-umc.org/idmp/CodeSystem/strengthUnit"/>
                  <code value="IU"/>
                </denominator>
              </presentationRatio>
              <textPresentation value="1,5 mg"/>
            </strength>
          </substance>
        </Ingredient>
      </contained>
      <contained>
        <Organization>
          <id value="acmeinc"/>
          <meta>
            <source value="https://poc-idmp.who-umc.org/fhir"/>
            <profile
                     value="http://who-umc.org/idmp/StructureDefinition/MarketingAuthorizationHolder-who-php"/>
          </meta>
          <active value="true"/>
          <type>
            <coding>
              <system
                      value="http://terminology.hl7.org/CodeSystem/organization-type"/>
              <code value="bus"/>
            </coding>
            <text value="Non-Healthcare Business or Corporation"/>
          </type>
          <name value="Acme Inc"/>
        </Organization>
      </contained>
      <contained>
        <RegulatedAuthorization>
          <id value="066bb2b6-5b34-4ea8-9c73-6d95d402672d"/>
          <identifier>
            <system value="http://ema.europa.eu/ema/"/>
            <value value="EU/1/20/XXXX"/>
          </identifier>
          <subject>
            <reference value="#3e8d3895-d37c-41da-8372-face4978b4d5"/>
          </subject>
          <holder>
            <reference value="#acmeinc"/>
          </holder>
        </RegulatedAuthorization>
      </contained>
      <identifier>
        <system value="http://requester.org/phpidreqid"/>
        <value value="123456"/>
      </identifier>
      <status value="completed"/>
      <intent value="proposal"/>
      <priority value="routine"/>
      <code>
        <coding>
          <system value="http://who-umc.org/idmp/CodeSystem/task-request-code"/>
          <code value="phpid-request"/>
        </coding>
      </code>
      <authoredOn value="2025-06-18"/>
      <lastModified value="2025-06-18"/>
      <input>
        <type>
          <coding>
            <system value="http://who-umc.org/idmp/CodeSystem/task-input-type"/>
            <code value="mpd-request-resource"/>
            <display value="Medicinal Product for PhPID request"/>
          </coding>
        </type>
        <valueReference>
          <reference value="#3e8d3895-d37c-41da-8372-face4978b4d5"/>
        </valueReference>
      </input>
      <input>
        <type>
          <coding>
            <system value="http://who-umc.org/idmp/CodeSystem/task-input-type"/>
            <code value="ingredient-request-resource"/>
            <display value="Ingredient for PhPID request"/>
          </coding>
        </type>
        <valueReference>
          <reference value="#cd7f7d98-75eb-4a6f-9252-dc57c0ee9e34"/>
        </valueReference>
      </input>
      <input>
        <type>
          <coding>
            <system value="http://who-umc.org/idmp/CodeSystem/task-input-type"/>
            <code value="organization-request-resource"/>
            <display value="Marketing Auth Holder for PhPID request"/>
          </coding>
        </type>
        <valueReference>
          <reference value="#acmeinc"/>
        </valueReference>
      </input>
      <input>
        <type>
          <coding>
            <system value="http://who-umc.org/idmp/CodeSystem/task-input-type"/>
            <code value="regauth-request-resource"/>
            <display value="Regulated Authorization for PhPID request"/>
          </coding>
        </type>
        <valueReference>
          <reference value="#066bb2b6-5b34-4ea8-9c73-6d95d402672d"/>
        </valueReference>
      </input>
      <output>
        <type>
          <coding>
            <system value="http://who-umc.org/idmp/CodeSystem/task-output-type"/>
            <code value="phpid"/>
            <display value="PhPID"/>
          </coding>
        </type>
        <valueReference>🔗
          <reference
                     value="AdministrableProductDefinition/91B3CA582581F57E4092F13AAF476215"/>
          <identifier>
            <type>
              <coding>
                <system value="http://who-umc.org/idmp/CodeSystem/php-level"/>
                <code value="PhPIDLevel4"/>
                <display value="Level 4"/>
              </coding>
            </type>
            <system value="http://who-umc.org/idmp/phpid"/>
            <value value="91B3CA582581F57E4092F13AAF476215"/>
          </identifier>
        </valueReference>
      </output>
      <output>
        <type>
          <coding>
            <system value="http://who-umc.org/idmp/CodeSystem/task-output-type"/>
            <code value="whodrugid"/>
            <display value="Medicinal Product (WHODrug) ID"/>
          </coding>
        </type>
        <valueReference>
          <identifier>
            <system value="http://who-umc.org/idmp/whodrugid"/>
            <value value="XXXXXX"/>
          </identifier>
        </valueReference>
      </output>
    </Task>