| CommonProduct UML Documentation |
Summary:AttributesCommentsProperties | Detail:Attributes |
Substance: "The tangible matter of which a thing consists; a specific type of matter, esp. a homogeneous material with a definite composition." - Collins English DictionaryThis class represents a substance, either manufactured or found naturally, which might be referenced by clinical records. This class may represent ingredients in a medication, a substance to which the patient was exposed or which the patient consumes, or an analyte, among many other potential uses."The Substance entity is used to describe any material that functions as an ingredient of the Medicine." - HL7 Version 3."The actual ingredient - either a substance (simple ingredient) or another medication." - HL7 FHIR, Medication.ingredient.item[x]"A homogeneous material with a definite composition." - HL7 FHIR, Substance
Attributes | ||
«CS» Code | category |
"A code that classifies the general type of substance. This is used for searching, sorting and display purposes." - HL7 FHIR, Substance.category |
String | description |
"A description of the substance - its appearance, handling requirements, and other usage notes." - HL7 FHIR, Substance.description |
«II» Id | identifier |
"Unique identifier for the substance." - HL7 FHIR, Substance.identifier |
«CS» Code | kind |
A code that identifies the substance.When used as an ingredient in a drug or food in the United States, this code should be a UNII code (Unique Ingredient Identifier), which is issued by FDA."A code (or set of codes) that identify this substance." - HL7 FHIR, Substance.code"The actual ingredient - either a substance (simple ingredient) or another medication." - HL7 FHIR, Medication.ingredient.item[x] |
«CS» Code | status |
"A code to indicate if the substance is actively used." - HL7 FHIR, Substance.status |
SubstanceIngredient | substanceIngredient |
"A substance can be composed of other substances." - HL7 FHIR, Substance.ingredient |
SubstanceInstance | substanceInstance |
"Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance." - HL7 FHIR, Substance.instance |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Substance |
Name Expression | |
Namespace | CommonProduct |
Owned Template Signature | |
Owner | CommonProduct |
Owning Template Parameter | |
Package | CommonProduct |
Qualified Name | FHIM::CommonProduct::Substance |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «CS» Code category
"A code that classifies the general type of substance. This is used for searching, sorting and display purposes." - HL7 FHIR, Substance.category
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Substance |
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 | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::category |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String description
"A description of the substance - its appearance, handling requirements, and other usage notes." - HL7 FHIR, Substance.description
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Substance |
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 | description |
Name Expression | |
Namespace | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «II» Id identifier
"Unique identifier for the substance." - HL7 FHIR, Substance.identifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Substance |
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 | identifier |
Name Expression | |
Namespace | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code kind
A code that identifies the substance.When used as an ingredient in a drug or food in the United States, this code should be a UNII code (Unique Ingredient Identifier), which is issued by FDA."A code (or set of codes) that identify this substance." - HL7 FHIR, Substance.code"The actual ingredient - either a substance (simple ingredient) or another medication." - HL7 FHIR, Medication.ingredient.item[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Substance |
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 | kind |
Name Expression | |
Namespace | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::kind |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
"A code to indicate if the substance is actively used." - HL7 FHIR, Substance.status
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Substance |
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 | status |
Name Expression | |
Namespace | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public SubstanceIngredient substanceIngredient
"A substance can be composed of other substances." - HL7 FHIR, Substance.ingredient
Aggregation | None |
Alias | |
Association | substance_substanceIngredient |
Association End | |
Class | Substance |
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 | substanceIngredient |
Name Expression | |
Namespace | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::substanceIngredient |
Stereotype | |
Template Parameter | |
Type | SubstanceIngredient |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public SubstanceInstance substanceInstance
"Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance." - HL7 FHIR, Substance.instance
Aggregation | None |
Alias | |
Association | substance_substanceInstance |
Association End | |
Class | Substance |
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 | substanceInstance |
Name Expression | |
Namespace | Substance |
Opposite | |
Owner | Substance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::Substance::substanceInstance |
Stereotype | |
Template Parameter | |
Type | SubstanceInstance |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Comments |
| CommonProduct UML Documentation |
Summary:AttributesCommentsProperties | Detail:Attributes |