LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/engagement-communication | Version: 8.0.0 | |||
| Active as of 2022-11-10 | Computable Name: EngagementCommunication | |||
This profile is a record of an engagement communication to a patient including successful, planned, and failed communications.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDMCommunication
| Path | Conformance | ValueSet |
| Communication.statusReason | example | EngagementCommunicationStatusReasonValueSet (a valid code from Engagement Communication Status Reason Codes) |
| Communication.medium | preferred | EngagementCommunicationModeValueSet (a valid code from Engagement Communication Mode Codes) |
| Path | Conformance | ValueSet |
| Communication.status | required | EventStatus |
| Communication.statusReason | example | EngagementCommunicationStatusReasonValueSet (a valid code from Engagement Communication Status Reason Codes) |
| Communication.medium | preferred | EngagementCommunicationModeValueSet (a valid code from Engagement Communication Mode Codes) |
| Path | Conformance | ValueSet | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | EventStatus | ||||
| Communication.statusReason | example | EngagementCommunicationStatusReasonValueSet (a valid code from Engagement Communication Status Reason Codes) | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | preferred | EngagementCommunicationModeValueSet (a valid code from Engagement Communication Mode Codes) |
This structure is derived from CDMCommunication
Summary
Mandatory: 3 elements
Prohibited: 8 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from CDMCommunication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Communication | 0..* | CDMCommunication | A record of information transmitted from a sender to a receiver | |
  extension | 3..* | Extension | Extension | |
 extension:communicationTemplate | 1..1 | CommunicationTemplate | Communication Template | |
| extension:communicationPayloadData | 1..1 | CommunicationPayloadData | Communication Payload Data | |
| conversationType | 0..1 | CodeableConcept | Type of conversation, used for chat communications URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/conversation-type Binding: Engagement Conversation Type Value Set (extensible) | |
| communicationReengagement | 0..1 | (Complex) | Sequence for subsequent communication attempts to reengage the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-reengagement | |
| communicationRetryLimit | 0..1 | string, unsignedInt | Retry limit configuration, may vary by medium and vendor URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-retry-limt | |
| sentToVendor | 0..* | (Complex) | Records date/time and outcome of communications sent to vendor URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sent-to-vendor | |
| sentToRecipient | 0..* | (Complex) | Records date/time and outcome of communication attempts with the recipient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sent-to-recipient | |
 basedOn | 0..* | Reference(Engagement CommunicationRequest) | Request fulfilled by this communication | |
 partOf | 0..0 | |||
| inResponseTo | 0..0 | |||
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: Engagement Communication Status Reason Value Set (example) | |
| medium | 1..1 | CodeableConcept | Medium used as the mode of communication for engagement (phone | sms | email | mail | chat) Binding: Engagement Communication Mode Value Set (preferred) | |
| topic | 0..0 | |||
| about | 0..* | Reference(Measure Population Observation | Care Gap Detected Issue) | Resources that pertain to this communication | |
| encounter | 0..0 | |||
| sent | 0..0 | |||
| reasonCode | 0..0 | |||
| reasonReference | 0..0 | |||
 note | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Communication.statusReason | example | EngagementCommunicationStatusReasonValueSet (a valid code from Engagement Communication Status Reason Codes) |
| Communication.medium | preferred | EngagementCommunicationModeValueSet (a valid code from Engagement Communication Mode Codes) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | 0..* | CDMCommunication | A record of information transmitted from a sender to a receiver | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| communicationProduct | 0..1 | CodeableConcept | Product generating the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product Binding: Engagement Product Value Set (extensible) | |
| communicationOnBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Location) | Attributed provider, location, or organization communication is on-behalf of URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-on-behalf-of | |
| communicationContact | S | 1..1 | Address, CDMCommunicationContactPoint | Phone number, email, or address to contact URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-contact |
| communicationMeasure | 0..1 | Reference(Measure) | Reference to the measure that resulted in the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-measure | |
| communicationCareGap | 0..1 | string | ID of care gap for which we are communicating URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap | |
| communicationPrioritySequence | 0..1 | decimal | Priority of the communication request (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-priority-sequence | |
| communicationLanguage | 0..1 | code | Language used for communication messaging content URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-language Binding: AllLanguages (preferred) | |
| communicationTemplate | 1..1 | string, Attachment | Communication Template URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-template | |
| communicationPayloadData | 1..1 | string | Communication Payload Data URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-payload-data | |
| communicationVendor | 0..1 | Reference(Organization) | Vendor used to send the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-vendor | |
| conversationType | 0..1 | CodeableConcept | Type of conversation, used for chat communications URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/conversation-type Binding: Engagement Conversation Type Value Set (extensible) | |
| communicationReengagement | 0..1 | (Complex) | Sequence for subsequent communication attempts to reengage the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-reengagement | |
| communicationRetryLimit | 0..1 | string, unsignedInt | Retry limit configuration, may vary by medium and vendor URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-retry-limt | |
| sentToVendor | 0..* | (Complex) | Records date/time and outcome of communications sent to vendor URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sent-to-vendor | |
| sentToRecipient | 0..* | (Complex) | Records date/time and outcome of communication attempts with the recipient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sent-to-recipient | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| basedOn | Σ | 0..* | Reference(Engagement CommunicationRequest) | Request fulfilled by this communication |
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
 statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: Engagement Communication Status Reason Value Set (example) |
| medium | 1..1 | CodeableConcept | Medium used as the mode of communication for engagement (phone | sms | email | mail | chat) Binding: Engagement Communication Mode Value Set (preferred) | |
| about | 0..* | Reference(Measure Population Observation | Care Gap Detected Issue) | Resources that pertain to this communication | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Communication.status | required | EventStatus |
| Communication.statusReason | example | EngagementCommunicationStatusReasonValueSet (a valid code from Engagement Communication Status Reason Codes) |
| Communication.medium | preferred | EngagementCommunicationModeValueSet (a valid code from Engagement Communication Mode Codes) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Communication | 0..* | CDMCommunication | A record of information transmitted from a sender to a receiver | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | 0..1 | ProcessMeta | Metadata about a resource | |||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| communicationProduct | 0..1 | CodeableConcept | Product generating the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product Binding: Engagement Product Value Set (extensible) | |||||
| communicationOnBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Location) | Attributed provider, location, or organization communication is on-behalf of URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-on-behalf-of | |||||
| communicationContact | S | 1..1 | Address, CDMCommunicationContactPoint | Phone number, email, or address to contact URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-contact | ||||
| communicationMeasure | 0..1 | Reference(Measure) | Reference to the measure that resulted in the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-measure | |||||
| communicationCareGap | 0..1 | string | ID of care gap for which we are communicating URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap | |||||
| communicationPrioritySequence | 0..1 | decimal | Priority of the communication request (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-priority-sequence | |||||
| communicationLanguage | 0..1 | code | Language used for communication messaging content URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-language Binding: AllLanguages (preferred) | |||||
| communicationTemplate | 1..1 | string, Attachment | Communication Template URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-template | |||||
| communicationPayloadData | 1..1 | string | Communication Payload Data URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-payload-data | |||||
| communicationVendor | 0..1 | Reference(Organization) | Vendor used to send the communication URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-vendor | |||||
| conversationType | 0..1 | CodeableConcept | Type of conversation, used for chat communications URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/conversation-type Binding: Engagement Conversation Type Value Set (extensible) | |||||
| communicationReengagement | 0..1 | (Complex) | Sequence for subsequent communication attempts to reengage the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-reengagement | |||||
| communicationRetryLimit | 0..1 | string, unsignedInt | Retry limit configuration, may vary by medium and vendor URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-retry-limt | |||||
| sentToVendor | 0..* | (Complex) | Records date/time and outcome of communications sent to vendor URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sent-to-vendor | |||||
| sentToRecipient | 0..* | (Complex) | Records date/time and outcome of communication attempts with the recipient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sent-to-recipient | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique identifier | ||||
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(Engagement CommunicationRequest) | Request fulfilled by this communication | ||||
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: Engagement Communication Status Reason Value Set (example) | ||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
| medium | 1..1 | CodeableConcept | Medium used as the mode of communication for engagement (phone | sms | email | mail | chat) Binding: Engagement Communication Mode Value Set (preferred) | |||||
| subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| about | 0..* | Reference(Measure Population Observation | Care Gap Detected Issue) | Resources that pertain to this communication | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
 payload | 0..* | BackboneElement | Message payload | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
 content[x] | 1..1 | Message part content | ||||||
| contentString | string | |||||||
| contentAttachment | Attachment | |||||||
| contentReference | Reference(Resource) | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | EventStatus | ||||
| Communication.statusReason | example | EngagementCommunicationStatusReasonValueSet (a valid code from Engagement Communication Status Reason Codes) | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | preferred | EngagementCommunicationModeValueSet (a valid code from Engagement Communication Mode Codes) |
This structure is derived from CDMCommunication
Summary
Mandatory: 3 elements
Prohibited: 8 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron