BehavioralHealth
Class BehavioralHealthClient

This class represents a specialization of the Patient role declared in the FHIM Person Demographics domain in which Behavioral Health specific properties are added.
"This domain refers to the client - the person who receives, or has received, Behavioral Health services and contains the core set of demographic information to be exchanged." - HL7 Behavioral Health Record DAM R2, Client
Note that the Client class in the BH DAM contains a number of properties that the FHIM has modeled in other domains, in this case Person. These properties are included for completeness, but are marked as derivied as they would be retreived from the Person or Patient classes.

Attributes
BehavioralHealthCategory behavioralHealthCategory behavioralHealthCategory

"This optional data element is used to classify clients into categories that help identify clients that may be eligible for integrated services coordination. This classification is state-specific and rules-based on various client characteristics such as age, functional impairment category, problems/diagnoses, etc. This data element is derived from information about the client's age, functional impairment category, and problems. In order to be placed into a specific category, the client must have one of the qualifying diagnoses and functional impairment for that age group (e.g. under 18 of age, 18 years and older). The starter BehavioralHealthCategory value set includes five possible designations (i.e., child non-SED, child with SED, adult with SMI, adult non-SMI with general mental health need and adult non-SMI with substance abuse) which are assigned to each client enrolled in the state behavioral health system. The problems that identify Severe Emotional Disturbed and Severely Mentally Ill are drawn in the Severe Emotionally Disturbed and Severely Mentally Ill value sets." - HL7 Behavioral Health Record DAM R2, Client.behavioralHealthCategory

String clientType clientType

"Captures information related to various clients. e.g.: CriminalJustice, Post-Partum and Pregnant Women, Substance Abuse women etc." - HL7 Behavioral Health Record DAM R2, Client.clientType

«TS» PointInTime dateOfBirth dateOfBirth

"The client’s date of birth." - HL7 Behavioral Health Record DAM R2, Client.dateOfBirth
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from BiologicalEntity.dateOfBirth.

DependentChild dependentChild dependentChild
OMHDisabilityStatus disabilityStatus disabilityStatus

"Conveys information related to the disability status for a Behavioral Health client." - HL7 Behavioral Health Record DAM R2, Client.disabilityStatus

effectiveTime effectiveTime

"The effective date of any addition or change to the demographic fields of a client." - HL7 Behavioral Health Record DAM R2, Client.effectiveTime

OMHEthnicity ethnicity ethnicity

"The ethnicity specified by the client and uses the Office of Minority Health data standards-based OMHEthnicityCodeValueSet. These codes are often referred to as OMB since they are under the Office of Management and Budget (OMB) data collection standards. This is a required element and more than one ethnicity code may be specified, up to six times." - HL7 Behavioral Health Record DAM R2, Client.ethnicityCode
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.ethnicity.

«CS» Code gender gender

"The sex of the patient for demographic data collection purposes as well as to provide a high-level classification that can be used for the appropriate allocation of inpatient bed assignment. This element is frequently called Administrative Gender." - HL7 Behavioral Health Record DAM R2, Client.gender.
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.administrativeGender.

«CS» Code genderIdentity genderIdentity

"The client's gender identity, otherwise known as core gender identity, and refers to how the client self-identifies. It is not based on the person's anatomy." - HL7 Behavioral Health Record DAM R2, Client.genderIdentity
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.genderIdentity.

«CS» Code languageAbilityMode languageAbilityMode

"The client's ability with language." - HL7 Behavioral Health Record DAM R2, Client.languageAbilityMode
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.languageCapability.methodOfExpression.

«CS» Code languageAbilityProficiency languageAbilityProficiency

"The client's proficiency with his or her declared preferred language." - HL7 Behavioral Health Record DAM R2, Client.languageAbilityProficiency
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.languageCapability.proficiencyLevel.

«CS» Code maritalStatus maritalStatus

"The client's current domestic partnership status." - HL7 Behavioral Health Record DAM R2, Client.maritalStatus
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.maritalStatus.

«PN» PersonName patientName patientName

"The full name of the client." - HL7 Behavioral Health Record DAM R2, Client.patientName
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.personName.

«CS» Code preferredLanguage preferredLanguage

"The preferred language spoken by the client. This information is required by the United States Meaningful Use electronic health record incentive program." - HL7 Behavioral Health Record DAM R2, Client.preferredLanguage
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.languageCapability.language (where isPreferred is True).

«CS» Code race race

"The race specified by the client. This is a required element and more than one race code may be specified." - HL7 Behavioral Health Record DAM R2, Client.raceCode
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.race.

«CS» Code sexualOrientation sexualOrientation

"An enduring pattern, or lack thereof, of a romantic, sexual, and/or emotional attraction to men, women, or all genders." - HL7 Behavioral Health Record DAM R2, Client.sexualOrientation
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.sexualOrientation

Attributes inherited from FHIM::PublicHealthReporting::PublicHealthClient FHIM::PublicHealthReporting::PublicHealthClient
clientIdentifier clientIdentifier, beginDate beginDate, endDate endDate, patient patient, publicHealthJurisdiction publicHealthJurisdiction, status status

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameBehavioralHealthClient
Name Expression
NamespaceBehavioralHealth
Owned Template Signature
OwnerBehavioralHealth
Owning Template Parameter
PackageBehavioralHealth
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 behavioralHealthCategory
Public BehavioralHealthCategory behavioralHealthCategory

"This optional data element is used to classify clients into categories that help identify clients that may be eligible for integrated services coordination. This classification is state-specific and rules-based on various client characteristics such as age, functional impairment category, problems/diagnoses, etc. This data element is derived from information about the client's age, functional impairment category, and problems. In order to be placed into a specific category, the client must have one of the qualifying diagnoses and functional impairment for that age group (e.g. under 18 of age, 18 years and older). The starter BehavioralHealthCategory value set includes five possible designations (i.e., child non-SED, child with SED, adult with SMI, adult non-SMI with general mental health need and adult non-SMI with substance abuse) which are assigned to each client enrolled in the state behavioral health system. The problems that identify Severe Emotional Disturbed and Severely Mentally Ill are drawn in the Severe Emotionally Disturbed and Severely Mentally Ill value sets." - HL7 Behavioral Health Record DAM R2, Client.behavioralHealthCategory

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
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
NamebehavioralHealthCategory
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::behavioralHealthCategory
Stereotype
Template Parameter
TypeBehavioralHealthCategory
Upper1
Upper Value(1)
VisibilityPublic


 clientType
Public String clientType

"Captures information related to various clients. e.g.: CriminalJustice, Post-Partum and Pregnant Women, Substance Abuse women etc." - HL7 Behavioral Health Record DAM R2, Client.clientType

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
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
NameclientType
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::clientType
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 dateOfBirth
Public «TS» PointInTime dateOfBirth

"The client’s date of birth." - HL7 Behavioral Health Record DAM R2, Client.dateOfBirth
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from BiologicalEntity.dateOfBirth.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamedateOfBirth
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::dateOfBirth
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dependentChild
Public DependentChild dependentChild
Constraints:
Properties:

AggregationNone
Alias
AssociationbehavioralHealthClient_dependentChild
Association End
ClassBehavioralHealthClient
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*
NamedependentChild
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::dependentChild
Stereotype
Template Parameter
TypeDependentChild
Upper*
Upper Value(*)
VisibilityPublic


 disabilityStatus
Public OMHDisabilityStatus disabilityStatus

"Conveys information related to the disability status for a Behavioral Health client." - HL7 Behavioral Health Record DAM R2, Client.disabilityStatus

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
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*
NamedisabilityStatus
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::disabilityStatus
Stereotype
Template Parameter
TypeOMHDisabilityStatus
Upper*
Upper Value(*)
VisibilityPublic


 effectiveTime
Public  effectiveTime

"The effective date of any addition or change to the demographic fields of a client." - HL7 Behavioral Health Record DAM R2, Client.effectiveTime

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
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
NameeffectiveTime
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::effectiveTime
Stereotype
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 ethnicity
Public OMHEthnicity ethnicity

"The ethnicity specified by the client and uses the Office of Minority Health data standards-based OMHEthnicityCodeValueSet. These codes are often referred to as OMB since they are under the Office of Management and Budget (OMB) data collection standards. This is a required element and more than one ethnicity code may be specified, up to six times." - HL7 Behavioral Health Record DAM R2, Client.ethnicityCode
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.ethnicity.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..6
Nameethnicity
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::ethnicity
Stereotype
Template Parameter
TypeOMHEthnicity
Upper6
Upper Value(6)
VisibilityPublic


 gender
Public «CS» Code gender

"The sex of the patient for demographic data collection purposes as well as to provide a high-level classification that can be used for the appropriate allocation of inpatient bed assignment. This element is frequently called Administrative Gender." - HL7 Behavioral Health Record DAM R2, Client.gender.
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.administrativeGender.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namegender
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::gender
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 genderIdentity
Public «CS» Code genderIdentity

"The client's gender identity, otherwise known as core gender identity, and refers to how the client self-identifies. It is not based on the person's anatomy." - HL7 Behavioral Health Record DAM R2, Client.genderIdentity
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.genderIdentity.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamegenderIdentity
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::genderIdentity
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 languageAbilityMode
Public «CS» Code languageAbilityMode

"The client's ability with language." - HL7 Behavioral Health Record DAM R2, Client.languageAbilityMode
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.languageCapability.methodOfExpression.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamelanguageAbilityMode
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::languageAbilityMode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 languageAbilityProficiency
Public «CS» Code languageAbilityProficiency

"The client's proficiency with his or her declared preferred language." - HL7 Behavioral Health Record DAM R2, Client.languageAbilityProficiency
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.languageCapability.proficiencyLevel.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..2
NamelanguageAbilityProficiency
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::languageAbilityProficiency
Stereotype
Template Parameter
Type«CS» Code
Upper2
Upper Value(2)
VisibilityPublic


 maritalStatus
Public «CS» Code maritalStatus

"The client's current domestic partnership status." - HL7 Behavioral Health Record DAM R2, Client.maritalStatus
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.maritalStatus.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamemaritalStatus
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::maritalStatus
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 patientName
Public «PN» PersonName patientName

"The full name of the client." - HL7 Behavioral Health Record DAM R2, Client.patientName
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.personName.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamepatientName
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::patientName
Stereotype
Template Parameter
Type«PN» PersonName
Upper1
Upper Value(1)
VisibilityPublic


 preferredLanguage
Public «CS» Code preferredLanguage

"The preferred language spoken by the client. This information is required by the United States Meaningful Use electronic health record incentive program." - HL7 Behavioral Health Record DAM R2, Client.preferredLanguage
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.languageCapability.language (where isPreferred is True).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepreferredLanguage
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::preferredLanguage
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 race
Public «CS» Code race

"The race specified by the client. This is a required element and more than one race code may be specified." - HL7 Behavioral Health Record DAM R2, Client.raceCode
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.race.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
Namerace
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::race
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 sexualOrientation
Public «CS» Code sexualOrientation

"An enduring pattern, or lack thereof, of a romantic, sexual, and/or emotional attraction to men, women, or all genders." - HL7 Behavioral Health Record DAM R2, Client.sexualOrientation
Note that this property is included here because it is a part of the Behavioral Health Report, but is marked as derived, because this data is retreived from Person.sexualOrientation

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBehavioralHealthClient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamesexualOrientation
Name Expression
NamespaceBehavioralHealthClient
Opposite
OwnerBehavioralHealthClient
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::BehavioralHealthClient::sexualOrientation
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic