BehavioralHealth
Class EncounterReference

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, EpisodeOfCareReference
Note 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 authorization
EpisodeOfCareCompletion completionStatus completionStatus

"Specifies how/why the episode of care was completed." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.completionStatus

«CS» Code encounterType encounterType

"Identifies whether an encounter is an Inpatient or Outpatient/Ambulatory." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.encounterType
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 AbstractEncounter.encounterClass.

«TS» PointInTime endDate 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.endDate
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 AbstractEncounter.duration.

SubmissionTrigger episodeOfCareStatus 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 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 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.providerOrganization
Note 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 startDate

"The date/time when the episode of care started." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.startDate
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 AbstractEncounter.duration.

TreatmentParticipation treatmentParticipationQualifier 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 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 Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameEncounterReference
Name Expression
NamespaceBehavioralHealth
Owned Template Signature
OwnerBehavioralHealth
Owning Template Parameter
PackageBehavioralHealth
Qualified NameFHIM::BehavioralHealth::EncounterReference
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 authorization
Public Authorization authorization
Constraints:
Properties:

AggregationNone
Alias
AssociationencounterReference_authorization
Association End
ClassEncounterReference
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
Nameauthorization
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::authorization
Stereotype
Template Parameter
TypeAuthorization
Upper1
Upper Value(1)
VisibilityPublic


 completionStatus
Public EpisodeOfCareCompletion completionStatus

"Specifies how/why the episode of care was completed." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.completionStatus

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NamecompletionStatus
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::completionStatus
Stereotype
Template Parameter
TypeEpisodeOfCareCompletion
Upper1
Upper Value(1)
VisibilityPublic


 encounterType
Public «CS» Code encounterType

"Identifies whether an encounter is an Inpatient or Outpatient/Ambulatory." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.encounterType
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 AbstractEncounter.encounterClass.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NameencounterType
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::encounterType
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 endDate
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.endDate
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 AbstractEncounter.duration.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NameendDate
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::endDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 episodeOfCareStatus
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NameepisodeOfCareStatus
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::episodeOfCareStatus
Stereotype
Template Parameter
TypeSubmissionTrigger
Upper1
Upper Value(1)
VisibilityPublic


 episodeOfCareType
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NameepisodeOfCareType
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::episodeOfCareType
Stereotype
Template Parameter
TypeEpisodeOfCareType
Upper1
Upper Value(1)
VisibilityPublic


 providerOrganization
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.providerOrganization
Note 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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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..*
NameproviderOrganization
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::providerOrganization
Stereotype
Template Parameter
TypeOrganizationalProvider
Upper*
Upper Value(*)
VisibilityPublic


 startDate
Public «TS» PointInTime startDate

"The date/time when the episode of care started." - HL7 Behavioral Health Record DAM R2, EpisodeOfCareReference.startDate
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 AbstractEncounter.duration.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NamestartDate
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::startDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 treatmentParticipationQualifier
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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
NametreatmentParticipationQualifier
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::treatmentParticipationQualifier
Stereotype
Template Parameter
TypeTreatmentParticipation
Upper1
Upper Value(1)
VisibilityPublic


 treatmentServicesRendered
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassEncounterReference
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..*
NametreatmentServicesRendered
Name Expression
NamespaceEncounterReference
Opposite
OwnerEncounterReference
Owning Association
Owning Template Parameter
Qualified NameFHIM::BehavioralHealth::EncounterReference::treatmentServicesRendered
Stereotype
Template Parameter
TypeTreatmentService
Upper*
Upper Value(*)
VisibilityPublic