Medication
1.1.0 - STU Belgium flag

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

Logical Model: BELMMedProduct - Detailed Descriptions

Draft as of 2024-11-18

Definitions for the BELMMedProduct logical model.

Guidance on how to interpret the contents of this table can be found here

0. BELMMedProduct
Definition

A logical data model for representing a medicinal product.

ShortMedicinal Product
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BELMMedProduct.identifier
Definition

A unique identifier for the medication line

ShortUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. BELMMedProduct.name
Definition

The name or designation of the product

ShortThe name or designation of the product
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. BELMMedProduct.description
Definition

The text description of the product when not coded

ShortThe text description of the product when not coded
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. BELMMedProduct.ingredient
Definition

The ingredients or components of the product

ShortThe ingredients or components of the product
Control0..*
TypeBackboneElement
10. BELMMedProduct.ingredient.product
Definition

The product or substance

ShortThe product or substance
Control1..1
TypeCodeableConcept
12. BELMMedProduct.ingredient.strength
Definition

The quantity or amount of ingredient in the parent product

ShortThe quantity or amount of ingredient in the parent product
Control0..1
TypeQuantity(SimpleQuantity)
14. BELMMedProduct.doseForm
Definition

The dose form of the product

ShortThe dose form of the product
Control0..1
TypeCodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. BELMMedProduct
Definition

A logical data model for representing a medicinal product.

ShortMedicinal Product
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BELMMedProduct.identifier
Definition

A unique identifier for the medication line

ShortUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. BELMMedProduct.name
Definition

The name or designation of the product

ShortThe name or designation of the product
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. BELMMedProduct.description
Definition

The text description of the product when not coded

ShortThe text description of the product when not coded
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. BELMMedProduct.ingredient
Definition

The ingredients or components of the product

ShortThe ingredients or components of the product
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. BELMMedProduct.ingredient.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. BELMMedProduct.ingredient.product
Definition

The product or substance

ShortThe product or substance
Control1..1
TypeCodeableConcept
14. BELMMedProduct.ingredient.strength
Definition

The quantity or amount of ingredient in the parent product

ShortThe quantity or amount of ingredient in the parent product
Control0..1
TypeQuantity(SimpleQuantity)
16. BELMMedProduct.doseForm
Definition

The dose form of the product

ShortThe dose form of the product
Control0..1
TypeCodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. BELMMedProduct
Definition

A logical data model for representing a medicinal product.

ShortMedicinal Product
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BELMMedProduct.identifier
Definition

A unique identifier for the medication line

ShortUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. BELMMedProduct.name
Definition

The name or designation of the product

ShortThe name or designation of the product
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. BELMMedProduct.description
Definition

The text description of the product when not coded

ShortThe text description of the product when not coded
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. BELMMedProduct.ingredient
Definition

The ingredients or components of the product

ShortThe ingredients or components of the product
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. BELMMedProduct.ingredient.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
12. BELMMedProduct.ingredient.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on BELMMedProduct.ingredient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 14. BELMMedProduct.ingredient.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. BELMMedProduct.ingredient.product
    Definition

    The product or substance

    ShortThe product or substance
    Control1..1
    TypeCodeableConcept
    18. BELMMedProduct.ingredient.strength
    Definition

    The quantity or amount of ingredient in the parent product

    ShortThe quantity or amount of ingredient in the parent product
    Control0..1
    TypeQuantity(SimpleQuantity)
    20. BELMMedProduct.doseForm
    Definition

    The dose form of the product

    ShortThe dose form of the product
    Control0..1
    TypeCodeableConcept