Common
Class CommunicationTopic

This class contains those data elements that are common to the CommunicationEvent and CommunicationRequest classes.

Attributes
ClinicalStatement about about

"Other resources that pertain to this communication and to which this communication should be associated." - HL7 FHIR, Communication.about
"Other resources that pertain to this communication request and to which this communication request should be associated." - HL7 FHIR, CommunicationRequest.about

«CS» Code category category

"The type of message conveyed such as alert, notification, reminder, instruction, etc." - HL7 FHIR, Communication.basedOn
"The type of message to be sent such as alert, notification, reminder, instruction, etc." - HL7 FHIR, CommunicationRequest.category
Possible values include: Alert; Notification; Reminder; Instruction

«CS» Code medium medium

"A channel that was used for this communication (e.g. email, fax)." - HL7 FHIR, Communication.medium
"A channel that was used for this communication (e.g. email, fax)." - HL7 FHIR, CommunicationRequest.medium
Possible values include: electronic data; physical presence; remote presence; verbal; dictated; face-to-face; telephone; videoconferencing; written; telefax; handwritten; mail; online written; email; typewritten.

Payload payload payload

"Text, attachment(s), or resource(s) that was communicated to the recipient." - HL7 FHIR, Communication.payload
"Text, attachment(s), or resource(s) to be communicated to the recipient." - HL7 FHIR, CommunicationRequest.payload

«CS» Code priority priority

"Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine." - HL7 FHIR, Communication.priority
"Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine." - HL7 FHIR, CommunicationRequest.priority
Possible values are: Routine; Urgent; ASAP; STAT.

«ANY» Any recipient recipient

"The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time)." - HL7 FHIR, Communication.recipient
"The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication." - HL7 FHIR, CommunicationRequest.recipient
Note that in FHIR, this property can refer to a Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, or a HealthcareService. Therefore, in the FHIM, this uses the Any data type.

«ANY» Any sender sender

"The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication." - HL7 FHIR, Communication.sender
"The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication." - HL7 FHIR, CommunicationRequest.sender
Note that in FHIR, this property can refer to a Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, or a HealthcareService. Therefore, in the FHIM, this uses the Any data type.


Properties:

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

Attribute Details

 about
Public ClinicalStatement about

"Other resources that pertain to this communication and to which this communication should be associated." - HL7 FHIR, Communication.about
"Other resources that pertain to this communication request and to which this communication request should be associated." - HL7 FHIR, CommunicationRequest.about

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationTopic
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*
Nameabout
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::about
Stereotype
Template Parameter
TypeClinicalStatement
Upper*
Upper Value(*)
VisibilityPublic


 category
Public «CS» Code category

"The type of message conveyed such as alert, notification, reminder, instruction, etc." - HL7 FHIR, Communication.basedOn
"The type of message to be sent such as alert, notification, reminder, instruction, etc." - HL7 FHIR, CommunicationRequest.category
Possible values include: Alert; Notification; Reminder; Instruction

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationTopic
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*
Namecategory
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::category
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 medium
Public «CS» Code medium

"A channel that was used for this communication (e.g. email, fax)." - HL7 FHIR, Communication.medium
"A channel that was used for this communication (e.g. email, fax)." - HL7 FHIR, CommunicationRequest.medium
Possible values include: electronic data; physical presence; remote presence; verbal; dictated; face-to-face; telephone; videoconferencing; written; telefax; handwritten; mail; online written; email; typewritten.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationTopic
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*
Namemedium
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::medium
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 payload
Public Payload payload

"Text, attachment(s), or resource(s) that was communicated to the recipient." - HL7 FHIR, Communication.payload
"Text, attachment(s), or resource(s) to be communicated to the recipient." - HL7 FHIR, CommunicationRequest.payload

Constraints:
Properties:

AggregationNone
Alias
AssociationcommunicationTopic_payload
Association End
ClassCommunicationTopic
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*
Namepayload
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::payload
Stereotype
Template Parameter
TypePayload
Upper*
Upper Value(*)
VisibilityPublic


 priority
Public «CS» Code priority

"Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine." - HL7 FHIR, Communication.priority
"Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine." - HL7 FHIR, CommunicationRequest.priority
Possible values are: Routine; Urgent; ASAP; STAT.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationTopic
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
Namepriority
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::priority
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 recipient
Public «ANY» Any recipient

"The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time)." - HL7 FHIR, Communication.recipient
"The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication." - HL7 FHIR, CommunicationRequest.recipient
Note that in FHIR, this property can refer to a Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, or a HealthcareService. Therefore, in the FHIM, this uses the Any data type.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationTopic
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
Namerecipient
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::recipient
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic


 sender
Public «ANY» Any sender

"The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication." - HL7 FHIR, Communication.sender
"The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication." - HL7 FHIR, CommunicationRequest.sender
Note that in FHIR, this property can refer to a Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, or a HealthcareService. Therefore, in the FHIM, this uses the Any data type.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassCommunicationTopic
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
Namesender
Name Expression
NamespaceCommunicationTopic
Opposite
OwnerCommunicationTopic
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::CommunicationTopic::sender
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic