|
| Encounter UML Documentation |
Encounter
Class EpisodeOfCare
A collection of encounters that can be aggregated based on a common clinically relevant factor such as the provider, diagnosis, health factor, or long-term problem."...a Service Episode is the context in which the treatment or management of an arbitrary subset of a Patient s medical conditions occurs. The definition of the start time, stop time, and included events of a Service Episode is entirely arbitrary; it may include a single outpatient visit or a hospitalization, or extend over significant period of time, e.g., the duration of a pregnancy, or an oncology treatment regimen, or a cardiac episode from infarction through rehabilitation. A Service Episode may involve one or more Healthcare Organizations." - HL7 Version 2.8, PV1-53
| Attributes |
| AbstractEncounter |  abstractEncounter | |
| «II» Id | accountId |
"The set of accounts that may be used for billing for this EpisodeOfCare." - HL7 FHIR, EpisodeOfCare.account
|
| PractitionerParticipation | careManager |
"The practitioner that is the care manager/care co-ordinator for this patient." - HL7 FHIR, EpisodeOfCare.careManager
|
| CareProtocol | careProtocol |
TA proposed or tentative course of action for the maintenance and restoration of health by the treatment and prevention of disease by trained and licensed professionals.
|
| CareTeamMember | careTeamMember |
Pointer to Practitioner(s) who make up a team comprising multiple disciplines in order to provide holistic care for the patient."The list of practitioners that may be facilitating this episode of care for specific purposes." - HL7 FHIR, EpisodeOfCare.team
|
| «CS» Code | category |
"A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care." - HL7 FHIR, EpisodeOfCare.type
|
| String | description |
"A brief user-defined description of a Service Episode in or for which the visit occurs. A Service Episode is the context in which the treatment or management of an arbitrary subset of a Patient s medical conditions occurs. The definition of the start time, stop time, and included events of a Service Episode is entirely arbitrary; it may include a single outpatient visit or a hospitalization, or extend over significant period of time, e.g., the duration of a pregnancy, or an oncology treatment regimen, or a cardiac episode from infarction through rehabilitation. A Service Episode may involve one or more Healthcare Organizations." - HL7 Version 2.8, PV1-53
|
| DiagnosisListEntry | diagnosisList |
Pointer to a list of one or more diagnosis(es) for which the Patient is being treated during the Episode Of Care."The list of diagnosis relevant to this episode of care." - HL7 FHIR, EpisodeOfCare.diagnosis
|
| DiagnosisGroupingEvent | diagnosisRelatedGroup |
Provides the diagnosis grouping for the diagnosis/s provide for the patients visit
|
| «IVL_TS» Period | duration |
This property contains the date/times that the EpisodeOfCare began and ended. If the episode of care is currently active, the end date/time may be blank. Note that this property could potentially be calculated based on the start and end date/times of the constituent Encounters, therefore this property has been marked as derived."The interval during which the managing organization assumes the defined responsibility." - HL7 FHIR, EpisodeOfCare.period
|
| «II» Id | identifier |
This property uniquely identifies an instance of this Episode of Care class."Contains the identifier of a Service Episode in or for which the visit occurs." - HL7 Version 2.8, PV1-54 "The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes." - HL7 FHIR, EpisodeOfCare.identifier
|
| HealthcareProvider | managingOrganization |
Pointer to the HealthcareProvider organization that is managing the EpisodeOfCare."The organization that has assumed the specific responsibilities for the specified duration." - HL7 FHIR, EpisodeOfCare.managingOrganization
|
| Patient | patient |
"The patient who is the focus of this episode of care." - HL7 FHIR, EpisodeOfCare.patient
|
| ActionStatement | referralRequest |
"Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals." - HL7 FHIR, EpisodeOfCare.referralRequest
|
| «CS» Code | status |
"planned | waitlist | active | onhold | finished | cancelled." - HL7 FHIR, EpisodeOfCare.status
|
| StatusHistory | statusHistory |
"The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource)." - HL7 FHIR, EpisodeOfCare.statusHistory
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | EpisodeOfCare |
| Name Expression | |
| Namespace | Encounter |
| Owned Template Signature | |
| Owner | Encounter |
| Owning Template Parameter | |
| Package | Encounter |
| Qualified Name | FHIM::Encounter::EpisodeOfCare |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
abstractEncounter
Public AbstractEncounter abstractEncounter
-
Constraints:
-
Properties:
-
| Aggregation | Shared |
| Alias | |
| Association | serviceEpisode_abstractEncounter |
| Association End | |
| Class | EpisodeOfCare |
| 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 | abstractEncounter |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::abstractEncounter |
| Stereotype | |
| Template Parameter | |
| Type | AbstractEncounter |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
accountId
Public «II» Id accountId
-
"The set of accounts that may be used for billing for this EpisodeOfCare." - HL7 FHIR, EpisodeOfCare.account
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | accountId |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::accountId |
| Stereotype | |
| Template Parameter | |
| Type | «II» Id |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
careManager
Public PractitionerParticipation careManager
-
"The practitioner that is the care manager/care co-ordinator for this patient." - HL7 FHIR, EpisodeOfCare.careManager
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | careManager |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::careManager |
| Stereotype | |
| Template Parameter | |
| Type | PractitionerParticipation |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
careProtocol
Public CareProtocol careProtocol
-
TA proposed or tentative course of action for the maintenance and restoration of health by the treatment and prevention of disease by trained and licensed professionals.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | serviceEpisode_careProtocol |
| Association End | |
| Class | EpisodeOfCare |
| 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 | false |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | careProtocol |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::careProtocol |
| Stereotype | |
| Template Parameter | |
| Type | CareProtocol |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
careTeamMember
Public CareTeamMember careTeamMember
-
Pointer to Practitioner(s) who make up a team comprising multiple disciplines in order to provide holistic care for the patient."The list of practitioners that may be facilitating this episode of care for specific purposes." - HL7 FHIR, EpisodeOfCare.team
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | episodeOfCare_careTeamMember |
| Association End | |
| Class | EpisodeOfCare |
| 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 | careTeamMember |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::careTeamMember |
| Stereotype | |
| Template Parameter | |
| Type | CareTeamMember |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
category
Public «CS» Code category
-
"A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care." - HL7 FHIR, EpisodeOfCare.type
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | category |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::category |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
description
Public String description
-
"A brief user-defined description of a Service Episode in or for which the visit occurs. A Service Episode is the context in which the treatment or management of an arbitrary subset of a Patient s medical conditions occurs. The definition of the start time, stop time, and included events of a Service Episode is entirely arbitrary; it may include a single outpatient visit or a hospitalization, or extend over significant period of time, e.g., the duration of a pregnancy, or an oncology treatment regimen, or a cardiac episode from infarction through rehabilitation. A Service Episode may involve one or more Healthcare Organizations." - HL7 Version 2.8, PV1-53
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | description |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::description |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
diagnosisList
Public DiagnosisListEntry diagnosisList
-
Pointer to a list of one or more diagnosis(es) for which the Patient is being treated during the Episode Of Care."The list of diagnosis relevant to this episode of care." - HL7 FHIR, EpisodeOfCare.diagnosis
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | episodeOfCare_diagnosisList |
| Association End | |
| Class | EpisodeOfCare |
| 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 | diagnosisList |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::diagnosisList |
| Stereotype | |
| Template Parameter | |
| Type | DiagnosisListEntry |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
diagnosisRelatedGroup
Public DiagnosisGroupingEvent diagnosisRelatedGroup
-
Provides the diagnosis grouping for the diagnosis/s provide for the patients visit
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | serviceEpisode_diagnosisRelatedGroup |
| Association End | |
| Class | EpisodeOfCare |
| 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 | false |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | diagnosisRelatedGroup |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::diagnosisRelatedGroup |
| Stereotype | |
| Template Parameter | |
| Type | DiagnosisGroupingEvent |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
duration
Public «IVL_TS» Period duration
-
This property contains the date/times that the EpisodeOfCare began and ended. If the episode of care is currently active, the end date/time may be blank. Note that this property could potentially be calculated based on the start and end date/times of the constituent Encounters, therefore this property has been marked as derived."The interval during which the managing organization assumes the defined responsibility." - HL7 FHIR, EpisodeOfCare.period
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | duration |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::duration |
| Stereotype | |
| Template Parameter | |
| Type | «IVL_TS» Period |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
identifier
Public «II» Id identifier
-
This property uniquely identifies an instance of this Episode of Care class."Contains the identifier of a Service Episode in or for which the visit occurs." - HL7 Version 2.8, PV1-54 "The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes." - HL7 FHIR, EpisodeOfCare.identifier
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | identifier |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::identifier |
| Stereotype | |
| Template Parameter | |
| Type | «II» Id |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
managingOrganization
Public HealthcareProvider managingOrganization
-
Pointer to the HealthcareProvider organization that is managing the EpisodeOfCare."The organization that has assumed the specific responsibilities for the specified duration." - HL7 FHIR, EpisodeOfCare.managingOrganization
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | episodeOfCare_managingOrganization |
| Association End | |
| Class | EpisodeOfCare |
| 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 | managingOrganization |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::managingOrganization |
| Stereotype | |
| Template Parameter | |
| Type | HealthcareProvider |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
patient
Public Patient patient
-
"The patient who is the focus of this episode of care." - HL7 FHIR, EpisodeOfCare.patient
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | episodeOfCare_patient |
| Association End | |
| Class | EpisodeOfCare |
| 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 | patient |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::patient |
| Stereotype | |
| Template Parameter | |
| Type | Patient |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
referralRequest
Public ActionStatement referralRequest
-
"Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals." - HL7 FHIR, EpisodeOfCare.referralRequest
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | referralRequest |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::referralRequest |
| Stereotype | |
| Template Parameter | |
| Type | ActionStatement |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
status
Public «CS» Code status
-
"planned | waitlist | active | onhold | finished | cancelled." - HL7 FHIR, EpisodeOfCare.status
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | EpisodeOfCare |
| 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 | status |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::status |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
statusHistory
Public StatusHistory statusHistory
-
"The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource)." - HL7 FHIR, EpisodeOfCare.statusHistory
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | episodeOfCare_statusHistory |
| Association End | |
| Class | EpisodeOfCare |
| 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 | statusHistory |
| Name Expression | |
| Namespace | EpisodeOfCare |
| Opposite | |
| Owner | EpisodeOfCare |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Encounter::EpisodeOfCare::statusHistory |
| Stereotype | |
| Template Parameter | |
| Type | StatusHistory |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
|
| Encounter UML Documentation |