| Encounter UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
Contains properties common to multiple kinds of Encounters. This class is abstract, meaning that it would never be instantiated on its own, but rather one of the concrete subtypes (e.g., InpatientEncounter) would be instantiated.
Attributes | ||
CareTeamMember | careTeamMember |
Pointer to Practitioner(s) who make up a team comprising multiple disciplines in order to provide holistic care for the patient. |
String | comments | |
«CS» Code | confidentiallyCode |
Contains a set of values that control the disclosure of information about this patient |
String | description |
"Contains a brief user-defined description of the visit." - HL7 Version 2.8, PV2-12. |
DiagnosisListEntry | diagnosisList |
Pointer to a list of one or more diagnosis(es) for which the Patient is being treated during the Encounter."The list of diagnosis relevant to this encounter." - HL7 FHIR, Encounter.diagnosis |
«IVL_TS» Period | duration |
This property contains the date/times that the Encounter began and ended. If the encounter is currently active, the end time may be blank. HL7 V3 suggests that for current encounters, the end date could be used to convey the anticipated end date/time, but FHIM discourages this usage and instead recommends leaving the end date/time blank."The time interval starting with the administrative onset of the encounter (e.g. admission, registration, patient arrival) and ending with the patient's departure (e.g. discharge). Note (1): for active encounters the end of the effectiveTime range is the anticipated end date-time. Note (2): all messages, except the "nullify" message, require at least a starting time." - HL7 V3"The start and end time of the encounter." - HL7 FHIR, Encounter.period |
«CS» Code | encounterClass |
Indicates what kind (i.e., subtype) of Encounter that an encounter instance is. This property is included for compatibility with FHIR, and is therefore both optional and marked as derived. In FHIM, the kind of Encounter is known by the subtype of Encounter that the instance instantiates. In other words, FHIM has an EmergencyEncounter class and it is therefore known that an EmergencyEncounter is an EmergencyEncounter, whereas in FHIR an EmergencyEncounter is an Encounter with type EmergencyEncounter."This field is used by systems to categorize patients by site. It does not have a consistent industry-wide definition. It is subject to site specific variations." - HL7 Version 2.8, PV1-2. HL7 Version 2 has the following suggested values (table 4): Emergency; Inpatient; Outpatient; Preadmit; Recurring patient; Obstetrics; Commercial Account; Not Applicable; Unknown."Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations." Possible values include: ambulatory; emergency; field; home health; inpatient encounter; inpatient acute; inpatient non-acute; observation encounter; pre-admission; short stay; virtual. - HL7 FHIR, Encounter.class"Encounter type...." - PCORnet Common Data Model, Encounter.Enc_Type. Possible values include: Ambulatory Visit; Emergency Department; Emergency Department Admit to Inpatient Hospital Stay; Inpatient Hospital Stay; Non-Acute Institutional Stay; Observation Stay; Institutional Professional Consult; Other Ambulatory Visit; No information; Unknown; Other. |
«CS» Code | encounterType |
A categorization of the Encounter. This optional property is included for compatibility to FHIR, but the kinds of categorizations that might be useful have not yet been identified."Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)." - HL7 FHIR, Encounter.type |
EpisodeOfCare | episodeOfCare |
Pointer to a Service Episode (aka Episode Of Care) into which this Encounter can be aggregated. Note that ordinarily an Encounter will be aggregated into only one (if at all) Service Episode, this property is modeled as a zero-to-many relationship rather than zero-to-one for compatibility with FHIR."Contains the identifier of a Service Episode in or for which the visit occurs." - HL7 Version 2.8, PV1-54"Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years)." - HL7 FHIR, Encounter.episodeOfCare |
«II» Id | identifier |
This property uniquely identifies the Encounter. This property can be used, among other purposes, to associate the current Encounter with other Encounters, or with events that occurred during the Encounter."Contains the unique number assigned to each patient visit." - HL7 Version 2.8, PV1-19"Identifier(s) by which this encounter is known." - HL7 FHIR, Encounter.identifier"Arbitrary encounter-level identifier. Used to link across tables." - PCORnet Common Data Model, Encounter.EncounterId |
«PQ» TimeQuantity | lengthOfStay |
"Quantity of time the encounter lasted. This excludes the time during leaves of absence." - HL7 FHIR, Encounter.length |
Patient | patient |
The Person or Animal (playing the Role of Patient) who is the subject of the Encounter."The patient or group present at the encounter." - HL7 FHIR, Encounter.subject. Note that in FHIR, the subject can be a Patient (subjectPatient) or a Group (subjectGroup). In FHIM, these are two separate associations: patient and subjectGroup. If one association is not empty, the other association must be empty. Therefore, this property is marked as zero to one, whereas logically it should be one to one. |
«CS» Code | priority |
"Contains the priority of the visit." - HL7 Version 2.8, PV2-25. Possible values include (from HL7 Table 217): Emergency; Urgent; Elective"Indicates the urgency of the encounter." - HL7 FHIR, Encounter.priority |
RelatedEncounter | relatedEncounter |
Pointer to another Encounter to which this Encounter is somehow related. The nature of the relationship is defined by the relatedEncounterCategory code."Another Encounter of which this encounter is a part of (administratively or in time)." - HL7 FHIR, Encounter.partOf |
HealthcareProvider | scopingProvider |
Pointer to the Healthcare Provider (organization) under whose auspices the Encounter occurred."The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy." - HL7 FHIR, Encounter.serviceProvider"Code for the provider who is most responsible for this encounter." - PCORnet Common Data Model, Encounter.ProviderId |
«CS» Code | serviceType |
"Broad categorization of the service that is to be provided (e.g. cardiology)." - HL7 FHIR, Encounter.serviceType |
«CS» Code | status |
A value specifying the state of this patient encounter (based on the RIM Act class state machine), for example, active, aborted, completed "planned | arrived | triaged | in-progress | onleave | finished | cancelled +." - HL7 FHIR, Encounter.status |
StatusHistory | statusHistory |
"The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them." - HL7 FHIR, Encounter.statusHistory |
Group | subjectGroup |
"The patient or group present at the encounter." - HL7 FHIR, Encounter.subject. Note that in FHIR, the subject can be a Patient (subjectPatient) or a Group (subjectGroup). In FHIM, these are two separate associations: patient and subjectGroup. If one association is not empty, the other association must be empty. Therefore, this property is marked as zero to one, whereas logically it should be one to one. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | true |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | AbstractEncounter |
Name Expression | |
Namespace | Encounter |
Owned Template Signature | |
Owner | Encounter |
Owning Template Parameter | |
Package | Encounter |
Qualified Name | FHIM::Encounter::AbstractEncounter |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public CareTeamMember careTeamMember
Pointer to Practitioner(s) who make up a team comprising multiple disciplines in order to provide holistic care for the patient.
Aggregation | None |
Alias | |
Association | abstractEncounter_careTeamMember |
Association End | |
Class | AbstractEncounter |
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 | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::careTeamMember |
Stereotype | |
Template Parameter | |
Type | CareTeamMember |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String comments
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | comments |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::comments |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code confidentiallyCode
Contains a set of values that control the disclosure of information about this patient
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | confidentiallyCode |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::confidentiallyCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
"Contains a brief user-defined description of the visit." - HL7 Version 2.8, PV2-12.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public DiagnosisListEntry diagnosisList
Pointer to a list of one or more diagnosis(es) for which the Patient is being treated during the Encounter."The list of diagnosis relevant to this encounter." - HL7 FHIR, Encounter.diagnosis
Aggregation | None |
Alias | |
Association | encounter_diagnosis |
Association End | |
Class | AbstractEncounter |
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 | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::diagnosisList |
Stereotype | |
Template Parameter | |
Type | DiagnosisListEntry |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «IVL_TS» Period duration
This property contains the date/times that the Encounter began and ended. If the encounter is currently active, the end time may be blank. HL7 V3 suggests that for current encounters, the end date could be used to convey the anticipated end date/time, but FHIM discourages this usage and instead recommends leaving the end date/time blank."The time interval starting with the administrative onset of the encounter (e.g. admission, registration, patient arrival) and ending with the patient's departure (e.g. discharge). Note (1): for active encounters the end of the effectiveTime range is the anticipated end date-time. Note (2): all messages, except the "nullify" message, require at least a starting time." - HL7 V3"The start and end time of the encounter." - HL7 FHIR, Encounter.period
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | duration |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::duration |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code encounterClass
Indicates what kind (i.e., subtype) of Encounter that an encounter instance is. This property is included for compatibility with FHIR, and is therefore both optional and marked as derived. In FHIM, the kind of Encounter is known by the subtype of Encounter that the instance instantiates. In other words, FHIM has an EmergencyEncounter class and it is therefore known that an EmergencyEncounter is an EmergencyEncounter, whereas in FHIR an EmergencyEncounter is an Encounter with type EmergencyEncounter."This field is used by systems to categorize patients by site. It does not have a consistent industry-wide definition. It is subject to site specific variations." - HL7 Version 2.8, PV1-2. HL7 Version 2 has the following suggested values (table 4): Emergency; Inpatient; Outpatient; Preadmit; Recurring patient; Obstetrics; Commercial Account; Not Applicable; Unknown."Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations." Possible values include: ambulatory; emergency; field; home health; inpatient encounter; inpatient acute; inpatient non-acute; observation encounter; pre-admission; short stay; virtual. - HL7 FHIR, Encounter.class"Encounter type...." - PCORnet Common Data Model, Encounter.Enc_Type. Possible values include: Ambulatory Visit; Emergency Department; Emergency Department Admit to Inpatient Hospital Stay; Inpatient Hospital Stay; Non-Acute Institutional Stay; Observation Stay; Institutional Professional Consult; Other Ambulatory Visit; No information; Unknown; Other.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | encounterClass |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::encounterClass |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code encounterType
A categorization of the Encounter. This optional property is included for compatibility to FHIR, but the kinds of categorizations that might be useful have not yet been identified."Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)." - HL7 FHIR, Encounter.type
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | encounterType |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::encounterType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public EpisodeOfCare episodeOfCare
Pointer to a Service Episode (aka Episode Of Care) into which this Encounter can be aggregated. Note that ordinarily an Encounter will be aggregated into only one (if at all) Service Episode, this property is modeled as a zero-to-many relationship rather than zero-to-one for compatibility with FHIR."Contains the identifier of a Service Episode in or for which the visit occurs." - HL7 Version 2.8, PV1-54"Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years)." - HL7 FHIR, Encounter.episodeOfCare
Aggregation | None |
Alias | |
Association | abstractEncounter_episodeOfCare |
Association End | |
Class | AbstractEncounter |
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 | episodeOfCare |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::episodeOfCare |
Stereotype | |
Template Parameter | |
Type | EpisodeOfCare |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id identifier
This property uniquely identifies the Encounter. This property can be used, among other purposes, to associate the current Encounter with other Encounters, or with events that occurred during the Encounter."Contains the unique number assigned to each patient visit." - HL7 Version 2.8, PV1-19"Identifier(s) by which this encounter is known." - HL7 FHIR, Encounter.identifier"Arbitrary encounter-level identifier. Used to link across tables." - PCORnet Common Data Model, Encounter.EncounterId
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» TimeQuantity lengthOfStay
"Quantity of time the encounter lasted. This excludes the time during leaves of absence." - HL7 FHIR, Encounter.length
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | lengthOfStay |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::lengthOfStay |
Stereotype | |
Template Parameter | |
Type | «PQ» TimeQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Patient patient
The Person or Animal (playing the Role of Patient) who is the subject of the Encounter."The patient or group present at the encounter." - HL7 FHIR, Encounter.subject. Note that in FHIR, the subject can be a Patient (subjectPatient) or a Group (subjectGroup). In FHIM, these are two separate associations: patient and subjectGroup. If one association is not empty, the other association must be empty. Therefore, this property is marked as zero to one, whereas logically it should be one to one.
Aggregation | None |
Alias | |
Association | abstractEncounter_patient |
Association End | |
Class | AbstractEncounter |
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 | patient |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::patient |
Stereotype | |
Template Parameter | |
Type | Patient |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code priority
"Contains the priority of the visit." - HL7 Version 2.8, PV2-25. Possible values include (from HL7 Table 217): Emergency; Urgent; Elective"Indicates the urgency of the encounter." - HL7 FHIR, Encounter.priority
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | priority |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::priority |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public RelatedEncounter relatedEncounter
Pointer to another Encounter to which this Encounter is somehow related. The nature of the relationship is defined by the relatedEncounterCategory code."Another Encounter of which this encounter is a part of (administratively or in time)." - HL7 FHIR, Encounter.partOf
Aggregation | None |
Alias | |
Association | abstractEncounter_relatedEncounter |
Association End | |
Class | AbstractEncounter |
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 | relatedEncounter |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::relatedEncounter |
Stereotype | |
Template Parameter | |
Type | RelatedEncounter |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public HealthcareProvider scopingProvider
Pointer to the Healthcare Provider (organization) under whose auspices the Encounter occurred."The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy." - HL7 FHIR, Encounter.serviceProvider"Code for the provider who is most responsible for this encounter." - PCORnet Common Data Model, Encounter.ProviderId
Aggregation | None |
Alias | |
Association | abstractEncounter_scopingProvider |
Association End | |
Class | AbstractEncounter |
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 | scopingProvider |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::scopingProvider |
Stereotype | |
Template Parameter | |
Type | HealthcareProvider |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code serviceType
"Broad categorization of the service that is to be provided (e.g. cardiology)." - HL7 FHIR, Encounter.serviceType
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | serviceType |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::serviceType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
A value specifying the state of this patient encounter (based on the RIM Act class state machine), for example, active, aborted, completed "planned | arrived | triaged | in-progress | onleave | finished | cancelled +." - HL7 FHIR, Encounter.status
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | status |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public StatusHistory statusHistory
"The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them." - HL7 FHIR, Encounter.statusHistory
Aggregation | None |
Alias | |
Association | abstractEncounter_statusHistory |
Association End | |
Class | AbstractEncounter |
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 | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::statusHistory |
Stereotype | |
Template Parameter | |
Type | StatusHistory |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Group subjectGroup
"The patient or group present at the encounter." - HL7 FHIR, Encounter.subject. Note that in FHIR, the subject can be a Patient (subjectPatient) or a Group (subjectGroup). In FHIM, these are two separate associations: patient and subjectGroup. If one association is not empty, the other association must be empty. Therefore, this property is marked as zero to one, whereas logically it should be one to one.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | AbstractEncounter |
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 | subjectGroup |
Name Expression | |
Namespace | AbstractEncounter |
Opposite | |
Owner | AbstractEncounter |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Encounter::AbstractEncounter::subjectGroup |
Stereotype | |
Template Parameter | |
Type | Group |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Encounter UML Documentation |
Summary:AttributesProperties | Detail:Attributes |