| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition." - HL7 FHIR, Communication
Attributes | ||
CommunicationTopic | communicationTopic |
Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes. |
CommunicationEvent | inResponseTo |
"Prior communication that this communication is in response to." - HL7 FHIR, Communication.inResponseTo |
«CS» Code | reasonCode |
"The reason or justification for the communication." - HL7 FHIR, Communication.reasonCodeNote that while both Communication and CommunicationRequest have a reasonCode (and therefore, one might reasonably assume that this would be in the CommunicationTopic class), the two classes bind their reasonCode to different value sets (Communication.reasonCode binds to SNOMED CT Clinical Findings, while CommunicationRequest.reasonCode binds to the V3 ActReason value set). Therefore, these properties are modeled separately in each class. |
«TS» PointInTime | received |
"The time when this communication arrived at the destination." - HL7 FHIR, Communication.received |
«TS» PointInTime | sent |
"The time when this communication was sent." - HL7 FHIR, Communication.sent |
«CS» Code | status |
"The status of the proposal or order." Possible values are: Draft; Active; On Hold; Revoked; Completed; Entered in Error; Unknown. - HL7 FHIR, CommunicationRequest.statusNote that while both Communication and CommunicationRequest have a status and are inheriting a recordStatus property from ClinicalStatement, the two classes bind their status properties to different value sets. Therefore, these properties are modeled separately in each class, whereby they re-define the recordStatus property. |
«CS» Code | statusReason |
"Captures the reason for the current state of the Communication." - HL7 FHIR, Communication.statusReasonPossible values include: Unknown; System Error; Invalid Phone Number; Recipient Unavailable; Family Objection; Patient Objection.Note that while both Communication and CommunicationRequest have a statusReason, the two classes bind to different value sets. Therefore, these properties are modeled separately in each class. |
«CS» Code | topic |
"Description of the purpose/content, similar to a subject line in an email." Possible values include: Prescription Refill Request; Progress Update; Report Labs; Appointment Reminder; Phone Consult; Summary Report. - HL7 FHIR, Communication.topic |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | CommunicationEvent |
Name Expression | |
Namespace | Common |
Owned Template Signature | |
Owner | Common |
Owning Template Parameter | |
Package | Common |
Qualified Name | FHIM::Common::CommunicationEvent |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public CommunicationTopic communicationTopic
Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes.
Aggregation | None |
Alias | |
Association | communicationEvent_communicationTopic |
Association End | |
Class | CommunicationEvent |
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 | communicationTopic |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::communicationTopic |
Stereotype | |
Template Parameter | |
Type | CommunicationTopic |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public CommunicationEvent inResponseTo
"Prior communication that this communication is in response to." - HL7 FHIR, Communication.inResponseTo
Aggregation | None |
Alias | |
Association | communicationEvent_inResponseTo |
Association End | |
Class | CommunicationEvent |
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 | inResponseTo |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::inResponseTo |
Stereotype | |
Template Parameter | |
Type | CommunicationEvent |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code reasonCode
"The reason or justification for the communication." - HL7 FHIR, Communication.reasonCodeNote that while both Communication and CommunicationRequest have a reasonCode (and therefore, one might reasonably assume that this would be in the CommunicationTopic class), the two classes bind their reasonCode to different value sets (Communication.reasonCode binds to SNOMED CT Clinical Findings, while CommunicationRequest.reasonCode binds to the V3 ActReason value set). Therefore, these properties are modeled separately in each class.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationEvent |
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 | reasonCode |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::reasonCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime received
"The time when this communication arrived at the destination." - HL7 FHIR, Communication.received
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationEvent |
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 | received |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::received |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime sent
"The time when this communication was sent." - HL7 FHIR, Communication.sent
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationEvent |
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 | sent |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::sent |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
"The status of the proposal or order." Possible values are: Draft; Active; On Hold; Revoked; Completed; Entered in Error; Unknown. - HL7 FHIR, CommunicationRequest.statusNote that while both Communication and CommunicationRequest have a status and are inheriting a recordStatus property from ClinicalStatement, the two classes bind their status properties to different value sets. Therefore, these properties are modeled separately in each class, whereby they re-define the recordStatus property.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationEvent |
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 | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code statusReason
"Captures the reason for the current state of the Communication." - HL7 FHIR, Communication.statusReasonPossible values include: Unknown; System Error; Invalid Phone Number; Recipient Unavailable; Family Objection; Patient Objection.Note that while both Communication and CommunicationRequest have a statusReason, the two classes bind to different value sets. Therefore, these properties are modeled separately in each class.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationEvent |
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 | statusReason |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::statusReason |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code topic
"Description of the purpose/content, similar to a subject line in an email." Possible values include: Prescription Refill Request; Progress Update; Report Labs; Appointment Reminder; Phone Consult; Summary Report. - HL7 FHIR, Communication.topic
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationEvent |
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 | topic |
Name Expression | |
Namespace | CommunicationEvent |
Opposite | |
Owner | CommunicationEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationEvent::topic |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |