UMC IDMP Request and Publish API
1.0.0 - CI Build International flag

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

Resource Profile: MedicinalProductDefinition (publish)

Official URL: http://umcterminologies.org/StructureDefinition/MedicinalProductDefinition-pub Version: 1.0.0
Active as of 2026-11-03 Computable Name: MedicinalProductDefinitionPub

This profile defines how the MedicinalProductDefinition representing the record in WHODrug, UMC's drug dictionary, is published by UMC terminologies

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicinalProductDefinition 0..* MedicinalProductDefinition Detailed definition of a medicinal product
MedicinalProductDefinition.id This element is included in summaries. 1..1 id Logical id of this artifact
MedicinalProductDefinition.text 0..1 Narrative Not used in this profile
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MedicinalProductDefinition.Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization 0..* RegulatedAuthorization Contained Regulated Authorization carrying the country-specific Market Authorization Number.
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier This element is included in summaries. C 1..1 Identifier Business identifier for the authorization, typically assigned by the authorizing body
Constraints: market-auth-number-system-pattern
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.system This element is included in summaries. 1..1 uri Country-specific Market Authorization Number system, e.g. http://umcterminologies.org/market-authorization-number-<2-letter ISO 3166 country code>.
Example General: http://www.acme.com/identifiers/patient
Example Market Authorization Number: http://umcterminologies.org/market-authorization-number-se
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.value This element is included in summaries. C 1..1 string Market Authorization Number value. To be sourced from a database in the future; no data is available yet.
Example General: 123456
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject This element is included in summaries. 1..1 Reference(MedicinalProductDefinition) The product type, treatment, facility or activity that is being authorized
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Required Pattern: # (extensions allowed)
MedicinalProductDefinition.Slices for identifier This element is included in summaries. C 1..* Identifier UMC product id plus zero-to-many Local MPIDs, system http://umcterminologies.org/mpid-<ISO 3166-1 alpha-2> (repeatable).
Slice: Unordered, Open by value:system
Constraints: identifier-system-allowed

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicinalProductDefinition.Slices for identifier.identifier:All Slices Content/Rules for all slices
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example Local MPID: http://umcterminologies.org/mpid-se
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId This element is included in summaries. 1..1 Identifier The UMC product id (exactly one).
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/umc-product-id (extensions allowed)
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
MedicinalProductDefinition.type This element is included in summaries. 0..1 CodeableConcept Regulatory type, e.g. Investigational or Authorized.
Binding: MedicinalProductType (example): Overall defining type of this medicinal product.
MedicinalProductDefinition.domain This element is included in summaries. 0..1 CodeableConcept If this medicine applies to human or veterinary uses.
Binding: MedicinalProductDomain (required)
MedicinalProductDefinition.status This element is a modifier element. This element is included in summaries. 0..1 CodeableConcept The status within the lifecycle of this product record.
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
MedicinalProductDefinition.combinedPharmaceuticalDoseForm This element is included in summaries. 0..1 CodeableConcept The dose form for a single part product, or combined form of a multiple part product
Binding: EDQM Pharmaceutical Form (example)
MedicinalProductDefinition.classification This element is included in summaries. 0..* CodeableConcept ​Allows the product to be classified by various systems (e.g. PhPID Level 4).
Binding: http://umcterminologies.org/phpid-level4 (example)
MedicinalProductDefinition.classification.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name This element is included in summaries. 1..* BackboneElement The product's name, including full name and possibly coded parts
MedicinalProductDefinition.name.productName This element is included in summaries. 1..1 string The full product name.
MedicinalProductDefinition.name.type This element is included in summaries. 0..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary.
Binding: ProductNameType (example): Type of a name for a Medicinal Product.
MedicinalProductDefinition.name.usage This element is included in summaries. 0..* BackboneElement Where and in which language this name applies (used for the local name)
MedicinalProductDefinition.name.usage.country This element is included in summaries. C 1..1 CodeableConcept Country where this name applies
Binding: Jurisdiction Value Set (required)
Constraints: country-system-allowed
MedicinalProductDefinition.name.usage.country.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.country.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
MedicinalProductDefinition.name.usage.country.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
MedicinalProductDefinition.name.usage.language This element is included in summaries. 1..1 CodeableConcept Language for this name
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
MedicinalProductDefinition.name.usage.language.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.language.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: urn:ietf:bcp:47 (extensions allowed)
MedicinalProductDefinition.name.usage.language.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicinalProductDefinition.​type Base example Medicinal Product Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​domain Base required Medicinal Product Domain 📦5.0.0 FHIR Std.
MedicinalProductDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​combinedPharmaceuticalDoseForm Base example EDQM Pharmaceutical Form 📦1.0.0 This IG
MedicinalProductDefinition.​classification Base example ​ http://umcterminologies.org/phpid-level4 Not State Unknown
MedicinalProductDefinition.​name.type Base example Product Name Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.usage.country Base required Jurisdiction Value Set 📦1.0.0 This IG
MedicinalProductDefinition.​name.usage.language Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
country-system-allowed error MedicinalProductDefinition.name.usage.country Country must be coded with ISO 3166 (urn:iso:std:iso:3166) or the UMC jurisdiction code system (http://umcterminologies.org/CodeSystem/jurisdiction, e.g. EU) coding.all(system = 'urn:iso:std:iso:3166' or system = 'http://umcterminologies.org/CodeSystem/jurisdiction')
identifier-system-allowed error MedicinalProductDefinition.identifier Identifier system must be the UMC product id system or match http://umcterminologies.org/mpid-<2-letter country code> system = 'http://umcterminologies.org/umc-product-id' or system.matches('^http://umcterminologies[.]org/mpid-[a-zA-Z]{2}$')
market-auth-number-system-pattern error MedicinalProductDefinition.contained:regulatedAuthorization.identifier Market Authorization Number identifier system must match the pattern http://umcterminologies.org/market-authorization-number-<2-letter country code> system.matches('^http://umcterminologies[.]org/market-authorization-number-[a-zA-Z]{2}$')

This structure is derived from MedicinalProductDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicinalProductDefinition 0..* MedicinalProductDefinition Detailed definition of a medicinal product
MedicinalProductDefinition.id 1..1 id Logical id of this artifact
MedicinalProductDefinition.meta
MedicinalProductDefinition.meta.source 1..1 uri Identifies where the resource comes from
MedicinalProductDefinition.implicitRules 0..0 A set of rules under which this content was created
MedicinalProductDefinition.Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization 0..* RegulatedAuthorization Contained Regulated Authorization carrying the country-specific Market Authorization Number.
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.implicitRules 0..0 A set of rules under which this content was created
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.contained 0..0 Contained, inline Resources
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.modifierExtension 0..0 Extension
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier C 1..1 Identifier Business identifier for the authorization, typically assigned by the authorizing body
Constraints: market-auth-number-system-pattern
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.use 0..0 usual | official | temp | secondary | old (If known)
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.system 1..1 uri Country-specific Market Authorization Number system, e.g. http://umcterminologies.org/market-authorization-number-<2-letter ISO 3166 country code>.
Example Market Authorization Number: http://umcterminologies.org/market-authorization-number-se
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.value 1..1 string Market Authorization Number value. To be sourced from a database in the future; no data is available yet.
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject 1..1 Reference(MedicinalProductDefinition) The product type, treatment, facility or activity that is being authorized
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject.reference 1..1 string Literal reference, Relative, internal or absolute URL
Required Pattern: # (extensions allowed)
MedicinalProductDefinition.modifierExtension 0..0 Extension
MedicinalProductDefinition.Slices for identifier C 1..* Identifier UMC product id plus zero-to-many Local MPIDs, system http://umcterminologies.org/mpid-<ISO 3166-1 alpha-2> (repeatable).
Slice: Unordered, Open by value:system
Constraints: identifier-system-allowed
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicinalProductDefinition.Slices for identifier.identifier:All Slices Content/Rules for all slices
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.use 0..0 usual | official | temp | secondary | old (If known)
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.system 1..1 uri The namespace for the identifier value
Example Local MPID: http://umcterminologies.org/mpid-se
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.value 1..1 string The value that is unique
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId 1..1 Identifier The UMC product id (exactly one).
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.use 0..0 usual | official | temp | secondary | old (If known)
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.system 1..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/umc-product-id (extensions allowed)
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.value 1..1 string The value that is unique
MedicinalProductDefinition.type 0..1 CodeableConcept Regulatory type, e.g. Investigational or Authorized.
MedicinalProductDefinition.domain 0..1 CodeableConcept If this medicine applies to human or veterinary uses.
Binding: MedicinalProductDomain (required)
MedicinalProductDefinition.status 0..1 CodeableConcept The status within the lifecycle of this product record.
MedicinalProductDefinition.statusDate 0..0 The date at which the given status became applicable
MedicinalProductDefinition.description 0..0 General description of this product
MedicinalProductDefinition.combinedPharmaceuticalDoseForm 0..1 CodeableConcept The dose form for a single part product, or combined form of a multiple part product
Binding: EDQM Pharmaceutical Form (example)
MedicinalProductDefinition.route 0..0 The path by which the product is taken into or makes contact with the body
MedicinalProductDefinition.indication 0..0 Description of indication(s) for this product, used when structured indications are not required
MedicinalProductDefinition.legalStatusOfSupply 0..0 The legal status of supply of the medicinal product as classified by the regulator
MedicinalProductDefinition.additionalMonitoringIndicator 0..0 Whether the Medicinal Product is subject to additional monitoring for regulatory reasons
MedicinalProductDefinition.specialMeasures 0..0 Whether the Medicinal Product is subject to special measures for regulatory reasons
MedicinalProductDefinition.pediatricUseIndicator 0..0 If authorised for use in children
MedicinalProductDefinition.classification 0..* CodeableConcept ​Allows the product to be classified by various systems (e.g. PhPID Level 4).
Binding: http://umcterminologies.org/phpid-level4 (example)
MedicinalProductDefinition.classification.coding 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.marketingStatus 0..0 Marketing status of the medicinal product, in contrast to marketing authorization
MedicinalProductDefinition.packagedMedicinalProduct 0..0 Package type for the product
MedicinalProductDefinition.contact 0..0 A product specific contact, person (in a role), or an organization
MedicinalProductDefinition.name 1..* BackboneElement The product's name, including full name and possibly coded parts
MedicinalProductDefinition.name.modifierExtension 0..0 Extension
MedicinalProductDefinition.name.productName 1..1 string The full product name.
MedicinalProductDefinition.name.type 0..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary.
MedicinalProductDefinition.name.part
MedicinalProductDefinition.name.part.part 1..1 string A fragment of a product name.
MedicinalProductDefinition.name.part.type 1..1 CodeableConcept Type for this part of the name (e.g. strength part)
MedicinalProductDefinition.name.usage 0..* BackboneElement Where and in which language this name applies (used for the local name)
MedicinalProductDefinition.name.usage.modifierExtension 0..0 Extension
MedicinalProductDefinition.name.usage.country C 1..1 CodeableConcept Country where this name applies
Binding: Jurisdiction Value Set (required)
Constraints: country-system-allowed
MedicinalProductDefinition.name.usage.country.coding 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.country.coding.system 1..1 uri Identity of the terminology system
MedicinalProductDefinition.name.usage.country.coding.code 1..1 code Symbol in syntax defined by the system
MedicinalProductDefinition.name.usage.language 1..1 CodeableConcept Language for this name
MedicinalProductDefinition.name.usage.language.coding 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.language.coding.system 1..1 uri Identity of the terminology system
Required Pattern: urn:ietf:bcp:47 (extensions allowed)
MedicinalProductDefinition.name.usage.language.coding.code 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicinalProductDefinition.​domain Base required Medicinal Product Domain 📦5.0.0 FHIR Std.
MedicinalProductDefinition.​combinedPharmaceuticalDoseForm Base example EDQM Pharmaceutical Form 📦1.0.0 This IG
MedicinalProductDefinition.​classification Base example ​ http://umcterminologies.org/phpid-level4 Not State Unknown
MedicinalProductDefinition.​name.usage.country Base required Jurisdiction Value Set 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
country-system-allowed error MedicinalProductDefinition.name.usage.country Country must be coded with ISO 3166 (urn:iso:std:iso:3166) or the UMC jurisdiction code system (http://umcterminologies.org/CodeSystem/jurisdiction, e.g. EU) coding.all(system = 'urn:iso:std:iso:3166' or system = 'http://umcterminologies.org/CodeSystem/jurisdiction')
identifier-system-allowed error MedicinalProductDefinition.identifier Identifier system must be the UMC product id system or match http://umcterminologies.org/mpid-<2-letter country code> system = 'http://umcterminologies.org/umc-product-id' or system.matches('^http://umcterminologies[.]org/mpid-[a-zA-Z]{2}$')
market-auth-number-system-pattern error MedicinalProductDefinition.contained:regulatedAuthorization.identifier Market Authorization Number identifier system must match the pattern http://umcterminologies.org/market-authorization-number-<2-letter country code> system.matches('^http://umcterminologies[.]org/market-authorization-number-[a-zA-Z]{2}$')

Error generating table for profile http://umcterminologies.org/StructureDefinition/MedicinalProductDefinition-pub: getElementByName: can't find #RegulatedAuthorization.case in [MedicinalProductDefinition, MedicinalProductDefinition.id, MedicinalProductDefinition.meta, MedicinalProductDefinition.implicitRules, MedicinalProductDefinition.language, MedicinalProductDefinition.text, MedicinalProductDefinition.contained, MedicinalProductDefinition.extension, MedicinalProductDefinition.modifierExtension, MedicinalProductDefinition.identifier, MedicinalProductDefinition.type, MedicinalProductDefinition.domain, MedicinalProductDefinition.version, MedicinalProductDefinition.status, MedicinalProductDefinition.statusDate, MedicinalProductDefinition.description, MedicinalProductDefinition.combinedPharmaceuticalDoseForm, MedicinalProductDefinition.route, MedicinalProductDefinition.indication, MedicinalProductDefinition.legalStatusOfSupply, MedicinalProductDefinition.additionalMonitoringIndicator, MedicinalProductDefinition.specialMeasures, MedicinalProductDefinition.pediatricUseIndicator, MedicinalProductDefinition.classification, MedicinalProductDefinition.marketingStatus, MedicinalProductDefinition.packagedMedicinalProduct, MedicinalProductDefinition.comprisedOf, MedicinalProductDefinition.ingredient, MedicinalProductDefinition.impurity, MedicinalProductDefinition.attachedDocument, MedicinalProductDefinition.masterFile, MedicinalProductDefinition.contact, MedicinalProductDefinition.contact.id, MedicinalProductDefinition.contact.extension, MedicinalProductDefinition.contact.modifierExtension, MedicinalProductDefinition.contact.type, MedicinalProductDefinition.contact.contact, MedicinalProductDefinition.clinicalTrial, MedicinalProductDefinition.code, MedicinalProductDefinition.name, MedicinalProductDefinition.name.id, MedicinalProductDefinition.name.extension, MedicinalProductDefinition.name.modifierExtension, MedicinalProductDefinition.name.productName, MedicinalProductDefinition.name.type, MedicinalProductDefinition.name.part, MedicinalProductDefinition.name.part.id, MedicinalProductDefinition.name.part.extension, MedicinalProductDefinition.name.part.modifierExtension, MedicinalProductDefinition.name.part.part, MedicinalProductDefinition.name.part.type, MedicinalProductDefinition.name.usage, MedicinalProductDefinition.name.usage.id, MedicinalProductDefinition.name.usage.extension, MedicinalProductDefinition.name.usage.modifierExtension, MedicinalProductDefinition.name.usage.country, MedicinalProductDefinition.name.usage.jurisdiction, MedicinalProductDefinition.name.usage.language, MedicinalProductDefinition.crossReference, MedicinalProductDefinition.crossReference.id, MedicinalProductDefinition.crossReference.extension, MedicinalProductDefinition.crossReference.modifierExtension, MedicinalProductDefinition.crossReference.product, MedicinalProductDefinition.crossReference.type, MedicinalProductDefinition.operation, MedicinalProductDefinition.operation.id, MedicinalProductDefinition.operation.extension, MedicinalProductDefinition.operation.modifierExtension, MedicinalProductDefinition.operation.type, MedicinalProductDefinition.operation.effectiveDate, MedicinalProductDefinition.operation.organization, MedicinalProductDefinition.operation.confidentialityIndicator, MedicinalProductDefinition.characteristic, MedicinalProductDefinition.characteristic.id, MedicinalProductDefinition.characteristic.extension, MedicinalProductDefinition.characteristic.modifierExtension, MedicinalProductDefinition.characteristic.type, MedicinalProductDefinition.characteristic.value[x]] from http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicinalProductDefinition.​meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​subject.type Base extensible Resource Types 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​type Base example Regulated Authorization Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​region Base example Jurisdiction ValueSet 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​intendedUse Base preferred Product Intended Use 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​basis Base example Regulated Authorization Basis 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​case.type Base example Regulated Authorization Case Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​case.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​identifier:umcProductId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​type Base example Medicinal Product Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​domain Base required Medicinal Product Domain 📦5.0.0 FHIR Std.
MedicinalProductDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​combinedPharmaceuticalDoseForm Base example EDQM Pharmaceutical Form 📦1.0.0 This IG
MedicinalProductDefinition.​classification Base example ​ http://umcterminologies.org/phpid-level4 Not State Unknown
MedicinalProductDefinition.​ingredient Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​impurity Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contact.type Base example Product Contact Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​code Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.type Base example Product Name Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.part.type Base example Product Name Part Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.usage.country Base required Jurisdiction Value Set 📦1.0.0 This IG
MedicinalProductDefinition.​name.usage.jurisdiction Base example Jurisdiction ValueSet 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.usage.language Base required All Languages 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​crossReference.type Base example Product Cross Reference Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​operation.confidentialityIndicator Base example Product Confidentiality 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​characteristic.type Base example Product Characteristic 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
country-system-allowed error MedicinalProductDefinition.name.usage.country Country must be coded with ISO 3166 (urn:iso:std:iso:3166) or the UMC jurisdiction code system (http://umcterminologies.org/CodeSystem/jurisdiction, e.g. EU) coding.all(system = 'urn:iso:std:iso:3166' or system = 'http://umcterminologies.org/CodeSystem/jurisdiction')
identifier-system-allowed error MedicinalProductDefinition.identifier Identifier system must be the UMC product id system or match http://umcterminologies.org/mpid-<2-letter country code> system = 'http://umcterminologies.org/umc-product-id' or system.matches('^http://umcterminologies[.]org/mpid-[a-zA-Z]{2}$')
market-auth-number-system-pattern error MedicinalProductDefinition.contained:regulatedAuthorization.identifier Market Authorization Number identifier system must match the pattern http://umcterminologies.org/market-authorization-number-<2-letter country code> system.matches('^http://umcterminologies[.]org/market-authorization-number-[a-zA-Z]{2}$')

This structure is derived from MedicinalProductDefinition

Summary

Mandatory: 7 elements(13 nested mandatory elements)
Prohibited: 21 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicinalProductDefinition.contained
  • The element 1 is sliced based on the value of MedicinalProductDefinition.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicinalProductDefinition 0..* MedicinalProductDefinition Detailed definition of a medicinal product
MedicinalProductDefinition.id This element is included in summaries. 1..1 id Logical id of this artifact
MedicinalProductDefinition.text 0..1 Narrative Not used in this profile
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MedicinalProductDefinition.Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization 0..* RegulatedAuthorization Contained Regulated Authorization carrying the country-specific Market Authorization Number.
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier This element is included in summaries. C 1..1 Identifier Business identifier for the authorization, typically assigned by the authorizing body
Constraints: market-auth-number-system-pattern
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.system This element is included in summaries. 1..1 uri Country-specific Market Authorization Number system, e.g. http://umcterminologies.org/market-authorization-number-<2-letter ISO 3166 country code>.
Example General: http://www.acme.com/identifiers/patient
Example Market Authorization Number: http://umcterminologies.org/market-authorization-number-se
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.value This element is included in summaries. C 1..1 string Market Authorization Number value. To be sourced from a database in the future; no data is available yet.
Example General: 123456
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject This element is included in summaries. 1..1 Reference(MedicinalProductDefinition) The product type, treatment, facility or activity that is being authorized
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Required Pattern: # (extensions allowed)
MedicinalProductDefinition.Slices for identifier This element is included in summaries. C 1..* Identifier UMC product id plus zero-to-many Local MPIDs, system http://umcterminologies.org/mpid-<ISO 3166-1 alpha-2> (repeatable).
Slice: Unordered, Open by value:system
Constraints: identifier-system-allowed

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicinalProductDefinition.Slices for identifier.identifier:All Slices Content/Rules for all slices
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example Local MPID: http://umcterminologies.org/mpid-se
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId This element is included in summaries. 1..1 Identifier The UMC product id (exactly one).
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/umc-product-id (extensions allowed)
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
MedicinalProductDefinition.type This element is included in summaries. 0..1 CodeableConcept Regulatory type, e.g. Investigational or Authorized.
Binding: MedicinalProductType (example): Overall defining type of this medicinal product.
MedicinalProductDefinition.domain This element is included in summaries. 0..1 CodeableConcept If this medicine applies to human or veterinary uses.
Binding: MedicinalProductDomain (required)
MedicinalProductDefinition.status This element is a modifier element. This element is included in summaries. 0..1 CodeableConcept The status within the lifecycle of this product record.
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
MedicinalProductDefinition.combinedPharmaceuticalDoseForm This element is included in summaries. 0..1 CodeableConcept The dose form for a single part product, or combined form of a multiple part product
Binding: EDQM Pharmaceutical Form (example)
MedicinalProductDefinition.classification This element is included in summaries. 0..* CodeableConcept ​Allows the product to be classified by various systems (e.g. PhPID Level 4).
Binding: http://umcterminologies.org/phpid-level4 (example)
MedicinalProductDefinition.classification.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name This element is included in summaries. 1..* BackboneElement The product's name, including full name and possibly coded parts
MedicinalProductDefinition.name.productName This element is included in summaries. 1..1 string The full product name.
MedicinalProductDefinition.name.type This element is included in summaries. 0..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary.
Binding: ProductNameType (example): Type of a name for a Medicinal Product.
MedicinalProductDefinition.name.usage This element is included in summaries. 0..* BackboneElement Where and in which language this name applies (used for the local name)
MedicinalProductDefinition.name.usage.country This element is included in summaries. C 1..1 CodeableConcept Country where this name applies
Binding: Jurisdiction Value Set (required)
Constraints: country-system-allowed
MedicinalProductDefinition.name.usage.country.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.country.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
MedicinalProductDefinition.name.usage.country.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
MedicinalProductDefinition.name.usage.language This element is included in summaries. 1..1 CodeableConcept Language for this name
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
MedicinalProductDefinition.name.usage.language.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.language.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: urn:ietf:bcp:47 (extensions allowed)
MedicinalProductDefinition.name.usage.language.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicinalProductDefinition.​type Base example Medicinal Product Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​domain Base required Medicinal Product Domain 📦5.0.0 FHIR Std.
MedicinalProductDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​combinedPharmaceuticalDoseForm Base example EDQM Pharmaceutical Form 📦1.0.0 This IG
MedicinalProductDefinition.​classification Base example ​ http://umcterminologies.org/phpid-level4 Not State Unknown
MedicinalProductDefinition.​name.type Base example Product Name Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.usage.country Base required Jurisdiction Value Set 📦1.0.0 This IG
MedicinalProductDefinition.​name.usage.language Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
country-system-allowed error MedicinalProductDefinition.name.usage.country Country must be coded with ISO 3166 (urn:iso:std:iso:3166) or the UMC jurisdiction code system (http://umcterminologies.org/CodeSystem/jurisdiction, e.g. EU) coding.all(system = 'urn:iso:std:iso:3166' or system = 'http://umcterminologies.org/CodeSystem/jurisdiction')
identifier-system-allowed error MedicinalProductDefinition.identifier Identifier system must be the UMC product id system or match http://umcterminologies.org/mpid-<2-letter country code> system = 'http://umcterminologies.org/umc-product-id' or system.matches('^http://umcterminologies[.]org/mpid-[a-zA-Z]{2}$')
market-auth-number-system-pattern error MedicinalProductDefinition.contained:regulatedAuthorization.identifier Market Authorization Number identifier system must match the pattern http://umcterminologies.org/market-authorization-number-<2-letter country code> system.matches('^http://umcterminologies[.]org/market-authorization-number-[a-zA-Z]{2}$')

Differential View

This structure is derived from MedicinalProductDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicinalProductDefinition 0..* MedicinalProductDefinition Detailed definition of a medicinal product
MedicinalProductDefinition.id 1..1 id Logical id of this artifact
MedicinalProductDefinition.meta
MedicinalProductDefinition.meta.source 1..1 uri Identifies where the resource comes from
MedicinalProductDefinition.implicitRules 0..0 A set of rules under which this content was created
MedicinalProductDefinition.text 0..1 Narrative Not used in this profile
MedicinalProductDefinition.Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization 0..* RegulatedAuthorization Contained Regulated Authorization carrying the country-specific Market Authorization Number.
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.implicitRules 0..0 A set of rules under which this content was created
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.contained 0..0 Contained, inline Resources
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.modifierExtension 0..0 Extension
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier C 1..1 Identifier Business identifier for the authorization, typically assigned by the authorizing body
Constraints: market-auth-number-system-pattern
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.use 0..0 usual | official | temp | secondary | old (If known)
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.system 1..1 uri Country-specific Market Authorization Number system, e.g. http://umcterminologies.org/market-authorization-number-<2-letter ISO 3166 country code>.
Example Market Authorization Number: http://umcterminologies.org/market-authorization-number-se
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.identifier.value 1..1 string Market Authorization Number value. To be sourced from a database in the future; no data is available yet.
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject 1..1 Reference(MedicinalProductDefinition) The product type, treatment, facility or activity that is being authorized
MedicinalProductDefinition.Slices for contained.contained:regulatedAuthorization.subject.reference 1..1 string Literal reference, Relative, internal or absolute URL
Required Pattern: # (extensions allowed)
MedicinalProductDefinition.modifierExtension 0..0 Extension
MedicinalProductDefinition.Slices for identifier C 1..* Identifier UMC product id plus zero-to-many Local MPIDs, system http://umcterminologies.org/mpid-<ISO 3166-1 alpha-2> (repeatable).
Slice: Unordered, Open by value:system
Constraints: identifier-system-allowed
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicinalProductDefinition.Slices for identifier.identifier:All Slices Content/Rules for all slices
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.use 0..0 usual | official | temp | secondary | old (If known)
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.system 1..1 uri The namespace for the identifier value
Example Local MPID: http://umcterminologies.org/mpid-se
MedicinalProductDefinition.Slices for identifier.identifier:All Slices.value 1..1 string The value that is unique
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId 1..1 Identifier The UMC product id (exactly one).
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.use 0..0 usual | official | temp | secondary | old (If known)
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.system 1..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/umc-product-id (extensions allowed)
MedicinalProductDefinition.Slices for identifier.identifier:umcProductId.value 1..1 string The value that is unique
MedicinalProductDefinition.type 0..1 CodeableConcept Regulatory type, e.g. Investigational or Authorized.
MedicinalProductDefinition.domain 0..1 CodeableConcept If this medicine applies to human or veterinary uses.
Binding: MedicinalProductDomain (required)
MedicinalProductDefinition.status 0..1 CodeableConcept The status within the lifecycle of this product record.
MedicinalProductDefinition.statusDate 0..0 The date at which the given status became applicable
MedicinalProductDefinition.description 0..0 General description of this product
MedicinalProductDefinition.combinedPharmaceuticalDoseForm 0..1 CodeableConcept The dose form for a single part product, or combined form of a multiple part product
Binding: EDQM Pharmaceutical Form (example)
MedicinalProductDefinition.route 0..0 The path by which the product is taken into or makes contact with the body
MedicinalProductDefinition.indication 0..0 Description of indication(s) for this product, used when structured indications are not required
MedicinalProductDefinition.legalStatusOfSupply 0..0 The legal status of supply of the medicinal product as classified by the regulator
MedicinalProductDefinition.additionalMonitoringIndicator 0..0 Whether the Medicinal Product is subject to additional monitoring for regulatory reasons
MedicinalProductDefinition.specialMeasures 0..0 Whether the Medicinal Product is subject to special measures for regulatory reasons
MedicinalProductDefinition.pediatricUseIndicator 0..0 If authorised for use in children
MedicinalProductDefinition.classification 0..* CodeableConcept ​Allows the product to be classified by various systems (e.g. PhPID Level 4).
Binding: http://umcterminologies.org/phpid-level4 (example)
MedicinalProductDefinition.classification.coding 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.marketingStatus 0..0 Marketing status of the medicinal product, in contrast to marketing authorization
MedicinalProductDefinition.packagedMedicinalProduct 0..0 Package type for the product
MedicinalProductDefinition.contact 0..0 A product specific contact, person (in a role), or an organization
MedicinalProductDefinition.name 1..* BackboneElement The product's name, including full name and possibly coded parts
MedicinalProductDefinition.name.modifierExtension 0..0 Extension
MedicinalProductDefinition.name.productName 1..1 string The full product name.
MedicinalProductDefinition.name.type 0..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary.
MedicinalProductDefinition.name.part
MedicinalProductDefinition.name.part.part 1..1 string A fragment of a product name.
MedicinalProductDefinition.name.part.type 1..1 CodeableConcept Type for this part of the name (e.g. strength part)
MedicinalProductDefinition.name.usage 0..* BackboneElement Where and in which language this name applies (used for the local name)
MedicinalProductDefinition.name.usage.modifierExtension 0..0 Extension
MedicinalProductDefinition.name.usage.country C 1..1 CodeableConcept Country where this name applies
Binding: Jurisdiction Value Set (required)
Constraints: country-system-allowed
MedicinalProductDefinition.name.usage.country.coding 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.country.coding.system 1..1 uri Identity of the terminology system
MedicinalProductDefinition.name.usage.country.coding.code 1..1 code Symbol in syntax defined by the system
MedicinalProductDefinition.name.usage.language 1..1 CodeableConcept Language for this name
MedicinalProductDefinition.name.usage.language.coding 1..1 Coding Code defined by a terminology system
MedicinalProductDefinition.name.usage.language.coding.system 1..1 uri Identity of the terminology system
Required Pattern: urn:ietf:bcp:47 (extensions allowed)
MedicinalProductDefinition.name.usage.language.coding.code 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicinalProductDefinition.​domain Base required Medicinal Product Domain 📦5.0.0 FHIR Std.
MedicinalProductDefinition.​combinedPharmaceuticalDoseForm Base example EDQM Pharmaceutical Form 📦1.0.0 This IG
MedicinalProductDefinition.​classification Base example ​ http://umcterminologies.org/phpid-level4 Not State Unknown
MedicinalProductDefinition.​name.usage.country Base required Jurisdiction Value Set 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
country-system-allowed error MedicinalProductDefinition.name.usage.country Country must be coded with ISO 3166 (urn:iso:std:iso:3166) or the UMC jurisdiction code system (http://umcterminologies.org/CodeSystem/jurisdiction, e.g. EU) coding.all(system = 'urn:iso:std:iso:3166' or system = 'http://umcterminologies.org/CodeSystem/jurisdiction')
identifier-system-allowed error MedicinalProductDefinition.identifier Identifier system must be the UMC product id system or match http://umcterminologies.org/mpid-<2-letter country code> system = 'http://umcterminologies.org/umc-product-id' or system.matches('^http://umcterminologies[.]org/mpid-[a-zA-Z]{2}$')
market-auth-number-system-pattern error MedicinalProductDefinition.contained:regulatedAuthorization.identifier Market Authorization Number identifier system must match the pattern http://umcterminologies.org/market-authorization-number-<2-letter country code> system.matches('^http://umcterminologies[.]org/market-authorization-number-[a-zA-Z]{2}$')

Snapshot View

Error generating table for profile http://umcterminologies.org/StructureDefinition/MedicinalProductDefinition-pub: getElementByName: can't find #RegulatedAuthorization.case in [MedicinalProductDefinition, MedicinalProductDefinition.id, MedicinalProductDefinition.meta, MedicinalProductDefinition.implicitRules, MedicinalProductDefinition.language, MedicinalProductDefinition.text, MedicinalProductDefinition.contained, MedicinalProductDefinition.extension, MedicinalProductDefinition.modifierExtension, MedicinalProductDefinition.identifier, MedicinalProductDefinition.type, MedicinalProductDefinition.domain, MedicinalProductDefinition.version, MedicinalProductDefinition.status, MedicinalProductDefinition.statusDate, MedicinalProductDefinition.description, MedicinalProductDefinition.combinedPharmaceuticalDoseForm, MedicinalProductDefinition.route, MedicinalProductDefinition.indication, MedicinalProductDefinition.legalStatusOfSupply, MedicinalProductDefinition.additionalMonitoringIndicator, MedicinalProductDefinition.specialMeasures, MedicinalProductDefinition.pediatricUseIndicator, MedicinalProductDefinition.classification, MedicinalProductDefinition.marketingStatus, MedicinalProductDefinition.packagedMedicinalProduct, MedicinalProductDefinition.comprisedOf, MedicinalProductDefinition.ingredient, MedicinalProductDefinition.impurity, MedicinalProductDefinition.attachedDocument, MedicinalProductDefinition.masterFile, MedicinalProductDefinition.contact, MedicinalProductDefinition.contact.id, MedicinalProductDefinition.contact.extension, MedicinalProductDefinition.contact.modifierExtension, MedicinalProductDefinition.contact.type, MedicinalProductDefinition.contact.contact, MedicinalProductDefinition.clinicalTrial, MedicinalProductDefinition.code, MedicinalProductDefinition.name, MedicinalProductDefinition.name.id, MedicinalProductDefinition.name.extension, MedicinalProductDefinition.name.modifierExtension, MedicinalProductDefinition.name.productName, MedicinalProductDefinition.name.type, MedicinalProductDefinition.name.part, MedicinalProductDefinition.name.part.id, MedicinalProductDefinition.name.part.extension, MedicinalProductDefinition.name.part.modifierExtension, MedicinalProductDefinition.name.part.part, MedicinalProductDefinition.name.part.type, MedicinalProductDefinition.name.usage, MedicinalProductDefinition.name.usage.id, MedicinalProductDefinition.name.usage.extension, MedicinalProductDefinition.name.usage.modifierExtension, MedicinalProductDefinition.name.usage.country, MedicinalProductDefinition.name.usage.jurisdiction, MedicinalProductDefinition.name.usage.language, MedicinalProductDefinition.crossReference, MedicinalProductDefinition.crossReference.id, MedicinalProductDefinition.crossReference.extension, MedicinalProductDefinition.crossReference.modifierExtension, MedicinalProductDefinition.crossReference.product, MedicinalProductDefinition.crossReference.type, MedicinalProductDefinition.operation, MedicinalProductDefinition.operation.id, MedicinalProductDefinition.operation.extension, MedicinalProductDefinition.operation.modifierExtension, MedicinalProductDefinition.operation.type, MedicinalProductDefinition.operation.effectiveDate, MedicinalProductDefinition.operation.organization, MedicinalProductDefinition.operation.confidentialityIndicator, MedicinalProductDefinition.characteristic, MedicinalProductDefinition.characteristic.id, MedicinalProductDefinition.characteristic.extension, MedicinalProductDefinition.characteristic.modifierExtension, MedicinalProductDefinition.characteristic.type, MedicinalProductDefinition.characteristic.value[x]] from http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicinalProductDefinition.​meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​subject.type Base extensible Resource Types 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​type Base example Regulated Authorization Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​region Base example Jurisdiction ValueSet 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​intendedUse Base preferred Product Intended Use 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​basis Base example Regulated Authorization Basis 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​case.type Base example Regulated Authorization Case Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contained:regulatedAuthorization.​case.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​identifier:umcProductId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​type Base example Medicinal Product Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​domain Base required Medicinal Product Domain 📦5.0.0 FHIR Std.
MedicinalProductDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​combinedPharmaceuticalDoseForm Base example EDQM Pharmaceutical Form 📦1.0.0 This IG
MedicinalProductDefinition.​classification Base example ​ http://umcterminologies.org/phpid-level4 Not State Unknown
MedicinalProductDefinition.​ingredient Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​impurity Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​contact.type Base example Product Contact Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​code Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.type Base example Product Name Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.part.type Base example Product Name Part Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.usage.country Base required Jurisdiction Value Set 📦1.0.0 This IG
MedicinalProductDefinition.​name.usage.jurisdiction Base example Jurisdiction ValueSet 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​name.usage.language Base required All Languages 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​crossReference.type Base example Product Cross Reference Type 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​operation.confidentialityIndicator Base example Product Confidentiality 📍5.0.0 FHIR Std.
MedicinalProductDefinition.​characteristic.type Base example Product Characteristic 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
country-system-allowed error MedicinalProductDefinition.name.usage.country Country must be coded with ISO 3166 (urn:iso:std:iso:3166) or the UMC jurisdiction code system (http://umcterminologies.org/CodeSystem/jurisdiction, e.g. EU) coding.all(system = 'urn:iso:std:iso:3166' or system = 'http://umcterminologies.org/CodeSystem/jurisdiction')
identifier-system-allowed error MedicinalProductDefinition.identifier Identifier system must be the UMC product id system or match http://umcterminologies.org/mpid-<2-letter country code> system = 'http://umcterminologies.org/umc-product-id' or system.matches('^http://umcterminologies[.]org/mpid-[a-zA-Z]{2}$')
market-auth-number-system-pattern error MedicinalProductDefinition.contained:regulatedAuthorization.identifier Market Authorization Number identifier system must match the pattern http://umcterminologies.org/market-authorization-number-<2-letter country code> system.matches('^http://umcterminologies[.]org/market-authorization-number-[a-zA-Z]{2}$')

This structure is derived from MedicinalProductDefinition

Summary

Mandatory: 7 elements(13 nested mandatory elements)
Prohibited: 21 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicinalProductDefinition.contained
  • The element 1 is sliced based on the value of MedicinalProductDefinition.identifier

 

Other representations of profile: CSV, Excel, Schematron