WHO-UMC IDMP Management and Publish API
0.1.0 - CI Build International flag

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

: Example of a completed Task - JSON Representation

Raw json | Download

{
  "resourceType" : "Task",
  "id" : "task-completed-phpid",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2019-04-28T06:07:05.5388025+00:00",
    "source" : "http://idmp.who-umc.org/fhir",
    "profile" : [
      🔗 "http://who-umc.org/idmp/StructureDefinition/Task-who-php-phpid-status"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Task task-completed-phpid</b></p><a name=\"task-completed-phpid\"> </a><a name=\"hctask-completed-phpid\"> </a><a name=\"task-completed-phpid-en-US\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">version: 1; Last updated: 2019-04-28 06:07:05+0000; </p><p style=\"margin-bottom: 0px\">Information Source: <a href=\"http://idmp.who-umc.org/fhir\">http://idmp.who-umc.org/fhir</a></p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-Task-who-php-phpid-status.html\">Task PhPID request status</a></p></div><p><b>identifier</b>: <code>http://requester.org/phpidreqid</code>/123456</p><p><b>status</b>: Completed</p><p><b>intent</b>: proposal</p><p><b>priority</b>: Routine</p><p><b>authoredOn</b>: 2024-05-30</p><p><b>lastModified</b>: 2024-05-30</p><blockquote><p><b>input</b></p><p><b>type</b>: <span title=\"Codes:{http://who-umc.org/idmp/CodeSystem/task-input-type mpd-request-resource}\">Medicinal Product for PhPID request</span></p><p><b>value</b>: <a href=\"#hctask-completed-phpid/702011b3-e5f3-4d21-beb3-29e1cbc8fbc4\">MedicinalProductDefinition: identifier = http://ema.europa.eu/example/mpid#MPID-123; type = Medicinal Product; domain = Human use; status = Active; combinedPharmaceuticalDoseForm = </a></p></blockquote><blockquote><p><b>input</b></p><p><b>type</b>: <span title=\"Codes:{http://who-umc.org/idmp/CodeSystem/task-input-type ingredient-request-resource}\">Ingredient for PhPID request</span></p><p><b>value</b>: <a href=\"#hctask-completed-phpid/9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce\">Ingredient: status = active; role = Active</a></p></blockquote><blockquote><p><b>input</b></p><p><b>type</b>: <span title=\"Codes:{http://who-umc.org/idmp/CodeSystem/task-input-type organization-request-resource}\">Marketing Auth Holder for PhPID request</span></p><p><b>value</b>: <a href=\"#hctask-completed-phpid/acmeinc\">Organization Acme Inc</a></p></blockquote><blockquote><p><b>output</b></p><p><b>type</b>: <span title=\"Codes:{http://who-umc.org/idmp/CodeSystem/task-output-type phpid}\">PhPID</span></p><p><b>value</b>: <a href=\"AdministrableProductDefinition/10DD499443FAE493691301348AFDDDF3\">AdministrableProductDefinition/10DD499443FAE493691301348AFDDDF3</a></p></blockquote><blockquote><p><b>output</b></p><p><b>type</b>: <span title=\"Codes:{http://who-umc.org/idmp/CodeSystem/task-output-type whodrugid}\">Medicinal Product (WHODrug) ID</span></p><p><b>value</b>: Identifier: <code>http://who-umc.org/idmp/whodrugid</code>/XXXXXX</p></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: MedicinalProductDefinition  #702011b3-e5f3-4d21-beb3-29e1cbc8fbc4</b></p><a name=\"task-completed-phpid/702011b3-e5f3-4d21-beb3-29e1cbc8fbc4\"> </a><a name=\"hctask-completed-phpid/702011b3-e5f3-4d21-beb3-29e1cbc8fbc4\"> </a><a name=\"task-completed-phpid/702011b3-e5f3-4d21-beb3-29e1cbc8fbc4-en-US\"> </a><p><b>identifier</b>: <code>http://ema.europa.eu/example/mpid</code>/MPID-123</p><p><b>type</b>: <span title=\"Codes:{http://hl7.org/fhir/medicinal-product-type MedicinalProduct}\">Medicinal Product</span></p><p><b>domain</b>: <span title=\"Codes:{http://hl7.org/fhir/medicinal-product-domain Human}\">Human use</span></p><p><b>status</b>: <span title=\"Codes:{http://hl7.org/fhir/publication-status active}\">Active</span></p><p><b>combinedPharmaceuticalDoseForm</b>: <span title=\"Codes:\">tablet</span></p><p><b>attachedDocument</b>: SPC/123</p><h3>Contacts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Contact</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://hl7.org/fhir/medicinal-product-contact-type ProposedMAH}\">Proposed Marketing Authorization Holder/Person</span></td><td><a href=\"#hctask-completed-phpid/acmeinc\">Acme Inc</a></td></tr></table><blockquote><p><b>name</b></p><p><b>productName</b>: Marvelol</p><h3>Usages</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Country</b></td><td><b>Jurisdiction</b></td><td><b>Language</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{urn:iso:std:iso:3166 NLD}\">Netherlands</span></td><td><span title=\"Codes:{http://who-umc.org/idmp/CodeSystem/jurisdiction EU}\">European Union</span></td><td><span title=\"Codes:{urn:ietf:bcp:47 nl}\">Dutch</span></td></tr></table></blockquote></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Ingredient  #9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce</b></p><a name=\"task-completed-phpid/9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce\"> </a><a name=\"hctask-completed-phpid/9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce\"> </a><a name=\"task-completed-phpid/9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce-en-US\"> </a><p><b>status</b>: Active</p><p><b>for</b>: <a href=\"#hctask-completed-phpid/702011b3-e5f3-4d21-beb3-29e1cbc8fbc4\">MedicinalProductDefinition: identifier = http://ema.europa.eu/example/mpid#MPID-123; type = Medicinal Product; domain = Human use; status = Active; combinedPharmaceuticalDoseForm = </a></p><p><b>role</b>: <span title=\"Codes:{http://hl7.org/fhir/ingredient-role 100000072072}\">Active</span></p><blockquote><p><b>substance</b></p><h3>Codes</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Concept</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://who-umc.org/idmp/gsid GSID23G92UMX93H45}\">Methotrexate</span></td></tr></table><h3>Strengths</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Presentation[x]</b></td><td><b>TextPresentation</b></td></tr><tr><td style=\"display: none\">*</td><td>1.5 mg<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM  codemg = 'mg')</span>/1 IU<span style=\"background: LightGoldenRodYellow\"> (Details: Strength units applicable in the IDMP PhPID service  codeIU = 'arbitrary international unit')</span></td><td>1,5 mg</td></tr></table></blockquote></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Organization  #acmeinc</b></p><a name=\"task-completed-phpid/acmeinc\"> </a><a name=\"hctask-completed-phpid/acmeinc\"> </a><a name=\"task-completed-phpid/acmeinc-en-US\"> </a><p><b>active</b>: true</p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/organization-type bus}\">Non-Healthcare Business or Corporation</span></p><p><b>name</b>: Acme Inc</p></blockquote></div>"
  },
  "contained" : [
    {
      "resourceType" : "MedicinalProductDefinition",
      "id" : "702011b3-e5f3-4d21-beb3-29e1cbc8fbc4",
      "meta" : {
        "profile" : [
          🔗 "http://who-umc.org/idmp/StructureDefinition/MedicinalProductDefinition-who-php-req"
        ]
      },
      "identifier" : [
        {
          "system" : "http://ema.europa.eu/example/mpid",
          "value" : "MPID-123"
        }
      ],
      "type" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/medicinal-product-type",
            "code" : "MedicinalProduct"
          }
        ]
      },
      "domain" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/medicinal-product-domain",
            "code" : "Human"
          }
        ],
        "text" : "Human use"
      },
      "status" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/publication-status",
            "code" : "active"
          }
        ],
        "text" : "Active"
      },
      "combinedPharmaceuticalDoseForm" : {
        "text" : "tablet"
      },
      "attachedDocument" : [
        {
          "display" : "SPC/123"
        }
      ],
      "contact" : [
        {
          "type" : {
            "coding" : [
              {
                "system" : "http://hl7.org/fhir/medicinal-product-contact-type",
                "code" : "ProposedMAH"
              }
            ]
          },
          "contact" : {
            "reference" : "#acmeinc",
            "type" : "Organization",
            "display" : "Acme Inc"
          }
        }
      ],
      "name" : [
        {
          "productName" : "Marvelol",
          "usage" : [
            {
              "country" : {
                "coding" : [
                  {
                    "system" : "urn:iso:std:iso:3166",
                    "code" : "NLD"
                  }
                ]
              },
              "jurisdiction" : {
                "coding" : [
                  {
                    "system" : "http://who-umc.org/idmp/CodeSystem/jurisdiction",
                    "code" : "EU"
                  }
                ]
              },
              "language" : {
                "coding" : [
                  {
                    "system" : "urn:ietf:bcp:47",
                    "code" : "nl"
                  }
                ]
              }
            }
          ]
        }
      ]
    },
    {
      "resourceType" : "Ingredient",
      "id" : "9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce",
      "meta" : {
        "profile" : [
          🔗 "http://who-umc.org/idmp/StructureDefinition/Ingredient-who-php"
        ]
      },
      "status" : "active",
      "for" : [
        {
          "reference" : "#702011b3-e5f3-4d21-beb3-29e1cbc8fbc4"
        }
      ],
      "role" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/ingredient-role",
            "code" : "100000072072"
          }
        ],
        "text" : "Active"
      },
      "substance" : {
        "code" : {
          "concept" : {
            "coding" : [
              {
                "system" : "http://who-umc.org/idmp/gsid",
                "code" : "GSID23G92UMX93H45"
              }
            ],
            "text" : "Methotrexate"
          }
        },
        "strength" : [
          {
            "presentationRatio" : {
              "numerator" : {
                "value" : 1.5,
                "unit" : "mg",
                "system" : "http://unitsofmeasure.org",
                "code" : "mg"
              },
              "denominator" : {
                "value" : 1,
                "unit" : "IU",
                "system" : "http://who-umc.org/idmp/CodeSystem/strengthUnit",
                "code" : "IU"
              }
            },
            "textPresentation" : "1,5 mg"
          }
        ]
      }
    },
    {
      "resourceType" : "Organization",
      "id" : "acmeinc",
      "meta" : {
        "profile" : [
          🔗 "http://who-umc.org/idmp/StructureDefinition/MarketingAuthorizationHolder-who-php"
        ]
      },
      "active" : true,
      "type" : [
        {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
              "code" : "bus"
            }
          ],
          "text" : "Non-Healthcare Business or Corporation"
        }
      ],
      "name" : "Acme Inc"
    }
  ],
  "identifier" : [
    {
      "system" : "http://requester.org/phpidreqid",
      "value" : "123456"
    }
  ],
  "status" : "completed",
  "intent" : "proposal",
  "priority" : "routine",
  "authoredOn" : "2024-05-30",
  "lastModified" : "2024-05-30",
  "input" : [
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://who-umc.org/idmp/CodeSystem/task-input-type",
            "code" : "mpd-request-resource",
            "display" : "Medicinal Product for PhPID request"
          }
        ]
      },
      "valueReference" : {
        "reference" : "#702011b3-e5f3-4d21-beb3-29e1cbc8fbc4"
      }
    },
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://who-umc.org/idmp/CodeSystem/task-input-type",
            "code" : "ingredient-request-resource",
            "display" : "Ingredient for PhPID request"
          }
        ]
      },
      "valueReference" : {
        "reference" : "#9e51e8d8-af3b-46fd-ab84-e6f0188fb5ce"
      }
    },
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://who-umc.org/idmp/CodeSystem/task-input-type",
            "code" : "organization-request-resource",
            "display" : "Marketing Auth Holder for PhPID request"
          }
        ]
      },
      "valueReference" : {
        "reference" : "#acmeinc"
      }
    }
  ],
  "output" : [
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://who-umc.org/idmp/CodeSystem/task-output-type",
            "code" : "phpid",
            "display" : "PhPID"
          }
        ]
      },
      "valueReference" : {
        "reference" : "AdministrableProductDefinition/10DD499443FAE493691301348AFDDDF3",
        "identifier" : {
          "type" : {
            "coding" : [
              {
                "system" : "http://who-umc.org/idmp/CodeSystem/php-level",
                "code" : "PhPIDLevel4",
                "display" : "Level 4 - Substance, strength and form specified"
              }
            ]
          },
          "system" : "http://who-umc.org/idmp/phpid",
          "value" : "10DD499443FAE493691301348AFDDDF3"
        }
      }
    },
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://who-umc.org/idmp/CodeSystem/task-output-type",
            "code" : "whodrugid",
            "display" : "Medicinal Product (WHODrug) ID"
          }
        ]
      },
      "valueReference" : {
        "identifier" : {
          "system" : "http://who-umc.org/idmp/whodrugid",
          "value" : "XXXXXX"
        }
      }
    }
  ]
}