UnicomIG
0.1.0 - ci-build

UnicomIG, published by UNICOM. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/hl7-eu/unicom-ig and changes regularly. See the Directory of published versions

Resource Profile: Processing Profile - Medicinal Product

Official URL: http://unicom-project.eu/fhir/StructureDefinition/TransitionMedicinalProductDefinition Version: 0.1.0
Active as of 2023-02-03 Computable Name: TransitionMedicinalProductDefinition

Intermediate profile for processing PPL Medicinal Product data

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

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

This structure is derived from MedicinalProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..*MedicinalProductDefinitionDetailed definition of a medicinal product
... Slices for identifier 0..*IdentifierIdentifier for the medicinal product: MPID, EMA PMS ID, national ID, or other
Slice: Unordered, Open by pattern:system
.... identifier:mpid 0..1IdentifierMPID
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/mpId
.... identifier:pmsid 0..1IdentifierPMS ID
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/pmsId
... domain 0..1CodeableConceptIf this medicine applies to human or veterinary uses
... status 0..1CodeableConceptStatus of the product's data. Default 200000005004 'Current'
... legalStatusOfSupply 0..1CodeableConceptLegal status of supply on the medicinal product level.
... classification 0..*CodeableConceptAllows the product to be classified by various systems
Binding: Anatomical Therapeutic Chemical classification system (preferred)
... ingredient 0..0
... impurity 0..0
... name 1..*BackboneElementThe product's name, including full name and possibly coded parts
.... productName 1..1stringThe full product name
.... Slices for namePart 0..*BackboneElementMedicinal product name part
Slice: Ordered, Open by pattern:type
..... namePart:invented 0..1BackboneElementCoding words or phrases of the name
...... type 1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000002
........ display1..1stringRepresentation defined by the system
Fixed Value: Invented name part
..... namePart:strength 0..1BackboneElementCoding words or phrases of the name
...... type 1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000004
........ display1..1stringRepresentation defined by the system
Fixed Value: Strength part
..... namePart:doseForm 0..1BackboneElementCoding words or phrases of the name
...... type 1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000005
........ display1..1stringRepresentation defined by the system
Fixed Value: Pharmaceutical dose form part
.... countryLanguage 0..*BackboneElementCountry and jurisdiction where the name applies
..... country
...... Slices for coding 0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000000002
....... coding:iso 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: https://www.hl7.org/fhir/valueset-country.html
..... language
...... Slices for coding 0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000072057
....... coding:bcp 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/all-languages
... characteristic 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicinalProductDefinition.classificationpreferredSporAtc (a valid code from ATC Human EMA)
MedicinalProductDefinition.characteristic.typerequiredNoBinding (a valid code from Domain EMA)
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..*MedicinalProductDefinitionDetailed definition of a medicinal product
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier for the medicinal product: MPID, EMA PMS ID, national ID, or other
Slice: Unordered, Open by pattern:system
.... identifier:mpid Σ0..1IdentifierMPID
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/mpId
.... identifier:pmsid Σ0..1IdentifierPMS ID
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/pmsId
... status ?!Σ0..1CodeableConceptStatus of the product's data. Default 200000005004 'Current'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... combinedPharmaceuticalDoseForm Σ0..1CodeableConceptAuthorised dose form for the product, incl combination package dose forms
Binding: CombinedDoseForm (example): Dose forms for a product as a whole, considering all individual parts, but before any mixing

... legalStatusOfSupply Σ0..1CodeableConceptLegal status of supply on the medicinal product level.
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

... classification Σ0..*CodeableConceptAllows the product to be classified by various systems
Binding: Anatomical Therapeutic Chemical classification system (preferred)
... name Σ1..*BackboneElementThe product's name, including full name and possibly coded parts
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... productName Σ1..1stringThe full product name
.... Slices for namePart Σ0..*BackboneElementMedicinal product name part
Slice: Ordered, Open by pattern:type
..... namePart:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.

..... namePart:invented Σ0..1BackboneElementCoding words or phrases of the name
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000002
........ display1..1stringRepresentation defined by the system
Fixed Value: Invented name part
..... namePart:strength Σ0..1BackboneElementCoding words or phrases of the name
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000004
........ display1..1stringRepresentation defined by the system
Fixed Value: Strength part
..... namePart:doseForm Σ0..1BackboneElementCoding words or phrases of the name
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000005
........ display1..1stringRepresentation defined by the system
Fixed Value: Pharmaceutical dose form part
.... countryLanguage Σ0..*BackboneElementCountry and jurisdiction where the name applies
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... country Σ1..1CodeableConceptCountry code for where this name applies
Binding: Country ValueSet (example): Jurisdiction codes

...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000000002
....... coding:iso Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.hl7.org/fhir/valueset-country.html
..... language Σ1..1CodeableConceptLanguage code for this name
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000072057
....... coding:bcp Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/all-languages

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicinalProductDefinition.identifier:mpid.userequiredIdentifierUse
MedicinalProductDefinition.identifier:pmsid.userequiredIdentifierUse
MedicinalProductDefinition.domainexampleMedicinalProductDomain
MedicinalProductDefinition.statuspreferredPublicationStatus
MedicinalProductDefinition.combinedPharmaceuticalDoseFormexampleCombinedDoseForm
MedicinalProductDefinition.legalStatusOfSupplyexampleLegalStatusOfSupply
MedicinalProductDefinition.classificationpreferredSporAtc (a valid code from ATC Human EMA)
MedicinalProductDefinition.name.namePart.typeexampleProductNamePartType
MedicinalProductDefinition.name.namePart:invented.typeexamplePattern: 220000000002("Invented name part")
MedicinalProductDefinition.name.namePart:strength.typeexamplePattern: 220000000004("Strength part")
MedicinalProductDefinition.name.namePart:doseForm.typeexamplePattern: 220000000005("Pharmaceutical dose form part")
MedicinalProductDefinition.name.countryLanguage.countryexampleCountry ValueSet
MedicinalProductDefinition.name.countryLanguage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicinalProductDefinition.characteristic.typerequiredNoBinding (a valid code from Domain EMA)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicinalProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicinalProductDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicinalProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicinalProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicinalProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..*MedicinalProductDefinitionDetailed definition of a medicinal product
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier for the medicinal product: MPID, EMA PMS ID, national ID, or other
Slice: Unordered, Open by pattern:system
.... identifier:mpid Σ0..1IdentifierMPID
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/mpId
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:pmsid Σ0..1IdentifierPMS ID
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/pmsId
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... type Σ0..1CodeableConceptRegulatory type, e.g. Investigational or Authorized
Binding: MedicinalProductType (example): Overall defining type of this medicinal product.

... domain Σ0..1CodeableConceptIf this medicine applies to human or veterinary uses
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).

... version Σ0..1stringA business identifier relating to a specific version of the product
... status ?!Σ0..1CodeableConceptStatus of the product's data. Default 200000005004 'Current'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... description Σ0..1markdownGeneral description of this product
... combinedPharmaceuticalDoseForm Σ0..1CodeableConceptAuthorised dose form for the product, incl combination package dose forms
Binding: CombinedDoseForm (example): Dose forms for a product as a whole, considering all individual parts, but before any mixing

... route Σ0..*CodeableConceptThe path by which the product is taken into or makes contact with the body
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.


... indication Σ0..1markdownDescription of indication(s) for this product, used when structured indications are not required
... legalStatusOfSupply Σ0..1CodeableConceptLegal status of supply on the medicinal product level.
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

... additionalMonitoringIndicator Σ0..1CodeableConceptWhether the Medicinal Product is subject to additional monitoring for regulatory reasons
Binding: AdditionalMonitoring (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements (e.g. Black Triangle Monitoring).

... specialMeasures Σ0..*CodeableConceptWhether the Medicinal Product is subject to special measures for regulatory reasons
Binding: SpecialMeasures (example): Extra measures defined for a Medicinal Product, such as a requirement to conduct post-authorisation studies.


... pediatricUseIndicator Σ0..1CodeableConceptIf authorised for use in children
Binding: PediatricUse (example): Suitability for age groups, in particular children.

... classification Σ0..*CodeableConceptAllows the product to be classified by various systems
Binding: Anatomical Therapeutic Chemical classification system (preferred)
... marketingStatus Σ0..*MarketingStatusMarketing status of the medicinal product, in contrast to marketing authorization
... packagedMedicinalProduct Σ0..*CodeableConceptPackage type for the product
Binding: MedicinalProductPackageType (example): Types of medicinal product packs


... attachedDocument Σ0..*Reference(DocumentReference)Additional documentation about the medicinal product
... masterFile Σ0..*Reference(DocumentReference)A master file for the medicinal product (e.g. Pharmacovigilance System Master File)
... contact Σ0..*BackboneElementA product specific contact, person (in a role), or an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptAllows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information
Binding: ProductContactType (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements.

.... contact Σ1..1Reference(Organization | PractitionerRole)A product specific contact, person (in a role), or an organization
... clinicalTrial Σ0..*Reference(ResearchStudy)Clinical trials or studies that this product is involved in
... code Σ0..*CodingA code that this product is known by, within some formal terminology
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.


... name Σ1..*BackboneElementThe product's name, including full name and possibly coded parts
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... productName Σ1..1stringThe full product name
.... type Σ0..1CodeableConceptType of product name, such as rINN, BAN, Proprietary, Non-Proprietary
Binding: ProductNameType (example): Type of a name for a Medicinal Product.

.... Slices for namePart Σ0..*BackboneElementMedicinal product name part
Slice: Ordered, Open by pattern:type
..... namePart:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.

..... namePart:invented Σ0..1BackboneElementCoding words or phrases of the name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000002
........ display1..1stringRepresentation defined by the system
Fixed Value: Invented name part
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
..... namePart:strength Σ0..1BackboneElementCoding words or phrases of the name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000004
........ display1..1stringRepresentation defined by the system
Fixed Value: Strength part
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
..... namePart:doseForm Σ0..1BackboneElementCoding words or phrases of the name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000005
........ display1..1stringRepresentation defined by the system
Fixed Value: Pharmaceutical dose form part
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
.... countryLanguage Σ0..*BackboneElementCountry and jurisdiction where the name applies
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... country Σ1..1CodeableConceptCountry code for where this name applies
Binding: Country ValueSet (example): Jurisdiction codes

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000000002
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:iso Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.hl7.org/fhir/valueset-country.html
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... jurisdiction Σ0..1CodeableConceptJurisdiction code for where this name applies
Binding: Jurisdiction ValueSet (example): Jurisdiction codes

..... language Σ1..1CodeableConceptLanguage code for this name
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000072057
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:bcp Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/all-languages
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
... crossReference Σ0..*BackboneElementReference to another product, e.g. for linking authorised to investigational product
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... product Σ1..1CodeableReference(MedicinalProductDefinition)Reference to another product, e.g. for linking authorised to investigational product
.... type Σ0..1CodeableConceptThe type of relationship, for instance branded to generic or virtual to actual product
Binding: ProductCrossReferenceType (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements.

... operation Σ0..*BackboneElementA manufacturing or administrative process for the medicinal product
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableReference(ActivityDefinition | PlanDefinition)The type of manufacturing operation e.g. manufacturing itself, re-packaging
.... effectiveDate Σ0..1PeriodDate range of applicability
.... organization Σ0..*Reference(Organization)The organization responsible for the particular process, e.g. the manufacturer or importer
.... confidentialityIndicator Σ0..1CodeableConceptSpecifies whether this process is considered proprietary or confidential
Binding: ProductConfidentiality (example): Confidentiality rating, e.g. commercial sensitivity for a Medicinal Product.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicinalProductDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicinalProductDefinition.identifier:mpid.userequiredIdentifierUse
MedicinalProductDefinition.identifier:mpid.typeextensibleIdentifier Type Codes
MedicinalProductDefinition.identifier:pmsid.userequiredIdentifierUse
MedicinalProductDefinition.identifier:pmsid.typeextensibleIdentifier Type Codes
MedicinalProductDefinition.typeexampleMedicinalProductType
MedicinalProductDefinition.domainexampleMedicinalProductDomain
MedicinalProductDefinition.statuspreferredPublicationStatus
MedicinalProductDefinition.combinedPharmaceuticalDoseFormexampleCombinedDoseForm
MedicinalProductDefinition.routeexampleSNOMEDCTRouteCodes
MedicinalProductDefinition.legalStatusOfSupplyexampleLegalStatusOfSupply
MedicinalProductDefinition.additionalMonitoringIndicatorexampleAdditionalMonitoring
MedicinalProductDefinition.specialMeasuresexampleSpecialMeasures
MedicinalProductDefinition.pediatricUseIndicatorexamplePediatricUse
MedicinalProductDefinition.classificationpreferredSporAtc (a valid code from ATC Human EMA)
MedicinalProductDefinition.packagedMedicinalProductexampleMedicinalProductPackageType
MedicinalProductDefinition.contact.typeexampleProductContactType
MedicinalProductDefinition.codeexampleSNOMEDCTMedicationCodes
MedicinalProductDefinition.name.typeexampleProductNameType
MedicinalProductDefinition.name.namePart.typeexampleProductNamePartType
MedicinalProductDefinition.name.namePart:invented.typeexamplePattern: 220000000002("Invented name part")
MedicinalProductDefinition.name.namePart:strength.typeexamplePattern: 220000000004("Strength part")
MedicinalProductDefinition.name.namePart:doseForm.typeexamplePattern: 220000000005("Pharmaceutical dose form part")
MedicinalProductDefinition.name.countryLanguage.countryexampleCountry ValueSet
MedicinalProductDefinition.name.countryLanguage.jurisdictionexampleJurisdiction ValueSet
MedicinalProductDefinition.name.countryLanguage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicinalProductDefinition.crossReference.typeexampleProductCrossReferenceType
MedicinalProductDefinition.operation.confidentialityIndicatorexampleProductConfidentiality
MedicinalProductDefinition.characteristic.typerequiredNoBinding (a valid code from Domain EMA)

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningMedicinalProductDefinition.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicinalProductDefinition

Summary

Mandatory: 0 element (6 nested mandatory elements)
Prohibited: 3 elements

Slices

This structure defines the following Slices:

  • The element MedicinalProductDefinition.identifier is sliced based on the value of pattern:system
  • The element MedicinalProductDefinition.name.namePart is sliced based on the value of pattern:type (ordered)
  • The element MedicinalProductDefinition.name.countryLanguage.country.coding is sliced based on the value of pattern:system
  • The element MedicinalProductDefinition.name.countryLanguage.language.coding is sliced based on the value of pattern:system

Differential View

This structure is derived from MedicinalProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..*MedicinalProductDefinitionDetailed definition of a medicinal product
... Slices for identifier 0..*IdentifierIdentifier for the medicinal product: MPID, EMA PMS ID, national ID, or other
Slice: Unordered, Open by pattern:system
.... identifier:mpid 0..1IdentifierMPID
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/mpId
.... identifier:pmsid 0..1IdentifierPMS ID
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/pmsId
... domain 0..1CodeableConceptIf this medicine applies to human or veterinary uses
... status 0..1CodeableConceptStatus of the product's data. Default 200000005004 'Current'
... legalStatusOfSupply 0..1CodeableConceptLegal status of supply on the medicinal product level.
... classification 0..*CodeableConceptAllows the product to be classified by various systems
Binding: Anatomical Therapeutic Chemical classification system (preferred)
... ingredient 0..0
... impurity 0..0
... name 1..*BackboneElementThe product's name, including full name and possibly coded parts
.... productName 1..1stringThe full product name
.... Slices for namePart 0..*BackboneElementMedicinal product name part
Slice: Ordered, Open by pattern:type
..... namePart:invented 0..1BackboneElementCoding words or phrases of the name
...... type 1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000002
........ display1..1stringRepresentation defined by the system
Fixed Value: Invented name part
..... namePart:strength 0..1BackboneElementCoding words or phrases of the name
...... type 1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000004
........ display1..1stringRepresentation defined by the system
Fixed Value: Strength part
..... namePart:doseForm 0..1BackboneElementCoding words or phrases of the name
...... type 1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000005
........ display1..1stringRepresentation defined by the system
Fixed Value: Pharmaceutical dose form part
.... countryLanguage 0..*BackboneElementCountry and jurisdiction where the name applies
..... country
...... Slices for coding 0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000000002
....... coding:iso 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: https://www.hl7.org/fhir/valueset-country.html
..... language
...... Slices for coding 0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000072057
....... coding:bcp 0..1CodingCode defined by a terminology system
........ system 1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/all-languages
... characteristic 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicinalProductDefinition.classificationpreferredSporAtc (a valid code from ATC Human EMA)
MedicinalProductDefinition.characteristic.typerequiredNoBinding (a valid code from Domain EMA)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..*MedicinalProductDefinitionDetailed definition of a medicinal product
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier for the medicinal product: MPID, EMA PMS ID, national ID, or other
Slice: Unordered, Open by pattern:system
.... identifier:mpid Σ0..1IdentifierMPID
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/mpId
.... identifier:pmsid Σ0..1IdentifierPMS ID
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/pmsId
... status ?!Σ0..1CodeableConceptStatus of the product's data. Default 200000005004 'Current'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... combinedPharmaceuticalDoseForm Σ0..1CodeableConceptAuthorised dose form for the product, incl combination package dose forms
Binding: CombinedDoseForm (example): Dose forms for a product as a whole, considering all individual parts, but before any mixing

... legalStatusOfSupply Σ0..1CodeableConceptLegal status of supply on the medicinal product level.
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

... classification Σ0..*CodeableConceptAllows the product to be classified by various systems
Binding: Anatomical Therapeutic Chemical classification system (preferred)
... name Σ1..*BackboneElementThe product's name, including full name and possibly coded parts
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... productName Σ1..1stringThe full product name
.... Slices for namePart Σ0..*BackboneElementMedicinal product name part
Slice: Ordered, Open by pattern:type
..... namePart:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.

..... namePart:invented Σ0..1BackboneElementCoding words or phrases of the name
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000002
........ display1..1stringRepresentation defined by the system
Fixed Value: Invented name part
..... namePart:strength Σ0..1BackboneElementCoding words or phrases of the name
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000004
........ display1..1stringRepresentation defined by the system
Fixed Value: Strength part
..... namePart:doseForm Σ0..1BackboneElementCoding words or phrases of the name
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000005
........ display1..1stringRepresentation defined by the system
Fixed Value: Pharmaceutical dose form part
.... countryLanguage Σ0..*BackboneElementCountry and jurisdiction where the name applies
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... country Σ1..1CodeableConceptCountry code for where this name applies
Binding: Country ValueSet (example): Jurisdiction codes

...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000000002
....... coding:iso Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.hl7.org/fhir/valueset-country.html
..... language Σ1..1CodeableConceptLanguage code for this name
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000072057
....... coding:bcp Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/all-languages

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicinalProductDefinition.identifier:mpid.userequiredIdentifierUse
MedicinalProductDefinition.identifier:pmsid.userequiredIdentifierUse
MedicinalProductDefinition.domainexampleMedicinalProductDomain
MedicinalProductDefinition.statuspreferredPublicationStatus
MedicinalProductDefinition.combinedPharmaceuticalDoseFormexampleCombinedDoseForm
MedicinalProductDefinition.legalStatusOfSupplyexampleLegalStatusOfSupply
MedicinalProductDefinition.classificationpreferredSporAtc (a valid code from ATC Human EMA)
MedicinalProductDefinition.name.namePart.typeexampleProductNamePartType
MedicinalProductDefinition.name.namePart:invented.typeexamplePattern: 220000000002("Invented name part")
MedicinalProductDefinition.name.namePart:strength.typeexamplePattern: 220000000004("Strength part")
MedicinalProductDefinition.name.namePart:doseForm.typeexamplePattern: 220000000005("Pharmaceutical dose form part")
MedicinalProductDefinition.name.countryLanguage.countryexampleCountry ValueSet
MedicinalProductDefinition.name.countryLanguage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicinalProductDefinition.characteristic.typerequiredNoBinding (a valid code from Domain EMA)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicinalProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicinalProductDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicinalProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicinalProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicinalProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..*MedicinalProductDefinitionDetailed definition of a medicinal product
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierIdentifier for the medicinal product: MPID, EMA PMS ID, national ID, or other
Slice: Unordered, Open by pattern:system
.... identifier:mpid Σ0..1IdentifierMPID
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/mpId
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:pmsid Σ0..1IdentifierPMS ID
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/pmsId
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... type Σ0..1CodeableConceptRegulatory type, e.g. Investigational or Authorized
Binding: MedicinalProductType (example): Overall defining type of this medicinal product.

... domain Σ0..1CodeableConceptIf this medicine applies to human or veterinary uses
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).

... version Σ0..1stringA business identifier relating to a specific version of the product
... status ?!Σ0..1CodeableConceptStatus of the product's data. Default 200000005004 'Current'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... description Σ0..1markdownGeneral description of this product
... combinedPharmaceuticalDoseForm Σ0..1CodeableConceptAuthorised dose form for the product, incl combination package dose forms
Binding: CombinedDoseForm (example): Dose forms for a product as a whole, considering all individual parts, but before any mixing

... route Σ0..*CodeableConceptThe path by which the product is taken into or makes contact with the body
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.


... indication Σ0..1markdownDescription of indication(s) for this product, used when structured indications are not required
... legalStatusOfSupply Σ0..1CodeableConceptLegal status of supply on the medicinal product level.
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

... additionalMonitoringIndicator Σ0..1CodeableConceptWhether the Medicinal Product is subject to additional monitoring for regulatory reasons
Binding: AdditionalMonitoring (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements (e.g. Black Triangle Monitoring).

... specialMeasures Σ0..*CodeableConceptWhether the Medicinal Product is subject to special measures for regulatory reasons
Binding: SpecialMeasures (example): Extra measures defined for a Medicinal Product, such as a requirement to conduct post-authorisation studies.


... pediatricUseIndicator Σ0..1CodeableConceptIf authorised for use in children
Binding: PediatricUse (example): Suitability for age groups, in particular children.

... classification Σ0..*CodeableConceptAllows the product to be classified by various systems
Binding: Anatomical Therapeutic Chemical classification system (preferred)
... marketingStatus Σ0..*MarketingStatusMarketing status of the medicinal product, in contrast to marketing authorization
... packagedMedicinalProduct Σ0..*CodeableConceptPackage type for the product
Binding: MedicinalProductPackageType (example): Types of medicinal product packs


... attachedDocument Σ0..*Reference(DocumentReference)Additional documentation about the medicinal product
... masterFile Σ0..*Reference(DocumentReference)A master file for the medicinal product (e.g. Pharmacovigilance System Master File)
... contact Σ0..*BackboneElementA product specific contact, person (in a role), or an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptAllows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information
Binding: ProductContactType (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements.

.... contact Σ1..1Reference(Organization | PractitionerRole)A product specific contact, person (in a role), or an organization
... clinicalTrial Σ0..*Reference(ResearchStudy)Clinical trials or studies that this product is involved in
... code Σ0..*CodingA code that this product is known by, within some formal terminology
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.


... name Σ1..*BackboneElementThe product's name, including full name and possibly coded parts
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... productName Σ1..1stringThe full product name
.... type Σ0..1CodeableConceptType of product name, such as rINN, BAN, Proprietary, Non-Proprietary
Binding: ProductNameType (example): Type of a name for a Medicinal Product.

.... Slices for namePart Σ0..*BackboneElementMedicinal product name part
Slice: Ordered, Open by pattern:type
..... namePart:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.

..... namePart:invented Σ0..1BackboneElementCoding words or phrases of the name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000002
........ display1..1stringRepresentation defined by the system
Fixed Value: Invented name part
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
..... namePart:strength Σ0..1BackboneElementCoding words or phrases of the name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000004
........ display1..1stringRepresentation defined by the system
Fixed Value: Strength part
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
..... namePart:doseForm Σ0..1BackboneElementCoding words or phrases of the name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... part Σ1..1stringA fragment of a product name
...... type Σ1..1CodeableConceptIdentifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000000
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000005
........ display1..1stringRepresentation defined by the system
Fixed Value: Pharmaceutical dose form part
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
.... countryLanguage Σ0..*BackboneElementCountry and jurisdiction where the name applies
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... country Σ1..1CodeableConceptCountry code for where this name applies
Binding: Country ValueSet (example): Jurisdiction codes

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000000002
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:iso Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.hl7.org/fhir/valueset-country.html
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... jurisdiction Σ0..1CodeableConceptJurisdiction code for where this name applies
Binding: Jurisdiction ValueSet (example): Jurisdiction codes

..... language Σ1..1CodeableConceptLanguage code for this name
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*CodingEMA or ISO codes for country
Slice: Unordered, Open by pattern:system
....... coding:ema Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu/v1/lists/100000072057
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:bcp Σ0..1CodingCode defined by a terminology system
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/all-languages
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
... crossReference Σ0..*BackboneElementReference to another product, e.g. for linking authorised to investigational product
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... product Σ1..1CodeableReference(MedicinalProductDefinition)Reference to another product, e.g. for linking authorised to investigational product
.... type Σ0..1CodeableConceptThe type of relationship, for instance branded to generic or virtual to actual product
Binding: ProductCrossReferenceType (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements.

... operation Σ0..*BackboneElementA manufacturing or administrative process for the medicinal product
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableReference(ActivityDefinition | PlanDefinition)The type of manufacturing operation e.g. manufacturing itself, re-packaging
.... effectiveDate Σ0..1PeriodDate range of applicability
.... organization Σ0..*Reference(Organization)The organization responsible for the particular process, e.g. the manufacturer or importer
.... confidentialityIndicator Σ0..1CodeableConceptSpecifies whether this process is considered proprietary or confidential
Binding: ProductConfidentiality (example): Confidentiality rating, e.g. commercial sensitivity for a Medicinal Product.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicinalProductDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicinalProductDefinition.identifier:mpid.userequiredIdentifierUse
MedicinalProductDefinition.identifier:mpid.typeextensibleIdentifier Type Codes
MedicinalProductDefinition.identifier:pmsid.userequiredIdentifierUse
MedicinalProductDefinition.identifier:pmsid.typeextensibleIdentifier Type Codes
MedicinalProductDefinition.typeexampleMedicinalProductType
MedicinalProductDefinition.domainexampleMedicinalProductDomain
MedicinalProductDefinition.statuspreferredPublicationStatus
MedicinalProductDefinition.combinedPharmaceuticalDoseFormexampleCombinedDoseForm
MedicinalProductDefinition.routeexampleSNOMEDCTRouteCodes
MedicinalProductDefinition.legalStatusOfSupplyexampleLegalStatusOfSupply
MedicinalProductDefinition.additionalMonitoringIndicatorexampleAdditionalMonitoring
MedicinalProductDefinition.specialMeasuresexampleSpecialMeasures
MedicinalProductDefinition.pediatricUseIndicatorexamplePediatricUse
MedicinalProductDefinition.classificationpreferredSporAtc (a valid code from ATC Human EMA)
MedicinalProductDefinition.packagedMedicinalProductexampleMedicinalProductPackageType
MedicinalProductDefinition.contact.typeexampleProductContactType
MedicinalProductDefinition.codeexampleSNOMEDCTMedicationCodes
MedicinalProductDefinition.name.typeexampleProductNameType
MedicinalProductDefinition.name.namePart.typeexampleProductNamePartType
MedicinalProductDefinition.name.namePart:invented.typeexamplePattern: 220000000002("Invented name part")
MedicinalProductDefinition.name.namePart:strength.typeexamplePattern: 220000000004("Strength part")
MedicinalProductDefinition.name.namePart:doseForm.typeexamplePattern: 220000000005("Pharmaceutical dose form part")
MedicinalProductDefinition.name.countryLanguage.countryexampleCountry ValueSet
MedicinalProductDefinition.name.countryLanguage.jurisdictionexampleJurisdiction ValueSet
MedicinalProductDefinition.name.countryLanguage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicinalProductDefinition.crossReference.typeexampleProductCrossReferenceType
MedicinalProductDefinition.operation.confidentialityIndicatorexampleProductConfidentiality
MedicinalProductDefinition.characteristic.typerequiredNoBinding (a valid code from Domain EMA)

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningMedicinalProductDefinition.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicinalProductDefinition

Summary

Mandatory: 0 element (6 nested mandatory elements)
Prohibited: 3 elements

Slices

This structure defines the following Slices:

  • The element MedicinalProductDefinition.identifier is sliced based on the value of pattern:system
  • The element MedicinalProductDefinition.name.namePart is sliced based on the value of pattern:type (ordered)
  • The element MedicinalProductDefinition.name.countryLanguage.country.coding is sliced based on the value of pattern:system
  • The element MedicinalProductDefinition.name.countryLanguage.language.coding is sliced based on the value of pattern:system

 

Other representations of profile: CSV, Excel, Schematron