| BehavioralHealth UML Documentation |
BehavioralHealth
Class BehavioralHealthSummaryReport
This class specifies the summary report intended to exchange selected information relevant across specialties. It may not include the details of an assessment but it will contain many data elements that are based on the information collected through the assessment and generated from its processing."This class represents a summary document for Behavioral Health exchange. For example, this could be in the form of a Continuity of Care document (CCD). It specifies the global characteristics of the record - the date when it was created, submitted, or revised and resubmitted. It contains other information organized into header and sections." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport
Attributes |
BehavioralHealthClient | behavioralHealthClient |
Pointer to the Client (Patient) whose data is included in the Behavioral Health Summary Report. The behavioral health client provides additional information to that stored with the normal Patient role.
|
CarePlanDetails | carePlanSection | |
CaseManager | caseManager |
Pointer to the provider who is acting as the Case Manager for the Client (Patient) during the referenced episode of care.
|
ConfidentialityType | confidentialityCode |
This attribute is used to specify that the content of this clinical document is sensitive because it contains Behavioral Health information. This attribute corresponds to the Act.confidentialityCode in the HL7 Version 3 RIM but is constrained to specify sensitivity and for the purpose of data segmentation."Classifies the Behavioral Health report as a restricted report, and uses the Confidentiality value set. Confidentiality represents the privacy metadata indicating the sender's sensitivity classification, which is based on an analysis of applicable privacy policies and the risk of harm that could result from unauthorized disclosure." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.confidentialityCode
|
EncounterReference | encounterSection |
Pointer to the episode of care which triggered or is referenced by the Behavioral Health Summary Report.
|
FamilyHistory | familyHistorySection | |
String | initialIntakeEnrollment |
Indicates whether or not the patient enrolled in the treatment program as recommended."Captures the confirmation of the initial enrollment in the treatment [program], or failure to report to the treatment program. Treatment providers may send confirmation of initial enrollment in the treatment to the supervision agency." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.initialIntakeEnrollment
|
ProblemsSection | problemsSection | |
Procedure | proceduresSection | |
«TS» PointInTime | referralDate |
"The date when the regional authority or provider received a referral for service. A referral includes an oral, written, faxed or electronic request for services made by the client or on the client’s behalf." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.referralDate
|
ReferralSource | referralSource |
"This data element refers to the source of referral for this behavioral health episode of care. Referral source is an administrative concept that is highly correlated with billing, and therefore is appropriate to use for information that is captured at the point of service within the normal workflow. As social services become more tightly integrated into the health care delivery process, it may become necessary to enhance the billing code sets currently being used. This data element is used to describe the source of the referral. This element uses the ReferralSource value set." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.referralSource
|
ResultsSection | resultsSection | |
ReviewOfSystemsSection | reviewOfSystemsSection | |
SocialHistory | socialHistorySection | |
Attributes inherited from FHIM::PublicHealthReporting::NotificationReport |
alertDateTime, careGiver, encounterEvent, exposure, kind, medicationHistory, moreInformationlProvider, pregnancyStatus, receivingOrganization, replacesDocumentId, reportCreatedBy, reportDateTime, reportId, reportingOrganization, reportingSystem, reportSentBy, reportSentTo, reportSubject, sendingSystem, serviceDeliveryLocation, status, transmissionDateTime |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | BehavioralHealthSummaryReport |
Name Expression | |
Namespace | BehavioralHealth |
Owned Template Signature | |
Owner | BehavioralHealth |
Owning Template Parameter | |
Package | BehavioralHealth |
Qualified Name | FHIM::BehavioralHealth::BehavioralHealthSummaryReport |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
behavioralHealthClient
Public BehavioralHealthClient behavioralHealthClient
-
Pointer to the Client (Patient) whose data is included in the Behavioral Health Summary Report. The behavioral health client provides additional information to that stored with the normal Patient role.
-
Constraints:
-
Properties:
-
carePlanSection
Public CarePlanDetails carePlanSection
-
Constraints:
-
Properties:
-
caseManager
Public CaseManager caseManager
-
Pointer to the provider who is acting as the Case Manager for the Client (Patient) during the referenced episode of care.
-
Constraints:
-
Properties:
-
confidentialityCode
Public ConfidentialityType confidentialityCode
-
This attribute is used to specify that the content of this clinical document is sensitive because it contains Behavioral Health information. This attribute corresponds to the Act.confidentialityCode in the HL7 Version 3 RIM but is constrained to specify sensitivity and for the purpose of data segmentation."Classifies the Behavioral Health report as a restricted report, and uses the Confidentiality value set. Confidentiality represents the privacy metadata indicating the sender's sensitivity classification, which is based on an analysis of applicable privacy policies and the risk of harm that could result from unauthorized disclosure." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.confidentialityCode
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BehavioralHealthSummaryReport |
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 | confidentialityCode |
Name Expression | |
Namespace | BehavioralHealthSummaryReport |
Opposite | |
Owner | BehavioralHealthSummaryReport |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::BehavioralHealthSummaryReport::confidentialityCode |
Stereotype | |
Template Parameter | |
Type | ConfidentialityType |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
encounterSection
Public EncounterReference encounterSection
-
Pointer to the episode of care which triggered or is referenced by the Behavioral Health Summary Report.
-
Constraints:
-
Properties:
-
familyHistorySection
Public FamilyHistory familyHistorySection
-
Constraints:
-
Properties:
-
initialIntakeEnrollment
Public String initialIntakeEnrollment
-
Indicates whether or not the patient enrolled in the treatment program as recommended."Captures the confirmation of the initial enrollment in the treatment [program], or failure to report to the treatment program. Treatment providers may send confirmation of initial enrollment in the treatment to the supervision agency." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.initialIntakeEnrollment
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BehavioralHealthSummaryReport |
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 | initialIntakeEnrollment |
Name Expression | |
Namespace | BehavioralHealthSummaryReport |
Opposite | |
Owner | BehavioralHealthSummaryReport |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::BehavioralHealthSummaryReport::initialIntakeEnrollment |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
problemsSection
Public ProblemsSection problemsSection
-
Constraints:
-
Properties:
-
proceduresSection
Public Procedure proceduresSection
-
Constraints:
-
Properties:
-
referralDate
Public «TS» PointInTime referralDate
-
"The date when the regional authority or provider received a referral for service. A referral includes an oral, written, faxed or electronic request for services made by the client or on the client’s behalf." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.referralDate
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BehavioralHealthSummaryReport |
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 | referralDate |
Name Expression | |
Namespace | BehavioralHealthSummaryReport |
Opposite | |
Owner | BehavioralHealthSummaryReport |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::BehavioralHealthSummaryReport::referralDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
referralSource
Public ReferralSource referralSource
-
"This data element refers to the source of referral for this behavioral health episode of care. Referral source is an administrative concept that is highly correlated with billing, and therefore is appropriate to use for information that is captured at the point of service within the normal workflow. As social services become more tightly integrated into the health care delivery process, it may become necessary to enhance the billing code sets currently being used. This data element is used to describe the source of the referral. This element uses the ReferralSource value set." - HL7 Behavioral Health Record DAM R2, BehavioralHealthReport.referralSource
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BehavioralHealthSummaryReport |
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 | referralSource |
Name Expression | |
Namespace | BehavioralHealthSummaryReport |
Opposite | |
Owner | BehavioralHealthSummaryReport |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::BehavioralHealthSummaryReport::referralSource |
Stereotype | |
Template Parameter | |
Type | ReferralSource |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
resultsSection
Public ResultsSection resultsSection
-
Constraints:
-
Properties:
-
reviewOfSystemsSection
Public ReviewOfSystemsSection reviewOfSystemsSection
-
Constraints:
-
Properties:
-
socialHistorySection
Public SocialHistory socialHistorySection
-
Constraints:
-
Properties:
-
| BehavioralHealth UML Documentation |