| CommonProduct UML Documentation |
CommonProduct
Class BiologicProduct
Biological products, also known as biologics, "replicate natural substances such as enzymes, antibodies, or hormones in our bodies. [They] can be composed of sugars, proteins, or nucleic acids, or a combination of these substances. They may also be living entities, such as cells and tissues. Biologics are made from a variety of natural resources - human, animal, and microorganism - and may be produced by biotechnology methods. Gene-based and cellular biologics... may make it possible to treat a variety of medical conditions, including illnesses for which no other treatments are available." - FDA 101"A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity." - HL7 FHIR, BiologicallyDerivedProduct. Note that the FHIR BiologicallyDerivedProduct resource combines both type-level and instance-level properties into a single resource; the FHIM separates these into two classes (BiologicProduct and BiologicProductInstance), which reference each other.
Attributes |
«CS» Code | availabilityStatus |
"Whether the product is currently available." Possible values are Available; Unavailable. - HL7 FHIR, BiologicallyDerivedProduct.status
|
BiologicProductInstance | biologicProductInstance |
Pointer to instances of a Biologic Product, which can usually be individually identified, or identified by a lot number.
|
RequestedBiologic | biologicRequest |
Pointer to the request (Order) in which this Biologic Product Instance was utilized.
|
«CS» Code | category |
"Broad category of this product." - HL7 FHIR, BiologicallyDerivedProduct.productCategory
|
Attributes inherited from FHIM::CommonProduct::Product |
brandName, description, equivalentTo, fdaProductCode, formCode, handlingCode, kind, manufacturer, riskCode, shelfLife, specializationOf, status |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | BiologicProduct |
Name Expression | |
Namespace | CommonProduct |
Owned Template Signature | |
Owner | CommonProduct |
Owning Template Parameter | |
Package | CommonProduct |
Qualified Name | FHIM::CommonProduct::BiologicProduct |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
availabilityStatus
Public «CS» Code availabilityStatus
-
"Whether the product is currently available." Possible values are Available; Unavailable. - HL7 FHIR, BiologicallyDerivedProduct.status
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BiologicProduct |
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 | availabilityStatus |
Name Expression | |
Namespace | BiologicProduct |
Opposite | |
Owner | BiologicProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::BiologicProduct::availabilityStatus |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
biologicProductInstance
Public BiologicProductInstance biologicProductInstance
-
Pointer to instances of a Biologic Product, which can usually be individually identified, or identified by a lot number.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | biologicProduct_biologicProductInstance |
Association End | |
Class | BiologicProduct |
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 | biologicProductInstance |
Name Expression | |
Namespace | BiologicProduct |
Opposite | biologicProduct |
Owner | BiologicProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::BiologicProduct::biologicProductInstance |
Stereotype | |
Template Parameter | |
Type | BiologicProductInstance |
Upper | * |
Upper Value | (*) |
Visibility | Public |
biologicRequest
Public RequestedBiologic biologicRequest
-
Pointer to the request (Order) in which this Biologic Product Instance was utilized.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | biologicRequest_biologicProduct |
Association End | |
Class | BiologicProduct |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | biologicRequest |
Name Expression | |
Namespace | BiologicProduct |
Opposite | biologicProduct |
Owner | BiologicProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::BiologicProduct::biologicRequest |
Stereotype | |
Template Parameter | |
Type | RequestedBiologic |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
category
Public «CS» Code category
-
"Broad category of this product." - HL7 FHIR, BiologicallyDerivedProduct.productCategory
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BiologicProduct |
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 | category |
Name Expression | |
Namespace | BiologicProduct |
Opposite | |
Owner | BiologicProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::BiologicProduct::category |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| CommonProduct UML Documentation |