| BehavioralHealth UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class represents the data elements found in the Encounter section of the Behavioral Health Summary Report."The main visit or episode of care documented by a behavioral health report. An episode of care is defined as the period between the beginning and end of Behavioral Health services treatment for an individual. Within an episode of care, a person may transfer to a different service, facility, program or location. The beginning and end of an episode of care is marked by a demographic file submission. Over time, an individual may have multiple episodes of care. In addition, an episode may represent the start and end of a Crisis event." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReferenceNote that the EpisodeOfCareReference class in the BH DAM contains a number of properties that the FHIM has modeled in other domains, in this case Encounters. These properties are included for completeness, but are marked as derivied as they would be retreived from the Person or Encounter classes.
Attributes | ||
Authorization | authorization | |
EpisodeOfCareCompletion | completionStatus |
"Specifies how/why the episode of care was completed." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.completionStatus |
«CS» Code | encounterType |
"Identifies whether an encounter is an Inpatient or Outpatient/Ambulatory." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.encounterTypeNote 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 AbstractEncounter.encounterClass. |
«TS» PointInTime | endDate |
"The date/time when the episode of care ended. This is an optional data element since the exchange may occur before the end of the episode of care." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.endDateNote 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 AbstractEncounter.duration. |
SubmissionTrigger | episodeOfCareStatus |
"The reason or trigger for the document submission. It reflects the state of the encounter and type of assessment (e.g. new episode start, full assessment, episode end, crisis and correction/update) at the time the report is transmitted." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.episodeOfCareStatus |
EpisodeOfCareType | episodeOfCareType |
"The type of encounter represented by this data exchange: Crisis or Routine. These reports may be treated differently based on the type of encounter by behavioral health programs. Along with submissionTrigger, this data element qualifies the reason for submission by providing the context of the encounter." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.episodeOfCareType |
OrganizationalProvider | providerOrganization |
"The organization delivering Behavioral Health services or that is reporting information about the client's episode of care." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.providerOrganizationNote that this property is included here because it is a part of the Behavioral Health Report, but it may possibly be derived, perhaps from the AbstractEncounter.scopingProvider, or if this organization is the same as the organization sending the report, from the Behavioral Healt Summmary Report reporting provider property. This property is not marked as derived because it is currently not clear if these possibilities are the same organization. |
«TS» PointInTime | startDate |
"The date/time when the episode of care started." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.startDateNote 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 AbstractEncounter.duration. |
TreatmentParticipation | treatmentParticipationQualifier |
"The manner in which a client participates in a Behavioral Health Episode of Care. A client may participate voluntarily, or due to a court order or conditions of parole or probation requiring the client to receive Behavioral Health services." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.treatmentParticipationQualifier |
TreatmentService | treatmentServicesRendered |
"The type of treatment services provided to Behavioral Health clients. At least one type of treatment service must be associated with the client at intake (admission) and at discharge." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.treatmentServicesRendered |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | EncounterReference |
Name Expression | |
Namespace | BehavioralHealth |
Owned Template Signature | |
Owner | BehavioralHealth |
Owning Template Parameter | |
Package | BehavioralHealth |
Qualified Name | FHIM::BehavioralHealth::EncounterReference |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public Authorization authorization
Aggregation | None |
Alias | |
Association | encounterReference_authorization |
Association End | |
Class | EncounterReference |
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 | authorization |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::authorization |
Stereotype | |
Template Parameter | |
Type | Authorization |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public EpisodeOfCareCompletion completionStatus
"Specifies how/why the episode of care was completed." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.completionStatus
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
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 | completionStatus |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::completionStatus |
Stereotype | |
Template Parameter | |
Type | EpisodeOfCareCompletion |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code encounterType
"Identifies whether an encounter is an Inpatient or Outpatient/Ambulatory." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.encounterTypeNote 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 AbstractEncounter.encounterClass.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
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 | encounterType |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::encounterType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime endDate
"The date/time when the episode of care ended. This is an optional data element since the exchange may occur before the end of the episode of care." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.endDateNote 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 AbstractEncounter.duration.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
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 | endDate |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::endDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public SubmissionTrigger episodeOfCareStatus
"The reason or trigger for the document submission. It reflects the state of the encounter and type of assessment (e.g. new episode start, full assessment, episode end, crisis and correction/update) at the time the report is transmitted." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.episodeOfCareStatus
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
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 | episodeOfCareStatus |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::episodeOfCareStatus |
Stereotype | |
Template Parameter | |
Type | SubmissionTrigger |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public EpisodeOfCareType episodeOfCareType
"The type of encounter represented by this data exchange: Crisis or Routine. These reports may be treated differently based on the type of encounter by behavioral health programs. Along with submissionTrigger, this data element qualifies the reason for submission by providing the context of the encounter." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.episodeOfCareType
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
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 | episodeOfCareType |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::episodeOfCareType |
Stereotype | |
Template Parameter | |
Type | EpisodeOfCareType |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public OrganizationalProvider providerOrganization
"The organization delivering Behavioral Health services or that is reporting information about the client's episode of care." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.providerOrganizationNote that this property is included here because it is a part of the Behavioral Health Report, but it may possibly be derived, perhaps from the AbstractEncounter.scopingProvider, or if this organization is the same as the organization sending the report, from the Behavioral Healt Summmary Report reporting provider property. This property is not marked as derived because it is currently not clear if these possibilities are the same organization.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
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 | providerOrganization |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::providerOrganization |
Stereotype | |
Template Parameter | |
Type | OrganizationalProvider |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime startDate
"The date/time when the episode of care started." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.startDateNote 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 AbstractEncounter.duration.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
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 | startDate |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::startDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public TreatmentParticipation treatmentParticipationQualifier
"The manner in which a client participates in a Behavioral Health Episode of Care. A client may participate voluntarily, or due to a court order or conditions of parole or probation requiring the client to receive Behavioral Health services." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.treatmentParticipationQualifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
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 | treatmentParticipationQualifier |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::treatmentParticipationQualifier |
Stereotype | |
Template Parameter | |
Type | TreatmentParticipation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public TreatmentService treatmentServicesRendered
"The type of treatment services provided to Behavioral Health clients. At least one type of treatment service must be associated with the client at intake (admission) and at discharge." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.treatmentServicesRendered
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | EncounterReference |
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 | treatmentServicesRendered |
Name Expression | |
Namespace | EncounterReference |
Opposite | |
Owner | EncounterReference |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::BehavioralHealth::EncounterReference::treatmentServicesRendered |
Stereotype | |
Template Parameter | |
Type | TreatmentService |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| BehavioralHealth UML Documentation |
Summary:AttributesProperties | Detail:Attributes |