| CommonProduct UML Documentation |
CommonProduct
Class AdministeredDrug
"Contains the identifier of the medical substance/treatment administered.... If the substance administered is a vaccine, CVX codes may be used to code this field...." - HL7 Version 2.8, RXA-5“A role for the product when merely refered to as one that might be administered. This is the role through which the product model would be entered for electronic prescribing.” – HL7 Version 3 (Role->AdministerableMaterial)."Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications." - HL7 FHIR, MedicationAdministration.medication[x]
Attributes |
«II» Id | administeredBarcodeId |
"This field contains the pharmacy system's assigned barcode number for the give occurrence. For IV orders, many pharmacy systems generate a barcode number to identify a specific bag/bottle of the order. This number can be an instance identifier; unique for the patient, drug combination, and schedule instance or it may be just a drug identifier." - HL7 Version 2.8, RXA-25
|
«II» Id | administrationTagId |
"Contains an identifier for the individual product instance for the dispense occurrence. This may represent a barcode, RFID or other means of automatically-readable product instance. Repetitions represent the same instance where more than one barcode, RFID or other identification is present." - HL7 Version 2.8, RXA-29
|
LocallyManufacturedProduct | pharmacyManufacturedProduct |
Pointer to a product that was created by a pharmacist or by a clinician by compounding two or more ingredients which was then administered to the Patient.
|
MedicinalProductInstance | productInstance |
Identifies the medicinal product administered.
|
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | AdministeredDrug |
Name Expression | |
Namespace | CommonProduct |
Owned Template Signature | |
Owner | CommonProduct |
Owning Template Parameter | |
Package | CommonProduct |
Qualified Name | FHIM::CommonProduct::AdministeredDrug |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
administeredBarcodeId
Public «II» Id administeredBarcodeId
-
"This field contains the pharmacy system's assigned barcode number for the give occurrence. For IV orders, many pharmacy systems generate a barcode number to identify a specific bag/bottle of the order. This number can be an instance identifier; unique for the patient, drug combination, and schedule instance or it may be just a drug identifier." - HL7 Version 2.8, RXA-25
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AdministeredDrug |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | administeredBarcodeId |
Name Expression | |
Namespace | AdministeredDrug |
Opposite | |
Owner | AdministeredDrug |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::AdministeredDrug::administeredBarcodeId |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
administrationTagId
Public «II» Id administrationTagId
-
"Contains an identifier for the individual product instance for the dispense occurrence. This may represent a barcode, RFID or other means of automatically-readable product instance. Repetitions represent the same instance where more than one barcode, RFID or other identification is present." - HL7 Version 2.8, RXA-29
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AdministeredDrug |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | administrationTagId |
Name Expression | |
Namespace | AdministeredDrug |
Opposite | |
Owner | AdministeredDrug |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::AdministeredDrug::administrationTagId |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
pharmacyManufacturedProduct
Public LocallyManufacturedProduct pharmacyManufacturedProduct
-
Pointer to a product that was created by a pharmacist or by a clinician by compounding two or more ingredients which was then administered to the Patient.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | administeredDrug_pharmacyManufacturedProduct |
Association End | |
Class | AdministeredDrug |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | pharmacyManufacturedProduct |
Name Expression | |
Namespace | AdministeredDrug |
Opposite | |
Owner | AdministeredDrug |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::AdministeredDrug::pharmacyManufacturedProduct |
Stereotype | |
Template Parameter | |
Type | LocallyManufacturedProduct |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
productInstance
Public MedicinalProductInstance productInstance
-
Identifies the medicinal product administered.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | administeredDrug_productInstance |
Association End | |
Class | AdministeredDrug |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | productInstance |
Name Expression | |
Namespace | AdministeredDrug |
Opposite | |
Owner | AdministeredDrug |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::AdministeredDrug::productInstance |
Stereotype | |
Template Parameter | |
Type | MedicinalProductInstance |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| CommonProduct UML Documentation |