|
| BehavioralHealth UML Documentation |
BehavioralHealth
Class SubstanceOfAbuseDisorder
"Information related to each diagnosis associated with a substance of abuse disorder recorded for the client. This information may repeat several times depending on how many substance use. abuse, or addiction problems affect the patient." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder
| Attributes |
| Integer |  ageOfFirstUse |
"The age of the client when the client started using the substance of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.ageOfFirstUse
|
| Boolean | currentSubstanceOfAbuseIndicator |
"Indicates that this substance is currently being used by the client." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.currentSubstanceOfAbuseIndicator
|
| «TS» PointInTime | dateLastUsed |
"The date that the client reports to have last used this substance of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.dateLastUsed
|
| «RTO» RateQuantity | frequency |
"The frequency of use of the substance of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.frequency
|
| «IVL_TS» TimeInterval | periodOfUse |
"An interval of time in which the client reports to have used the substance. More than one interval of time may be reported." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.periodOfUse
|
| RouteOfAdministration | route |
"The route of administration that the client uses for the substances of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.route
|
| SubstanceOfAbuse | substanceAbuseDisorderCode |
"The substance of abuse" - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.substanceAbuseDisorderCode
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | SubstanceOfAbuseDisorder |
| Name Expression | |
| Namespace | BehavioralHealth |
| Owned Template Signature | |
| Owner | BehavioralHealth |
| Owning Template Parameter | |
| Package | BehavioralHealth |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
ageOfFirstUse
Public Integer ageOfFirstUse
-
"The age of the client when the client started using the substance of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.ageOfFirstUse
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | ageOfFirstUse |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::ageOfFirstUse |
| Stereotype | |
| Template Parameter | |
| Type | Integer |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
currentSubstanceOfAbuseIndicator
Public Boolean currentSubstanceOfAbuseIndicator
-
"Indicates that this substance is currently being used by the client." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.currentSubstanceOfAbuseIndicator
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | currentSubstanceOfAbuseIndicator |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::currentSubstanceOfAbuseIndicator |
| Stereotype | |
| Template Parameter | |
| Type | Boolean |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
dateLastUsed
Public «TS» PointInTime dateLastUsed
-
"The date that the client reports to have last used this substance of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.dateLastUsed
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | dateLastUsed |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::dateLastUsed |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
frequency
Public «RTO» RateQuantity frequency
-
"The frequency of use of the substance of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.frequency
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | frequency |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::frequency |
| Stereotype | |
| Template Parameter | |
| Type | «RTO» RateQuantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
periodOfUse
Public «IVL_TS» TimeInterval periodOfUse
-
"An interval of time in which the client reports to have used the substance. More than one interval of time may be reported." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.periodOfUse
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | periodOfUse |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::periodOfUse |
| Stereotype | |
| Template Parameter | |
| Type | «IVL_TS» TimeInterval |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
route
Public RouteOfAdministration route
-
"The route of administration that the client uses for the substances of abuse." - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.route
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | route |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::route |
| Stereotype | |
| Template Parameter | |
| Type | RouteOfAdministration |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
substanceAbuseDisorderCode
Public SubstanceOfAbuse substanceAbuseDisorderCode
-
"The substance of abuse" - HL7 Behavioral Health Record DAM R2, SubstanceOfAbuseDisorder.substanceAbuseDisorderCode
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SubstanceOfAbuseDisorder |
| 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 | substanceAbuseDisorderCode |
| Name Expression | |
| Namespace | SubstanceOfAbuseDisorder |
| Opposite | |
| Owner | SubstanceOfAbuseDisorder |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::BehavioralHealth::SubstanceOfAbuseDisorder::substanceAbuseDisorderCode |
| Stereotype | |
| Template Parameter | |
| Type | SubstanceOfAbuse |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
|
| BehavioralHealth UML Documentation |