| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class contains those data elements that are common to the CommunicationEvent and CommunicationRequest classes.
Attributes | ||
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 |
«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.categoryPossible values include: Alert; Notification; Reminder; Instruction |
«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.mediumPossible 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 |
"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 |
"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.priorityPossible values are: Routine; Urgent; ASAP; STAT. |
«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.recipientNote 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 |
"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.senderNote 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 Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | CommunicationTopic |
Name Expression | |
Namespace | Common |
Owned Template Signature | |
Owner | Common |
Owning Template Parameter | |
Package | Common |
Qualified Name | FHIM::Common::CommunicationTopic |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationTopic |
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 | about |
Name Expression | |
Namespace | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::about |
Stereotype | |
Template Parameter | |
Type | ClinicalStatement |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.categoryPossible values include: Alert; Notification; Reminder; Instruction
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationTopic |
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 | category |
Name Expression | |
Namespace | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::category |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.mediumPossible values include: electronic data; physical presence; remote presence; verbal; dictated; face-to-face; telephone; videoconferencing; written; telefax; handwritten; mail; online written; email; typewritten.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationTopic |
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 | medium |
Name Expression | |
Namespace | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::medium |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | communicationTopic_payload |
Association End | |
Class | CommunicationTopic |
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 | payload |
Name Expression | |
Namespace | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::payload |
Stereotype | |
Template Parameter | |
Type | Payload |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.priorityPossible values are: Routine; Urgent; ASAP; STAT.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationTopic |
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 | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::priority |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.recipientNote 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationTopic |
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 | recipient |
Name Expression | |
Namespace | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::recipient |
Stereotype | |
Template Parameter | |
Type | «ANY» Any |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.senderNote 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | CommunicationTopic |
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 | sender |
Name Expression | |
Namespace | CommunicationTopic |
Opposite | |
Owner | CommunicationTopic |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::CommunicationTopic::sender |
Stereotype | |
Template Parameter | |
Type | «ANY» Any |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |