POCP_HD010200UV01 E_ProductKind |
(Link to Excel View) Derived from RMIM: POCP_RM010200UV01 |
||||||||
Product |
Design Comments: The product, e.g., a medicine or device or food item, that is the primary unit which is manufactured and the object of an intended administration. It represents an entity, either in its real or actual form as something made, or described specifically, or more conceptually, generically, or "virtually". A product must be distinguished from one that is just packaging. Examples for products are tablet, capsule, solution for injection, powder, and device. Conversely, vial, bottle, pouch, and carton are containers, which though sometimes necessary for handling of the product, are not themselves administered, but emptied into some other container, or used with an injection or inhalation device. Even though a capsule can be considered a container holding granules, a capsule is still considered primary Product not PackagedProduct, because the capsule is the unit normally intended for administration, and so the capsule is the Product. In this way, a solution packaged in an administration unit, such as a dragee or a prefilled syringe may be considered primary Product rather than PackagedProduct, if it is intended to be applied completely as one unit, and not subdivided. This requires that the ingredients of such products are specified as a total amount per complete application rather than as a concentration. Examples for devices are chest tube, wound dressing, dental chair, and ventilator machine. Devices are any kind of product used for medical purposes or in conjunction with medical services, including, but not limited to, direct use for therapeutic purposes (e.g., orthopedic screw), diagnostic purposes (e.g. EKG machine), usage as applicator devices for the administration of medicines (e.g., syringes), or as tools (e.g., dental chair). (Note, while it may seem unusual to classify a wound dressing as a device, this is the practice in the regulatory context, in other contexts, these items are sometimes called "supplies".) A kit is a product that contains multiple parts administered together or used together in some intricate way. Some of the parts of a kit may be medicinal substances (medicines), and others may be devices, e.g., applicator devices. Kits are described as a primary product of form code meaning "kit" with parts. |
||||||||
classCode [1..1] (M) ManufacturedMaterial (CS) {CNE:V:EntityClassManufacturedMaterial, root= "MMAT"} |
Design Comments: Fixed to MMAT (manufactured material, "material" meaning simply "thing".) |
||||||||
determinerCode [1..1] (M) ManufacturedMaterial (CS) {CNE:V:EntityDeterminerDetermined, root= "KIND"} |
Design Comments: Fixed to KIND, as this is a product description, not a particular product instance. |
||||||||
code [0..1] ManufacturedMaterial (CD) {CWE:D:ProductEntityType} |
Design Comments: The code given to this kind of product, i.e., NDC code to medicines in the U.S., EAN or UPC codes to food items or devices. A code given to a device may also be known as "unique device identifier". Unlike a device instance identifier, however, this is a code for the specific kind of device analogously to the NDC code or UPC code that is a code of a manufactured kind of product respectively. The words "product code" "unique device identifiers" may have certain specific connotations in different regulatory contexts, to side-step such unwanted connotations, one may call this code the "Item Code", for it is the code for the item (product, medicine, thing, or class thereof) that is so described. |
||||||||
name [0..*] ManufacturedMaterial (DSET<EN>) |
Design Comments: The name of the product kind described. If this is a specific manufactured (brand) product, this would be the proprietary name. For general product class descriptions this would be a non-proprietary name. This attribute may sometimes be used instead of a code and descriptive data elements when no suitable coding system is available. The data type for the name has been allow for suffixes and also other name parts, which might hold proprietary dose form (e.g., "capsil", "discus", "injection system") or other name parts which may be required for recognition of the product among health professionals. Note that these name parts are never to be used instead of proper descriptive data elements (formCode, ingredients and their quantities, etc.) |
||||||||
desc [0..1] ManufacturedMaterial (ED) |
Design Comments: A text description of the product. While the data type ED would allow for a full product monograph to be carried in this attribute, this practice is to be avoided, because product monograph document structures (Structured Product Labeling) should be used instead for such documents. The description attribute is mainly to be used for brief descriptions which users of product catalogs can use to quickly distinguish this product from other similar products in a list of products. |
||||||||
riskCode [0..*] ManufacturedMaterial (DSET<CD>) {CWE:D:EntityRisk} |
Design Comments: Indicates a type of hazard or threat associated with the product. |
||||||||
handlingCode [0..*] ManufacturedMaterial (DSET<CD>) {CWE:D:EntityHandling} |
Design Comments: An indicator of special handling requirements for the product. E.g., keep at room temperature, store upright. |
||||||||
formCode [0..1] ManufacturedMaterial (CD) {CWE:D:MaterialForm} |
Design Comments: The principle form of a product, such as dosage form of a medicine. Values may be drawn from the MaterialForm HL7 vocabulary table or from other external code value sources. Notice the difference between an (Administered) Medicine and a PackagedMedicine. Both have formCodes. A box or vial is usually not a medicine Product.formCode but a PackageProduct.formCode, unless the entire box or the entire vial is meant for direct administration as a single unit. In principle, the formCode is a very coarsely-grained (high level) product class that focuses on physical appearance. At the top, it usually distinguishes between physical state of matter (solid, liquid, gaseous), and, because solids may be amorphous (e.g., powders), would allow distinguishing solid shaped from amorphous masses. The former can be individually handled and counted, whereas the latter (amorphous masses) can only be measured and require primary containers for handling. Thus the formCode has implications for how the product is quantified (counted vs. measured) and whether a primary container (e.g., vial) may be expected. |
||||||||
expirationTime [0..1] ManufacturedMaterial (IVL<TS>) |
Design Comments: The amount of time after date of manufacture that the manufacturer no longer ensures the safety, quality, and/or proper functioning of the material. Only the interval width is valued. |
||||||||
asNamedEntity [0..*] (R_NamedEntityUniveral) | |||||||||
asIdentifiedEntity [0..*] (IdentifiedEntity) | |||||||||
asManufacturedProduct [0..*] (ManufacturedProduct3) |
Design Comments: This role links the product (optionally) with the manufacturer of that product. Used when the entry point is the Product (E_ProductKind). When entry point is ManufacturedProduct (E_ProductListed) this manufacturer role should not be used. |
||||||||
asContent [0..*] (Content) |
Design Comments: A role representing the relationship between the product as contained in a package and its package. For example, insulin injectable liquid in a vial; tablets in a bottle. |
||||||||
asPartOfAssembly [0..*] (PartOfAssembly) |
Design Comments: Links the product as a component of a system or assembly. The system may be a defined product labeled elsewhere or it may be an anonymous product which is only used to specify that additional parts are also needed to make that system complete. For example, a hose system used within several intravenous infusion pump systems would refer to those pump systems but would not describe the pump systems in detail. On the other hand, the label for one of those pumps (not including the hose system) would have to refer to the hose system in a similar manner. The line: <manufacturedProduct> <code ... /> <name>FlexiFuse Line</name> <asPartOfAssembly> <wholeProduct> ... no code specified here ... <part> <partProduct> <code ... /> <name>PreciFuse Pump</name> </partProduct> </part> </wholeProduct> </asPartOfAssembly> </manufacturedProduct> The pump itself: <manufacturedProduct> <code ... /> <name>PreciFuse Pump</name> <asPartOfAssembly> <wholeProduct> ... no code specified here ... <part> <partProduct> <code ... /> <name>FlexiFuse Line</name> </partProduct> </part> </wholeProduct> </asPartOfAssembly> </manufacturedProduct> Notice that in either case the assembly itself remains anonymous because it has not a defined product code. Notice also that the pump itself does not come with the line, and hence the line cannot be described as a component of the pump. However, let's assume that that same FlexiFuse line is also a part of kit comprised of the portable version of the PreciFuse Pump product and 10 such lines. In that case the kit that is sold under a specific registered product code would also be specified as an assembly with a code. In that case the other parts of the assembly need not be described: <manufacturedProduct> <code ... /> <name>FlexiFuse Line</name> <asPartOfAssembly ... /> <asPartOfAssembly ... /> <asPartOfAssembly ... /> <asPartOfAssembly> <wholeProduct> <code .../> <name>PreciFuse PorterPump Kit</name> </wholeProduct> </asPartOfAssembly> </manufacturedProduct> and the kit would be described as: <manufacturedProduct> <code ... /> <name>PreciFuse PorterPump Kit</name> <formCode ... KIT .../> <part> <quantity value="1"/> <partProduct> <code .../> <name>PreciFuse PorterPump</name> </partProduct> </part> <part> <quantity value="10"/> <partProduct> <code .../> <name>FlexiFuse Line</name> </partProduct> </part> </manufacturedProduct> |
||||||||
asEntityWithGeneric [0..1] (EntityWithGeneric) |
Design Comments: Relationship that links to the non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer. |
||||||||
asSpecializedKind [0..*] (SpecializedKind) | |||||||||
asEquivalentEntity [0..*] (EquivalentEntity) |
Design Comments: Specifies the original innovator product which is the reference product for a generics product. This class allows referencing the original innovator or reference product as a MaterialKind on the scoper-end of this role, and a code specifying precisely in what way this product is bio-equivalent to the reference product (equivalence evaluation code). |
||||||||
part [0..*] (Part) |
Design Comments: Relates a multiple-component product to one of its components. For example, relates a contraceptive product to its separate estrogen and progestin tablets in a single container. The quantity of each part is represented as the Part.quantity. (The quantity of the parent product would be "1" for a single wheel containing both medications in this example.) Note the difference between part, ingredient and content. A part is a structural part, typically with an integral boundary and spatially distinguishable from other parts and the whole product. An ingredient is distributed throughout the product and not spatially distinct from other ingredients. A content is what is inside the lumen of a container and can in principle be emptied out of the container. |
||||||||
ingredient [0..*] (Ingredient) |
Design Comments: Relates a product (typically medicine) to a substance which it contains as an ingredient. Ingredients can be specified for medicines or other products, including devices, but they always mean the same thing: a material (here: chemical substance) in the make-up of the main product, not a structural part or content of a container, and not a material added later into a device for operation. For medicines and food this is obvious. For devices, an example for ingredient would be latex in a chest tube (but not an inhalant in a nebulizer device). |
||||||||
instanceOfKind1 [0..*] (R_ProductInstanceUniversal) | |||||||||
ManufacturedProduct3 |
Design Comments: This role links the product (optionally) with the manufacturer of that product. Used when the entry point is the Product (E_ProductKind). When entry point is ManufacturedProduct (E_ProductListed) this manufacturer role should not be used. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassManufacturedProduct, root= "MANU"} |
Design Comments: Fixed to MANU (manufactured product). |
||||||||
id [0..1] Role (II) |
Design Comments: An identifier used by the manufacturer to indicate a particular product type or line. E.g., catalog number. |
||||||||
manufacturerOrganization [0..1] (E_ProductEstablishmentUniversal) | |||||||||
subjectOf [0..*] (Subject) | |||||||||
consumedIn [0..*] (Consumable1) | |||||||||
productOf [0..*] (Product3) | |||||||||
Content |
Design Comments: A role representing the relationship between the product as contained in a package and its package. For example, insulin injectable liquid in a vial; tablets in a bottle. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassContent, root= "CONT"} |
Design Comments: Fixed to CONT (content), meaning the product is content of the packaged product. |
||||||||
quantity [1..1] Role (RTO<PQ,PQ>) |
Design Comments: A ratio which specifies how many small entities (numerator) are in a big entity (denominator). Constraint: the dimension of the numerator must be the same as the dimension of the ingredient quantity's denominator. |
||||||||
containerPackagedProduct [1..1] (PackagedProduct) |
Design Comments: A product in a container, or package. Represents the entirety of a product that has been packaged in a container for sale or supply; this representation of the Packaged Medicine may be in its real or actual form as something made, or described more conceptually, generically, or virtually, but it must represent a product contained in a package. |
||||||||
subjectOf [0..*] (Subject) | |||||||||
productOf [0..*] (Product3) |
Design Comments: Relationship that links a role played by a product to a "Production" act definitions (e.g., potential supply or reconstitution). |
||||||||
indirectTargetOf [0..*] (IndirectTarget) | |||||||||
PackagedProduct |
Design Comments: A product in a container, or package. Represents the entirety of a product that has been packaged in a container for sale or supply; this representation of the Packaged Medicine may be in its real or actual form as something made, or described more conceptually, generically, or virtually, but it must represent a product contained in a package. |
||||||||
classCode [1..1] (M) Container (CS) {CNE:V:EntityClassContainer, root= "CONT"} |
Design Comments: Fixed to CONT (content). |
||||||||
determinerCode [1..1] (M) Container (CS) {CNE:V:EntityDeterminerDetermined, root= "KIND"} |
Design Comments: Fixed to KIND, as this is a package description, not a particular packaged product instance. |
||||||||
code [0..1] Container (CD) {CWE:D:PackagedProductEntityType} |
Design Comments: The item code for a packaged product (e.g., complete National Drug Code [NDC] in the U.S.) |
||||||||
name [0..*] Container (DSET<EN>) |
Design Comments: A name for the packaged product, usually the same as the name of the product (except where the name contains some reference to the packaging (e.g., "tempo super-pack", "tic-tac easy-box"). |
||||||||
desc [0..1] Container (ED) |
Design Comments: A text description of the packaged product. This may include a discussion of the container. |
||||||||
formCode [0..1] Container (CD) {CWE:D:ContainerForm} |
Design Comments: The package type, such as "box" or "bottle". |
||||||||
capacityQuantity [0..1] Container (PQ) |
Design Comments: Captures the number of product units the package would contain if fully loaded. |
||||||||
capTypeCode [0..1] Container (CD) {CWE:D:ContainerCap} |
Design Comments: The type of container cap. In some cases, it is important for this to be consistent with decapping, piercing or other automated manipulation. Notions such as "child-proof cap" or "resealable bag" may also be indicated here. |
||||||||
asIdentifiedEntity [0..*] (IdentifiedEntity) | |||||||||
asManufacturedProduct [0..*] (ManufacturedProduct2) |
Design Comments: This role links the packaged product (optionally) with the manufacturer of that packaged product (distinguishable from the manufacturer of the product inside) and (more importantly) links the packaged product with the associated approval, policy, and characteristics and other information specifically applicable to that packaged product and distinguishable from other package products and the product inside. |
||||||||
asContent [0..*] (Content1) |
Design Comments: A role representing the relationship between an (inner) package and its larger (outer) package. This is the standard way to describe "intermediate" packaging, which regularly occur with non-solid medicines. For example, a solution for injection (Medicine) is packaged in a vial (a primary package or sometimes called "intermediary" package) and then several such vials are packed in a carton. Notice that the vial is not the Medicine, it is the content in the vial which is the medicine; the vial is just a necessary packaging to hold the liquid. |
||||||||
asSpecializedKind [0..*] (SpecializedKind) |
Design Comments: Generalization to specify a classification to the Product, Substance or Moiety. For example, one can specify any or all of (a) cellular/molecular action (e.g., Ca-channel blocker); (b) physiologic effect (e.g., vasodilator); and (c) molecular/chemical class (e.g. aminopenicillin). |
||||||||
IdentifiedEntity | |||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassIdentifiedEntity, root= "IDENT"} |
|||||||||
id [1..1] (M) Role (II) |
|||||||||
code [0..1] Role (CD) {CWE:D:IdentifiedEntityType} |
|||||||||
effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: If specified, limits the time range when this identifier is or was valid for the product. |
||||||||
assigningOrganization [0..1] (E_ProductEstablishmentUniversal) | |||||||||
subjectOf [0..*] (Subject) | |||||||||
ManufacturedProduct2 |
Design Comments: This role links the packaged product (optionally) with the manufacturer of that packaged product (distinguishable from the manufacturer of the product inside) and (more importantly) links the packaged product with the associated approval, policy, and characteristics and other information specifically applicable to that packaged product and distinguishable from other package products and the product inside. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassManufacturedProduct, root= "MANU"} |
Design Comments: Fixed to MANU (manufactured product). |
||||||||
id [0..1] Role (II) |
Design Comments: An identifier used by the manufacturer to indicate a particular product type or line. E.g., catalog number. |
||||||||
manufacturerOrganization [0..1] (E_ProductEstablishmentUniversal) | |||||||||
subjectOf [0..*] (Subject) | |||||||||
productOf [0..*] (Product2) | |||||||||
indirectTargetOf [0..*] (IndirectTarget) | |||||||||
Content1 |
Design Comments: A role representing the relationship between an (inner) package and its larger (outer) package. This is the standard way to describe "intermediate" packaging, which regularly occur with non-solid medicines. For example, a solution for injection (Medicine) is packaged in a vial (a primary package or sometimes called "intermediary" package) and then several such vials are packed in a carton. Notice that the vial is not the Medicine, it is the content in the vial which is the medicine; the vial is just a necessary packaging to hold the liquid. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassContent, root= "CONT"} |
Design Comments: Fixed to CONT (content), meaning the inner packaged product is content of the outer packaged product. |
||||||||
quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: A ratio which specifies how many inner packaged content entities (numerator) are in a outer packaging container entity (denominator). |
||||||||
containerPackagedProduct [1..1] (PackagedProduct) | |||||||||
subjectOf [0..*] (Subject) |
Design Comments: Links any of the roles played by the product to a variety of additional product information. |
||||||||
productOf [0..*] (Product2) |
Design Comments: Relationship that links a role played by a product to a "potential supply" act definition, indicating that this product (or packaged product) is available for sale or trade as described by the "potential supply" act definition. |
||||||||
indirectTargetOf [0..*] (IndirectTarget) |
Design Comments: Labels a product, part, or package as the unitary item for uniform billing standards. For example, on the product in the form of a tablet to indicate that the product is billed by the tablet (each); to a product in cream form to indicate it is billed volume or mass; on a vial or sachet package to indicate it is billed by vial or sachet (each). |
||||||||
Subject |
Design Comments: Links any of the roles played by the product to a variety of additional product information. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationTargetSubject, root= "SBJ"} |
Design Comments: Fixed to SBJ (subject) for the product (in that role) is the subject of that additional information. |
||||||||
negationInd [0..1] Participation (BL){default= "false"} |
Design Comments: Allows indicating that the stated characteristic does not apply. Note: it is better to make a complete affirmative statement in the Characteristic itself, rather than relying on negation indicator in the participation. For example, rather than saying "pre 1938 product" with negationInd = true, say "post 1938 product" and leave the negation indicator at its default, false, meaning no negation. |
||||||||
productInformation [1..1] (A_ProductInformationUniversal) | |||||||||
Product2 |
Design Comments: Relationship that links a role played by a product to a "potential supply" act definition, indicating that this product (or packaged product) is available for sale or trade as described by the "potential supply" act definition. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationProduct, root= "PRD"} |
Design Comments: Fixed to PRD (product). "Product" in this context (as a participation of a supply act) means that which is "brought forth" by the activity (literal meaning of latin "producere"), not that it is necessarily made from scratch in the supply act. |
||||||||
potentialSupply [1..1] (PotentialSupply) |
Design Comments: Specifies that and how a product may be traded. This can distinguish a product which is only available as a field-reconstituted item but not sold in that form, from one that is sold. Or it can distinguish a product actually available in the market as a kit, from the parts of the kit that are not independently available. May also indicate a list of suppliers that state that they supply this product (e.g. a local pharmacy has the medicine and can potentially dispense the medicine, or a wholesaler who carries the product in their catalog.) This may also be the beginning of formulary data structures. |
||||||||
PotentialSupply |
Design Comments: Specifies that and how a product may be traded. This can distinguish a product which is only available as a field-reconstituted item but not sold in that form, from one that is sold. Or it can distinguish a product actually available in the market as a kit, from the parts of the kit that are not independently available. May also indicate a list of suppliers that state that they supply this product (e.g. a local pharmacy has the medicine and can potentially dispense the medicine, or a wholesaler who carries the product in their catalog.) This may also be the beginning of formulary data structures. |
||||||||
classCode [1..1] (M) Supply (CS) {CNE:V:ActClassSupply, root= "SPLY"} |
Design Comments: Fixed to SPLY. |
||||||||
moodCode [1..1] (M) Supply (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
Design Comments: Fixed to DEF (definition of a supply action, not an actual supply.) |
||||||||
id [0..1] Supply (II) |
Design Comments: The identifier of the supply service for this product. Sometimes may be synonymous with the identifier for the product in the context of the potential supply activity (e.g., within the formulary). |
||||||||
title [0..1] Supply (ST) |
Design Comments: The name of the supply activity for this product. May be the name of the product within the context of the potential supply activity (e.g., within the formulary). |
||||||||
IndirectTarget |
Design Comments: Labels a product, part, or package as the unitary item for uniform billing standards. For example, on the product in the form of a tablet to indicate that the product is billed by the tablet (each); to a product in cream form to indicate it is billed volume or mass; on a vial or sachet package to indicate it is billed by vial or sachet (each). |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationIndirectTarget, root= "IND"} |
Design Comments: A ParticipationType concept "ValuedUnitItem" as a specialization of IndirectTarget is currently under discussion and would replace the general IND type code in the future normative revisions. |
||||||||
valuedItem [1..1] (A_ValuedItemIdentified) | |||||||||
SpecializedKind |
Design Comments: Generalization to specify a classification to the Product, Substance or Moiety. For example, one can specify any or all of (a) cellular/molecular action (e.g., Ca-channel blocker); (b) physiologic effect (e.g., vasodilator); and (c) molecular/chemical class (e.g. aminopenicillin). |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassIsSpeciesEntity, root= "GEN"} |
Design Comments: Fixed to GEN (generalization), indicating that a generalized product code is being provided. This is effectively an "is-a" relationship. |
||||||||
code [0..1] Role (CD) {CWE:D:MedicationGeneralizationRoleType} |
Design Comments: May specify a certain use of the generalization relationship. Since things may be classified in various ways, this code may be used to allow systems with limited understanding of the classes to show the classes in distinguished slots (e.g., product by effect, by mechanism of action, by chemical nature, etc.) Note that this code can not influence the simple interpretation of the relationship as an "is-a" relationship, i.e., the specialized kind role should not be used to indicate classes that may sometimes hold but not all the time, or that only hold under specific considerations. The latter might be an example of a similarity relationship, for which the "equivalent entity" role should be used instead. |
||||||||
generalizedMaterialKind [1..1] (MaterialKind) |
Design Comments: A specification of a kind of medicine, food material, or any product for the purpose of (a) describing a specific product with classification categories and (b) referring to a kind of product or material for describing drug-drug interactions or adjunct treatments. The classifying category may refer to any of various classifications and abstractions of products by any aspect, including, mechanism of action category, physiologic effect category, chemical structure category, or "clinical drug" category. This may also be used to represent a specific material or an ingredient when specifying drug-drug interactions or adjunct treatments. |
||||||||
subjectOf [0..*] (Subject) | |||||||||
MaterialKind |
Design Comments: A specification of a kind of medicine, food material, or any product for the purpose of (a) describing a specific product with classification categories and (b) referring to a kind of product or material for describing drug-drug interactions or adjunct treatments. The classifying category may refer to any of various classifications and abstractions of products by any aspect, including, mechanism of action category, physiologic effect category, chemical structure category, or "clinical drug" category. This may also be used to represent a specific material or an ingredient when specifying drug-drug interactions or adjunct treatments. |
||||||||
classCode [1..1] (M) Material (CS) {CNE:V:EntityClassMaterial, root= "MAT"} |
Design Comments: Fixed to MAT (material), however, note that whether or not a material is considered "manufactured" should not make any difference for any material - even naturally occurring fruits or substances - may be "manufactured" in some way, and the way by which a thing came into existence or how it is intended to come into existence or not change the class of classification of a thing. So, in the future, the difference between MAT and MMAT would disappear. It is therefore best in implementations to rely on the default of this classCode and not specify it or distinguish it from MMAT. |
||||||||
determinerCode [1..1] (M) Material (CS) {CNE:V:EntityDeterminerDetermined, root= "KIND"} |
Design Comments: Fixed to KIND (kind of product, class, never a particular instance of a product.) |
||||||||
code [1..1] (M) Material (CD) {CWE:D:EntityCode} |
Design Comments: Code specifying a kind of medicine, food material, or any product. The code may refer to any of various classifications and abstractions of products by any aspect, including, mechanism of action category, physiologic effect category, chemical structure category, or "clinical drug" category. It may also represent a specific material or an ingredient of material. |
||||||||
name [0..*] Material (DSET<TN>) |
|||||||||
Product3 |
Design Comments: Relationship that links a role played by a product to a "Production" act definitions (e.g., potential supply or reconstitution). |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationProduct, root= "PRD"} |
Design Comments: Fixed to PRD (product). "Product" in this context (as a participation) means that which is "brought forth" by the activity (literal meaning of latin "producere"). |
||||||||
production [1..1] (Production) |
Design Comments: Activities that may "produce" the product in some way, such as the possible Supply activity and the reconstitution activity by which, e.g., a powder is being mixed with water to form a syrup or an injectible liquid. Currently these activities do not include the manufacturing activity proper, but if a use case for describing manufacturing activity arose, it would be one of the specializations of this "Production" choice. |
||||||||
Production |
Design Comments: Activities that may "produce" the product in some way, such as the possible Supply activity and the reconstitution activity by which, e.g., a powder is being mixed with water to form a syrup or an injectible liquid. Currently these activities do not include the manufacturing activity proper, but if a use case for describing manufacturing activity arose, it would be one of the specializations of this "Production" choice. |
||||||||
author [0..1] (Author) |
Design Comments: The author of the supply activity, is the one who states that the product is so available. |
||||||||
choice of PotentialSupply |
Design Comments: Specifies that and how a product may be traded. This can distinguish a product which is only available as a field-reconstituted item but not sold in that form, from one that is sold. Or it can distinguish a product actually available in the market as a kit, from the parts of the kit that are not independently available. May also indicate a list of suppliers that state that they supply this product (e.g. a local pharmacy has the medicine and can potentially dispense the medicine, or a wholesaler who carries the product in their catalog.) This may also be the beginning of formulary data structures. |
||||||||
or Reconstitution |
Design Comments: The activity of reconstituting a medication or other product for delivery and use. E.g., mixing powder with water to provide a solution. |
||||||||
or ActDefinition |
Design Comments: Specifies the kind of production activity performed by an establishment. |
||||||||
Author |
Design Comments: The author of the supply activity, is the one who states that the product is so available. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationAuthorOriginator, root= "AUT"} |
Design Comments: Fixet to AUT (author). |
||||||||
assignedEntity2 [1..1] (R_ProductRelatedAssignedEntityUniversal) | |||||||||
Reconstitution |
Design Comments: The activity of reconstituting a medication or other product for delivery and use. E.g., mixing powder with water to provide a solution. |
||||||||
classCode [1..1] (M) Procedure (CS) {CNE:V:ActClassProcedure, root= "PROC"} |
|||||||||
moodCode [1..1] (M) Procedure (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
code [0..1] Procedure (CD) {CWE:D:ActProductReconstitutionType} |
Design Comments: An indication of the nature of the reconstitution activity. |
||||||||
consumable [0..*] (Consumable2) |
Design Comments: Reveals the products used as inputs into the reconstitution activity. |
||||||||
Inherits associations from Production |
Design Comments: Activities that may "produce" the product in some way, such as the possible Supply activity and the reconstitution activity by which, e.g., a powder is being mixed with water to form a syrup or an injectible liquid. Currently these activities do not include the manufacturing activity proper, but if a use case for describing manufacturing activity arose, it would be one of the specializations of this "Production" choice. |
||||||||
Consumable2 |
Design Comments: Reveals the products used as inputs into the reconstitution activity. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationConsumable, root= "CSM"} |
|||||||||
manufacturedProduct [1..1] (ManufacturedProduct) |
Design Comments: A Role of the Product (or Medicine) as a ManufacturedProduct. May be the main entry point to the Common Product Kind Model. |
||||||||
ManufacturedProduct |
Design Comments: A Role of the Product (or Medicine) as a ManufacturedProduct. May be the main entry point to the Common Product Kind Model. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassManufacturedProduct, root= "MANU"} |
Design Comments: Fixed to MANU (manufactured product). |
||||||||
id [0..1] Role (II) |
Design Comments: This Role.id is available to make specific references to the product use description from elsewhere in a document or message. |
||||||||
manufacturedProduct [1..1] (Product) | |||||||||
manufacturerOrganization [0..1] (E_ProductEstablishmentUniversal) | |||||||||
subjectOf [0..*] (Subject) | |||||||||
deviceOf [0..*] (Device) |
Design Comments: A relationship that links the product to its use as a device. Particularly, that links a device producing observations to the definitions of such observations, and a device that delivers therapeutic services to a definition of these services. |
||||||||
consumedIn [0..*] (Consumable1) |
Design Comments: Links a Medicine as a ManufacturedProduct with the SubstanceAdministration definition representing the labeled route. |
||||||||
productOf [0..*] (Product3) | |||||||||
indirectTargetOf [0..*] (IndirectTarget) | |||||||||
Device |
Design Comments: A relationship that links the product to its use as a device. Particularly, that links a device producing observations to the definitions of such observations, and a device that delivers therapeutic services to a definition of these services. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationTargetDevice, root= "DEV"} |
Design Comments: Fixed to DEV (but could be any of the specializations of DEV, to distinguish reusable from devices that are lost in the use. |
||||||||
deviceActDefinition [1..1] (A_DeviceActDefinitionUniversal) | |||||||||
Consumable1 |
Design Comments: Links a Medicine as a ManufacturedProduct with the SubstanceAdministration definition representing the labeled route. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationConsumable, root= "CSM"} |
Design Comments: Fixed to CSM (consumable). |
||||||||
administrationDetail [1..1] (AdministrationDetail) |
Design Comments: A choice between the simple SubstanceAdministration containing but a route code and full-featured administration instructions. |
||||||||
AdministrationDetail |
Design Comments: A choice between the simple SubstanceAdministration containing but a route code and full-featured administration instructions. |
||||||||
choice of SubstanceAdministrationRte |
Design Comments: The only purpose of the SubstanceAdministration class in the Medicine model is to represent the labeled route. Design Comments: #nosuffix |
||||||||
or A_ProductUseGuidelineUniversal | |||||||||
SubstanceAdministrationRte |
Design Comments: The only purpose of the SubstanceAdministration class in the Medicine model is to represent the labeled route. Design Comments: #nosuffix |
||||||||
classCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActClassSubstanceAdministration, root= "SBADM"} |
Design Comments: Fixed to SBADM (substance administration) |
||||||||
moodCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
Design Comments: Fixed to DEF (definition of a substance administration, not an actual administration.) |
||||||||
routeCode [1..1] (M) SubstanceAdministration (CD) {CWE:D:RouteOfAdministration} |
Design Comments: Labeled route of administration. |
||||||||
ActDefinition |
Design Comments: Specifies the kind of production activity performed by an establishment. |
||||||||
classCode [1..1] (M) Act (CS) {CNE:V:ActClassRoot, root= "ACT"} |
|||||||||
moodCode [1..1] (M) Act (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
code [0..1] Act (CD) {CWE:D:ManufacturerActivityActType} |
Design Comments: A code that provides information about the type of manufacturer activity that the performing entity is capable of carrying out. |
||||||||
text [0..1] Act (ED) |
Design Comments: A text description of the type of manufacturer activity that the performing entity is capable of carrying out. |
||||||||
effectiveTime [0..1] Act (IVL<TS>) |
Design Comments: A specification of the time period during which the performing entity is capable of carrying out the act in question. |
||||||||
primaryPerformer [0..*] (PrimaryPerformer) |
Design Comments: Links the production activity to an establishment. |
||||||||
Inherits associations from Production |
Design Comments: Activities that may "produce" the product in some way, such as the possible Supply activity and the reconstitution activity by which, e.g., a powder is being mixed with water to form a syrup or an injectible liquid. Currently these activities do not include the manufacturing activity proper, but if a use case for describing manufacturing activity arose, it would be one of the specializations of this "Production" choice. |
||||||||
PrimaryPerformer |
Design Comments: Links the production activity to an establishment. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationPrimaryPerformer, root= "PPRF"} |
|||||||||
assignedEntity2 [1..1] (R_ProductRelatedAssignedEntityUniversal) | |||||||||
PartOfAssembly |
Design Comments: Links the product as a component of a system or assembly. The system may be a defined product labeled elsewhere or it may be an anonymous product which is only used to specify that additional parts are also needed to make that system complete. For example, a hose system used within several intravenous infusion pump systems would refer to those pump systems but would not describe the pump systems in detail. On the other hand, the label for one of those pumps (not including the hose system) would have to refer to the hose system in a similar manner. The line: <manufacturedProduct> <code ... /> <name>FlexiFuse Line</name> <asPartOfAssembly> <wholeProduct> ... no code specified here ... <part> <partProduct> <code ... /> <name>PreciFuse Pump</name> </partProduct> </part> </wholeProduct> </asPartOfAssembly> </manufacturedProduct> The pump itself: <manufacturedProduct> <code ... /> <name>PreciFuse Pump</name> <asPartOfAssembly> <wholeProduct> ... no code specified here ... <part> <partProduct> <code ... /> <name>FlexiFuse Line</name> </partProduct> </part> </wholeProduct> </asPartOfAssembly> </manufacturedProduct> Notice that in either case the assembly itself remains anonymous because it has not a defined product code. Notice also that the pump itself does not come with the line, and hence the line cannot be described as a component of the pump. However, let's assume that that same FlexiFuse line is also a part of kit comprised of the portable version of the PreciFuse Pump product and 10 such lines. In that case the kit that is sold under a specific registered product code would also be specified as an assembly with a code. In that case the other parts of the assembly need not be described: <manufacturedProduct> <code ... /> <name>FlexiFuse Line</name> <asPartOfAssembly ... /> <asPartOfAssembly ... /> <asPartOfAssembly ... /> <asPartOfAssembly> <wholeProduct> <code .../> <name>PreciFuse PorterPump Kit</name> </wholeProduct> </asPartOfAssembly> </manufacturedProduct> and the kit would be described as: <manufacturedProduct> <code ... /> <name>PreciFuse PorterPump Kit</name> <formCode ... KIT .../> <part> <quantity value="1"/> <partProduct> <code .../> <name>PreciFuse PorterPump</name> </partProduct> </part> <part> <quantity value="10"/> <partProduct> <code .../> <name>FlexiFuse Line</name> </partProduct> </part> </manufacturedProduct> |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassPart, root= "PART"} |
Design Comments: Fixed to PART. |
||||||||
wholeProduct [1..1] (Product) | |||||||||
EntityWithGeneric |
Design Comments: Relationship that links to the non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassHasGeneric, root= "GRIC"} |
|||||||||
genericMedicine [1..1] (GenericMedicine) |
Design Comments: The non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer. |
||||||||
GenericMedicine |
Design Comments: The non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer. |
||||||||
classCode [1..1] (M) ManufacturedMaterial (CS) {CNE:V:EntityClassManufacturedMaterial, root= "MMAT"} |
|||||||||
determinerCode [1..1] (M) ManufacturedMaterial (CS) {CNE:V:EntityDeterminerDetermined, root= "KIND"} |
|||||||||
code [0..1] ManufacturedMaterial (CD) {CWE:D:DrugEntity} |
|||||||||
name [1..*] ManufacturedMaterial (DSET<TN>) |
Design Comments: The non-proprietary, generic, or "established" name. |
||||||||
EquivalentEntity |
Design Comments: Specifies the original innovator product which is the reference product for a generics product. This class allows referencing the original innovator or reference product as a MaterialKind on the scoper-end of this role, and a code specifying precisely in what way this product is bio-equivalent to the reference product (equivalence evaluation code). |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassEquivalentEntity, root= "EQUIV"} |
Design Comments: The class code is fixed to EquivalentEntity (EQUIV). |
||||||||
code [0..1] Role (CD) {CWE:D:EquivalenceEvaluationRoleType} |
Design Comments: A code specifying in what way the equivalent entity (player) is considered equivalent to is reference entity (scoper). This is used to reference materials submitted from another source (e.g., repackagers, OTC, etc.) Examples: no known or suspected bioequivalence problems; potential bioequivalence problems have been resolved with evidence supporting bioequivalence; bioequivalence problems have not been fully resolved. See also: U.S. Food and Drug Administration. Center for Drug Evaluation and Research. Approved drug products with therapeutic equivalence evaluations. Available from: http://www.fda.gov/cder/ob/docs/preface/ecpreface.htm. |
||||||||
definingMaterialKind [1..1] (MaterialKind) | |||||||||
Part |
Design Comments: Relates a multiple-component product to one of its components. For example, relates a contraceptive product to its separate estrogen and progestin tablets in a single container. The quantity of each part is represented as the Part.quantity. (The quantity of the parent product would be "1" for a single wheel containing both medications in this example.) Note the difference between part, ingredient and content. A part is a structural part, typically with an integral boundary and spatially distinguishable from other parts and the whole product. An ingredient is distributed throughout the product and not spatially distinct from other ingredients. A content is what is inside the lumen of a container and can in principle be emptied out of the container. |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassPart, root= "PART"} |
Design Comments: Fixed to PART. |
||||||||
id [0..1] Role (II) |
Design Comments: The identifier for the product in the context of its being part of another product. This is used in order to make specific references to a product as part of another. |
||||||||
quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: A ratio specifying the amount of a part (numerator) in an amount (denominator) of the whole Medicine. It is important to note that as all Role quantities the numerator and denominator stand for the amount of the exact kind of entity specified as the part and whole respectively, and not something else. For example, when the medicine is a kit with tablets being the parts, the numerator numbers the amount of tablets of the same kind in the kit. However, if the kit consists of 2 vial-packaged liquids, each vial holding 3 mL, the part quantity specifies the total amount of this liquid (e.g. 6 mL), not 2 (vials). Thus all quantities have the exact same interpretation which is important to draw any quantitative inference from these relationships (e.g. "how much ingredient is in a package?"). |
||||||||
partProduct [1..1] (Product) | |||||||||
subjectOf [0..*] (Subject) | |||||||||
deviceOf [0..*] (Device) | |||||||||
consumedIn [0..*] (Consumable1) | |||||||||
productOf [0..*] (Product3) | |||||||||
indirectTargetOf [0..*] (IndirectTarget) | |||||||||
Ingredient |
Design Comments: Relates a product (typically medicine) to a substance which it contains as an ingredient. Ingredients can be specified for medicines or other products, including devices, but they always mean the same thing: a material (here: chemical substance) in the make-up of the main product, not a structural part or content of a container, and not a material added later into a device for operation. For medicines and food this is obvious. For devices, an example for ingredient would be latex in a chest tube (but not an inhalant in a nebulizer device). |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassIngredientEntity, root= "INGR"} |
Design Comments: The class code of the Ingredient role is used to distinguish active ingredients (ACTI) from inactive ingredients (IACT). In previous releases of this specification special classes existed by the name of ActiveIngredient and Inactive ingredient. These special classes had their meaning only by this same classCode, which was set as a fixed property. For active ingredients, there are specialized concepts which allow disambiguating the basis of strength. Note that for the general classCode active ingredient (ACTI) it is unknown if the quantity of such an ingredient is expressed precisely in terms of the playing ingredient substance or if it is specified in terms of a closely related substance (active moiety or reference substance). The specializations are: * ACTIB: active ingredient - basis of strength. Active ingredient, where the ingredient substance (player) is itself the basis of strength, i.e., where the Role.quantity specifies exactly the quantity of the player substance in the medicine formulation. For example, Lopressor 50 mg actually contains 50 mg of metoprolol succinate, even though the active moiety is metoprolol, but also: Tenormin 50 mg contain 50 mg of atenolol, as free base, i.e., where the active ingredient atenolol is also the active moiety. * ACTIM: active ingredient - moiety is basis of strength. Active ingredient, where not the ingredient substance (player), but its active moiety is the "basis of strength", i.e., where the Role.quantity specifies the quantity of the ingredient substance's active moiety in the medicine formulation. For example, 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol hydrochloride equivalent to betaxolol base 5 mg. * ACTIR: active ingredient - reference substance is basis of strength. Active ingredient, where not the ingredient substance (player) but another reference substance with the same active moiety, is the "basis of strength", i.e., where the Role.quantity specifies the quantity of a reference substance, similar but different from the ingredient substance's in the medicine formulation. For example, Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent to 50 mg of metoprolol tartrate. [from SPL] |
||||||||
id [0..1] Role (II) |
Design Comments: An identifier to establish mostly internal references as a SubstanceAdministration.consumable for the unambiguous specification of dose quantity without having to repeat the entire content. Example: <section ... DESCRIPTION ...> <subject> <manufacturedProduct> <manufacturedProduct> <ingredient classCode="ACTIM"> <id root="60a4db80-573d-11db-b0de-0800200c9a66"/> <quantity .../> <ingredientSubstance .../> </ingredient> </manufacturedProduct> </manufacturedProduct> </subject> </section> ... <section ... DOSAGE AND ADMINISTRATION ...> <excerpt> <highlight> <substanceAdministration> ... <consumable> <ingredient classCode="ACTIM"> <id root="60a4db80-573d-11db-b0de-0800200c9a66"/> </ingredient> </consumable> ... </substanceAdministration> </highlight> </excerpt> </section> |
||||||||
effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: Sometimes be used to indicate the ingredient is no longer used but was in the product during the time given. Notice that as product information is maintained over time, other information may also be outdated, and this time range may not be the most complete manner to keep this history information. If the effectiveTime is not specified (as it would usually be the case), the meaning is that there is no specific limit of validity of the ingredient information, and that the information is indeed valid at the time it was originally composed. |
||||||||
confidentialityCode [0..1] Role (CD) {CWE:D:Confidentiality} |
Design Comments: Used to indicate that the manufacturer considers the presence of the ingredient a trade secret. This could be the case for inactive ingredients. |
||||||||
quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: A ratio specifying the strength of the ingredient as amount of ingredient substance (numerator) in amount of medicine (denominator). For example, a 50 mg tablet contains 50 mg in 1 tablet; a 50 mg per 5 mL syrup contains 50 mg in 5 mL. Note that for countable dose forms ("eaches") no unit is required in the denominator, i.e., the denominator is a dimensionless number with unit 1 (one, the unity). The fact that the dose is per tablet, capsule, or whatever the dose form may be is recorded in the formCode of the scoping product, not in a unit of measure Constraint: The quantity expressed by Role quantity numerator and denominator must always be one of the following kinds of quantity: 1. count 2. amount of substance 3. mass 4. volume 5. arbitrary unit (representing some extensive property of Entity) In the given context these five quantities can be clearly discriminated by examination of the unit in use. An Entity is either countable (case 1) or not countable, in which case some unit is required (cases 2-4). This must be derivable from the Entity formCode. The dimension of the denominator must be the same as the dimension of all of the quantity numerators of the scoper's (i.e., the product's) played roles (e.g., package content, part of kit, etc.). |
||||||||
ingredientSubstance [1..1] (E_SubstanceClinicalUniversal) | |||||||||
subjectOf [0..*] (Subject) | |||||||||
indirectTargetOf [0..*] (IndirectTarget) |