UnicomIG
0.1.0 - ci-build

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

Resource Profile: Medication as manufactured item

Official URL: http://unicom-project.eu/fhir/StructureDefinition/MedicationAsManufacturedItem Version: 0.1.0
Draft as of 2024-10-11 Computable Name: MedicationAsManufacturedItem

Manufactured Item as a part of a product for clinical use cases (Medication resource)

Usage:

Formal Views of Profile Content

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

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... doseForm 1..1 CodeableConcept Manufactured Dose Form
... totalVolume 1..1 Quantity Manufactured Item Size
... ingredient 1..* BackboneElement Active ingredient
.... item 1..1 CodeableReference(Substance | Medication) Substance
Binding: EMA SPOR SMS Substances (preferred)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio Quantity of ingredient present
Slice: Unordered, Open by type:$this
..... strength[x]:strengthRatio 1..1 Ratio Strength (reference strength)
...... numerator 1..1 Quantity Numerator value
...... denominator 1..1 SimpleQuantity Denominator value

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.ingredient.itempreferredSubstancesSMS (a valid code from Substances EMA SPOR SMS)
http://unicom-project.eu/fhir/ValueSet/substances-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... doseForm 1..1 CodeableConcept Manufactured Dose Form
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... totalVolume Σ 1..1 Quantity Manufactured Item Size
... ingredient 1..* BackboneElement Active ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item 1..1 CodeableReference(Substance | Medication) Substance
Binding: EMA SPOR SMS Substances (preferred)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio Quantity of ingredient present
Slice: Unordered, Closed by type:$this
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.

..... strength[x]:strengthRatio 1..1 Ratio Strength (reference strength)
...... numerator ΣC 1..1 Quantity Numerator value
...... denominator ΣC 1..1 SimpleQuantity Denominator value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.statusrequiredMedicationStatusCodes
http://hl7.org/fhir/ValueSet/medication-status|5.0.0
from the FHIR Standard
Medication.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.ingredient.itempreferredSubstancesSMS (a valid code from Substances EMA SPOR SMS)
http://unicom-project.eu/fhir/ValueSet/substances-vs
from this IG
Medication.ingredient.strength[x]preferredMedicationIngredientStrengthCodes
http://hl7.org/fhir/ValueSet/medication-ingredientstrength
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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
.. Medication 0..* Medication Definition of a Medication
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.

... marketingAuthorizationHolder Σ 0..1 Reference(Organization) Organization that has authorization to market medication
... doseForm 1..1 CodeableConcept Manufactured Dose Form
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... totalVolume Σ 1..1 Quantity Manufactured Item Size
... ingredient 1..* BackboneElement Active ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item 1..1 CodeableReference(Substance | Medication) Substance
Binding: EMA SPOR SMS Substances (preferred)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio Quantity of ingredient present
Slice: Unordered, Closed by type:$this
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.

..... strength[x]:strengthRatio 1..1 Ratio Strength (reference strength)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... numerator ΣC 1..1 Quantity Numerator value
...... denominator ΣC 1..1 SimpleQuantity Denominator value
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire
... definition 0..1 Reference(MedicationKnowledge) Knowledge about this medication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedicationStatusCodes
http://hl7.org/fhir/ValueSet/medication-status|5.0.0
from the FHIR Standard
Medication.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.ingredient.itempreferredSubstancesSMS (a valid code from Substances EMA SPOR SMS)
http://unicom-project.eu/fhir/ValueSet/substances-vs
from this IG
Medication.ingredient.strength[x]preferredMedicationIngredientStrengthCodes
http://hl7.org/fhir/ValueSet/medication-ingredientstrength
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()

This structure is derived from Medication

Summary

Mandatory: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.ingredient.strength[x]

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... doseForm 1..1 CodeableConcept Manufactured Dose Form
... totalVolume 1..1 Quantity Manufactured Item Size
... ingredient 1..* BackboneElement Active ingredient
.... item 1..1 CodeableReference(Substance | Medication) Substance
Binding: EMA SPOR SMS Substances (preferred)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio Quantity of ingredient present
Slice: Unordered, Open by type:$this
..... strength[x]:strengthRatio 1..1 Ratio Strength (reference strength)
...... numerator 1..1 Quantity Numerator value
...... denominator 1..1 SimpleQuantity Denominator value

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.ingredient.itempreferredSubstancesSMS (a valid code from Substances EMA SPOR SMS)
http://unicom-project.eu/fhir/ValueSet/substances-vs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... doseForm 1..1 CodeableConcept Manufactured Dose Form
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... totalVolume Σ 1..1 Quantity Manufactured Item Size
... ingredient 1..* BackboneElement Active ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item 1..1 CodeableReference(Substance | Medication) Substance
Binding: EMA SPOR SMS Substances (preferred)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio Quantity of ingredient present
Slice: Unordered, Closed by type:$this
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.

..... strength[x]:strengthRatio 1..1 Ratio Strength (reference strength)
...... numerator ΣC 1..1 Quantity Numerator value
...... denominator ΣC 1..1 SimpleQuantity Denominator value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.statusrequiredMedicationStatusCodes
http://hl7.org/fhir/ValueSet/medication-status|5.0.0
from the FHIR Standard
Medication.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.ingredient.itempreferredSubstancesSMS (a valid code from Substances EMA SPOR SMS)
http://unicom-project.eu/fhir/ValueSet/substances-vs
from this IG
Medication.ingredient.strength[x]preferredMedicationIngredientStrengthCodes
http://hl7.org/fhir/ValueSet/medication-ingredientstrength
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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
.. Medication 0..* Medication Definition of a Medication
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.

... marketingAuthorizationHolder Σ 0..1 Reference(Organization) Organization that has authorization to market medication
... doseForm 1..1 CodeableConcept Manufactured Dose Form
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... totalVolume Σ 1..1 Quantity Manufactured Item Size
... ingredient 1..* BackboneElement Active ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item 1..1 CodeableReference(Substance | Medication) Substance
Binding: EMA SPOR SMS Substances (preferred)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio Quantity of ingredient present
Slice: Unordered, Closed by type:$this
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.

..... strength[x]:strengthRatio 1..1 Ratio Strength (reference strength)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... numerator ΣC 1..1 Quantity Numerator value
...... denominator ΣC 1..1 SimpleQuantity Denominator value
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire
... definition 0..1 Reference(MedicationKnowledge) Knowledge about this medication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedicationStatusCodes
http://hl7.org/fhir/ValueSet/medication-status|5.0.0
from the FHIR Standard
Medication.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
Medication.ingredient.itempreferredSubstancesSMS (a valid code from Substances EMA SPOR SMS)
http://unicom-project.eu/fhir/ValueSet/substances-vs
from this IG
Medication.ingredient.strength[x]preferredMedicationIngredientStrengthCodes
http://hl7.org/fhir/ValueSet/medication-ingredientstrength
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()

This structure is derived from Medication

Summary

Mandatory: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.ingredient.strength[x]

 

Other representations of profile: CSV, Excel, Schematron