UMC IDMP Request and Publish API
1.0.0 - CI Build
UMC IDMP Request and Publish API
1.0.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 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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| API to allow for Requests and Publishing of PhPIDs and GSIDs |
The UMC API supports management and publishing of PhPIDs and GSIDs as part of the ISO IDMP standard |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| AdministrableProductDefinition (publish) |
This profile defines how the AdministrableProductDefinition is published by UMC terminologies |
| Ingredient (PhPID publish) |
This profile defines how the Ingredient is used for PhPID publish (as contained resource in an AdministrableProductDefinition) by UMC terminologies |
| Ingredient (request) |
This profile defines how the Ingredient is used for request (as contained resource in a MedicinalProductDefinition) by UMC terminologies |
| MedicinalProductDefinition (publish) |
This profile defines how the MedicinalProductDefinition representing the record in WHODrug, UMC's drug dictionary, is published by UMC terminologies |
| MedicinalProductDefinition (request) |
This profile defines how the MedicinalProductDefinition is used in request (as contained resource in a Task) by UMC terminologies |
| Regulated Authorization (PhPID request) |
Regulated Authorization is a resource covering the authorization of a type of regulated product, treatment, facility or activity |
| SubstanceDefinition (publish) |
This profile defines how the SubstanceDefinition is published by UMC terminologies |
| Task (PhPID publish) |
This profile defines how the Task resource is used for PhPID publish of a previously sent request |
| Task (PhPID request) |
This profile defines how to use the Task resource for PhPID request when requesting the generation of a PhPID by UMC terminologies |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Parent PhPID |
This extension defines the parent AdministrableProductDefinition, representing the connected PhPID level(s), for an AdministrableProductDefinition |
| Pharmaceutical dose form - AdministrationMethod |
This extension defines the AdministrationMethod for an AdministrableProductDefinition |
| Pharmaceutical dose form - BasicDoseForm |
This extension defines the BasicDoseForm for an AdministrableProductDefinition |
| Pharmaceutical dose form - IntendedSite |
This extension defines the IntendedSite for an AdministrableProductDefinition |
| Pharmaceutical dose form - ReleaseCharacteristics |
This extension defines the ReleaseCharacteristics for an AdministrableProductDefinition |
These define sets of codes used by systems conforming to this implementation guide.
| EDQM PDF dose form attributes: Administration Method |
EDQM Pharmaceutical dose form attributes: Administration Method |
| EDQM PDF dose form attributes: Basic Dose Form |
EDQM Pharmaceutical dose form attributes: Basic Dose Form |
| EDQM PDF dose form attributes: Intended Site |
EDQM Pharmaceutical dose form attributes: Intended Site |
| EDQM PDF dose form attributes: Release Characteristics |
EDQM Pharmaceutical dose form attributes: Release Characteristics |
| EDQM Pharmaceutical Form |
EDQM Pharmaceutical Forms |
| Jurisdiction Value Set |
Jurisdiction Value Set |
| PhPID Level Value Set |
PhPID Level Value Set |
| PhPID request input type value set |
PhPID request input type value set |
| PhPID request output type value set |
PhPID request output type value set |
| Request Status Value Set |
Request Status Value Set |
| Strength Unit Value Set |
Strength Unit Value Set |
| Substance Name Authority Value Set |
Substance Name Authority Value Set |
| Task Request Code Value Set |
Task Request Code Value Set |
These define new code systems used by systems conforming to this implementation guide.
| Additional jurisdictional areas complementing the ISO 3166 country codes |
Additional jurisdictional areas complementing the ISO 3166 country codes. |
| Additional substance name authorities |
Additional substance name authorities. |
| PhPId level |
This system lists PhPID types: level and stratum |
| Strength units applicable in the IDMP PhPID service |
This code system lists applicable strength units in the IDMP PhPID service. They are a sub set of the unum units with some additions. |
| Task input type |
This system lists the available input types for a task |
| Task output type |
This system lists the available output types for a task |
| Task request code |
This code system lists Task request codes in the IDMP PhPID service. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| AdministrableProductDefinition level 1 |
AdministrableProductDefinition on level 1. Linked from a level 4, 3 and 2 APD. |
| AdministrableProductDefinition level 2 |
AdministrableProductDefinition on level 2. Linked from a level 4 APD. |
| AdministrableProductDefinition level 3 |
AdministrableProductDefinition on level 3. Linked from a level 4 APD. |
| AdministrableProductDefinition level 4 |
AdministrableProductDefinition returned by the server on level 4. |
| MedicinalProductDefinition (Micardis) |
Example of a WHODrug product published as a MedicinalProductDefinition. |
| MedicinalProductDefinition (Perfalgan) |
Example of a WHODrug product published as a MedicinalProductDefinition. |
| Substance (METHOTREXATE DISODIUM) |
An example of a GSID (salt variant) publisehed as a SubstanceDefinition |
| Substance (METHOTREXATE) |
An example of a GSID publisehed as a SubstanceDefinition |
| Task Completed with PhPID |
An example of a completed task with output values that include PhPID and UMC Product ID. |
| Task Request for a new PhPID |
A template for how a Task that is used to request a new PhPID (AdministrableProductDefinition) can be structured. |