CommonProduct
Class Substance

Substance: "The tangible matter of which a thing consists; a specific type of matter, esp. a homogeneous material with a definite composition." - Collins English Dictionary
This 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 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 description

"A description of the substance - its appearance, handling requirements, and other usage notes." - HL7 FHIR, Substance.description

«II» Id identifier identifier

"Unique identifier for the substance." - HL7 FHIR, Substance.identifier

«CS» Code kind 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 status

"A code to indicate if the substance is actively used." - HL7 FHIR, Substance.status

SubstanceIngredient substanceIngredient substanceIngredient

"A substance can be composed of other substances." - HL7 FHIR, Substance.ingredient

SubstanceInstance 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 Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameSubstance
Name Expression
NamespaceCommonProduct
Owned Template Signature
OwnerCommonProduct
Owning Template Parameter
PackageCommonProduct
Qualified NameFHIM::CommonProduct::Substance
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 category
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namecategory
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::category
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 description
Public String description

"A description of the substance - its appearance, handling requirements, and other usage notes." - HL7 FHIR, Substance.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedescription
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 identifier
Public «II» Id identifier

"Unique identifier for the substance." - HL7 FHIR, Substance.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameidentifier
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 kind
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]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namekind
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::kind
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

"A code to indicate if the substance is actively used." - HL7 FHIR, Substance.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namestatus
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 substanceIngredient
Public SubstanceIngredient substanceIngredient

"A substance can be composed of other substances." - HL7 FHIR, Substance.ingredient

Constraints:
Properties:

AggregationNone
Alias
Associationsubstance_substanceIngredient
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamesubstanceIngredient
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::substanceIngredient
Stereotype
Template Parameter
TypeSubstanceIngredient
Upper*
Upper Value(*)
VisibilityPublic


 substanceInstance
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

Constraints:
Properties:

AggregationNone
Alias
Associationsubstance_substanceInstance
Association End
ClassSubstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamesubstanceInstance
Name Expression
NamespaceSubstance
Opposite
OwnerSubstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Substance::substanceInstance
Stereotype
Template Parameter
TypeSubstanceInstance
Upper*
Upper Value(*)
VisibilityPublic

Comments