Common
Class CommunicationEvent

"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 communicationTopic

Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes.

CommunicationEvent inResponseTo inResponseTo

"Prior communication that this communication is in response to." - HL7 FHIR, Communication.inResponseTo

«CS» Code reasonCode reasonCode

"The reason or justification for the communication." - HL7 FHIR, Communication.reasonCode
Note 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 received

"The time when this communication arrived at the destination." - HL7 FHIR, Communication.received

«TS» PointInTime sent sent

"The time when this communication was sent." - HL7 FHIR, Communication.sent

«CS» Code status status

"The status of the proposal or order." Possible values are: Draft; Active; On Hold; Revoked; Completed; Entered in Error; Unknown. - HL7 FHIR, CommunicationRequest.status
Note 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 statusReason

"Captures the reason for the current state of the Communication." - HL7 FHIR, Communication.statusReason
Possible 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 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::ActionPerformed FHIM::Common::ActionPerformed
basedOn basedOn, bodySite bodySite, complication complication, complicationDetail complicationDetail, duration duration, enactsPlan enactsPlan, focalDevice focalDevice, followUp followUp, fulfillsOrder fulfillsOrder, fulfillsPromise fulfillsPromise, nonCompletionTimeframe nonCompletionTimeframe, outcome outcome, partOf partOf, performancePeriod performancePeriod, performer performer, procedureModifier procedureModifier, report report, researchStudy researchStudy, status status, statusReason statusReason, timesPerformed timesPerformed, topicCode topicCode, usedCode usedCode, usedReference usedReference, wasCompleted wasCompleted

Attributes inherited from FHIM::Common::ActionStatement FHIM::Common::ActionStatement
category category, currentStatus currentStatus, description description, indication indication, inputFinding inputFinding, instantiatesCanonical instantiatesCanonical, instantiatesUri instantiatesUri, insurance insurance, intent intent, justification justification, location location, method method, outputFinding outputFinding, precondition precondition, reasonCode reasonCode, reasonNarrative reasonNarrative, reasonReference reasonReference, relevantHistory relevantHistory, scope scope, supportingInformation supportingInformation, usingDevice usingDevice, wasReported wasReported

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameCommunicationEvent
Name Expression
NamespaceCommon
Owned Template Signature
OwnerCommon
Owning Template Parameter
PackageCommon
Qualified NameFHIM::Common::CommunicationEvent
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 communicationTopic
Public CommunicationTopic communicationTopic

Pointer to those data elements that are common to the CommunicationEvent and CommunicationRequest classes.

Constraints:
Properties:

AggregationNone
Alias
AssociationcommunicationEvent_communicationTopic
Association End
ClassCommunicationEvent
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
NamecommunicationTopic
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::communicationTopic
Stereotype
Template Parameter
TypeCommunicationTopic
Upper1
Upper Value(1)
VisibilityPublic


 inResponseTo
Public CommunicationEvent inResponseTo

"Prior communication that this communication is in response to." - HL7 FHIR, Communication.inResponseTo

Constraints:
Properties:

AggregationNone
Alias
AssociationcommunicationEvent_inResponseTo
Association End
ClassCommunicationEvent
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)
Multiplicity*
NameinResponseTo
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::inResponseTo
Stereotype
Template Parameter
TypeCommunicationEvent
Upper*
Upper Value(*)
VisibilityPublic


 reasonCode
Public «CS» Code reasonCode

"The reason or justification for the communication." - HL7 FHIR, Communication.reasonCode
Note 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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationEvent
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)
Multiplicity*
NamereasonCode
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::reasonCode
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 received
Public «TS» PointInTime received

"The time when this communication arrived at the destination." - HL7 FHIR, Communication.received

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationEvent
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
Namereceived
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::received
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 sent
Public «TS» PointInTime sent

"The time when this communication was sent." - HL7 FHIR, Communication.sent

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationEvent
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
Namesent
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::sent
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationEvent
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
Namestatus
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 statusReason
Public «CS» Code statusReason

"Captures the reason for the current state of the Communication." - HL7 FHIR, Communication.statusReason
Possible 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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationEvent
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
NamestatusReason
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::statusReason
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 topic
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationEvent
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
Nametopic
Name Expression
NamespaceCommunicationEvent
Opposite
OwnerCommunicationEvent
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationEvent::topic
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic