LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Resource Profile: EngagementCommunication - Detailed Descriptions

Active as of 2022-11-10

Definitions for the engagement-communication resource profile.

1. Communication
2. Communication.extension
Control31..*
3. Communication.extension:communicationTemplate
SliceNamecommunicationTemplate
Control10..1
4. Communication.extension:communicationPayloadData
SliceNamecommunicationPayloadData
Control10..1
5. Communication.extension:conversationType
SliceNameconversationType
Definition

Type of conversation, used for chat communications

Control0..1
TypeExtension(ConversationType) (Extension Type: CodeableConcept)
6. Communication.extension:communicationReengagement
SliceNamecommunicationReengagement
Definition

Sequence for subsequent communication attempts to reengage the patient

Control0..1
TypeExtension(CommunicationReengagement) (Complex Extension)
7. Communication.extension:communicationRetryLimit
SliceNamecommunicationRetryLimit
Definition

Retry limit configuration, may vary by medium and vendor

Control0..1
TypeExtension(CommunicationRetryLimit) (Extension Type: Choice of: string, unsignedInt)
8. Communication.extension:sentToVendor
SliceNamesentToVendor
Definition

Records date/time and outcome of communications sent to vendor

Control0..*
TypeExtension(SentToVendor) (Complex Extension)
9. Communication.extension:sentToRecipient
SliceNamesentToRecipient
Definition

Records date/time and outcome of communication attempts with the recipient

Control0..*
TypeExtension(SentToRecipient) (Complex Extension)
10. Communication.basedOn
TypeReference(EngagementCommunicationRequest|Resource))
11. Communication.partOf
Control0..0*
12. Communication.inResponseTo
Control0..0*
13. Communication.statusReason
BindingFor example codes, see Engagement Communication Status Reason Value SetFor example codes, see CommunicationNotDoneReason
14. Communication.medium
Definition

Medium used as the mode of communication for engagement (phone | sms | email | mail | chat)

A channel that was used for this communication (e.g. email, fax).

Control10..1*
BindingThe codes SHOULD be taken from Engagement Communication Mode Value SetFor example codes, see ParticipationMode
15. Communication.topic
Control0..01
16. Communication.about
TypeReference(MeasurePopulationObservation|CareGapDetectedIssue|Resource))
17. Communication.encounter
Control0..01
18. Communication.sent
Control0..01
19. Communication.reasonCode
Control0..0*
20. Communication.reasonReference
Control0..0*
21. Communication.note
Control0..0*
1. Communication
Definition

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.

Control0..*
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. Communication.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Communication.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..0*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

4. Communication.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control30..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
5. Communication.extension:communicationProduct
SliceNamecommunicationProduct
Definition

Product generating the communication

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationProduct) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. Communication.extension:communicationOnBehalfOf
SliceNamecommunicationOnBehalfOf
Definition

Attributed provider, location, or organization communication is on-behalf of

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationOnBehalfOf) (Extension Type: Reference(PractitionerPractitionerRoleOrganizationLocation)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. Communication.extension:communicationContact
SliceNamecommunicationContact
Definition

Phone number, email, or address to contact

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationContact) (Extension Type: Choice of: Address, ContactPoint(CDMCommunicationContactPoint))
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
8. Communication.extension:communicationMeasure
SliceNamecommunicationMeasure
Definition

Reference to the measure that resulted in the communication

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationMeasure) (Extension Type: Reference(Measure)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Communication.extension:communicationCareGap
SliceNamecommunicationCareGap
Definition

ID of care gap for which we are communicating

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationCareGap) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Communication.extension:communicationPrioritySequence
SliceNamecommunicationPrioritySequence
Definition

Priority of the communication request (1 = highest)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationPrioritySequence) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Communication.extension:communicationLanguage
SliceNamecommunicationLanguage
Definition

Language used for communication messaging content

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationLanguage) (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Communication.extension:communicationTemplate
SliceNamecommunicationTemplate
Definition

ID or url reference to template to be used for communication

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationTemplate) (Extension Type: Choice of: string, Attachment)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. Communication.extension:communicationPayloadData
SliceNamecommunicationPayloadData
Definition

Contains dynamic data elements and vendor / medium specific elements to be included in the message payload

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationPayloadData) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. Communication.extension:communicationVendor
SliceNamecommunicationVendor
Definition

Vendor used to send the communication

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationVendor) (Extension Type: Reference(Organization)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Communication.extension:conversationType
SliceNameconversationType
Definition

Type of conversation, used for chat communications

Control0..1
TypeExtension(ConversationType) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. Communication.extension:communicationReengagement
SliceNamecommunicationReengagement
Definition

Sequence for subsequent communication attempts to reengage the patient

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..1*
TypeExtension(CommunicationReengagement) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
17. Communication.extension:communicationRetryLimit
SliceNamecommunicationRetryLimit
Definition

Retry limit configuration, may vary by medium and vendor

Control0..1
TypeExtension(CommunicationRetryLimit) (Extension Type: Choice of: string, unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
18. Communication.extension:sentToVendor
SliceNamesentToVendor
Definition

Records date/time and outcome of communications sent to vendor

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

TypeExtension(SentToVendor) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
19. Communication.extension:sentToRecipient
SliceNamesentToRecipient
Definition

Records date/time and outcome of communication attempts with the recipient

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

TypeExtension(SentToRecipient) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
20. Communication.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
21. Communication.basedOn
Definition

An order, proposal or plan fulfilled in whole or in part by this Communication.

Control0..*
TypeReference(EngagementCommunicationRequest|Resource))
Alternate Namesfulfills
Comments

This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Communication.partOf
Definition

Part of this action.

Control0..0*
TypeReference(Resource))
Alternate Namescontainer
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Communication.inResponseTo
Definition

Prior communication that this communication is in response to.

Control0..0*
TypeReference(Communication))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Communication.status
Definition

The status of the transmission.

Control1..1
BindingThe codes SHALL be taken from EventStatus

The status of the communication.

Typecode
Is Modifiertrue
Comments

This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Communication.statusReason
Definition

Captures the reason for the current state of the Communication.

Control0..1
BindingFor example codes, see Engagement Communication Status Reason Value SetFor example codes, see CommunicationNotDoneReason
TypeCodeableConcept
Alternate NamesSuspended Reason, Cancelled Reason
Comments

This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Communication.medium
Definition

Medium used as the mode of communication for engagement (phone | sms | email | mail | chat)

A channel that was used for this communication (e.g. email, fax).

Control10..1*
BindingThe codes SHOULD be taken from Engagement Communication Mode Value SetFor example codes, see ParticipationMode
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Communication.topic
Definition

Description of the purpose/content, similar to a subject line in an email.

Control0..01
BindingFor example codes, see CommunicationTopic

Codes describing the purpose or content of the communication.

TypeCodeableConcept
Comments

Communication.topic.text can be used without any codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Communication.about
Definition

Other resources that pertain to this communication and to which this communication should be associated.

Control0..*
TypeReference(MeasurePopulationObservation|CareGapDetectedIssue|Resource))
Comments

Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Communication.encounter
Definition

The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

Control0..01
TypeReference(Encounter))
Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Communication.sent
Definition

The time when this communication was sent.

Control0..01
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Communication.reasonCode
Definition

The reason or justification for the communication.

Control0..0*
BindingFor example codes, see SNOMEDCTClinicalFindings

Codes for describing reasons for the occurrence of a communication.

TypeCodeableConcept
Comments

Textual reasons can be captured using reasonCode.text.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Communication.reasonReference
Definition

Indicates another resource whose existence justifies this communication.

Control0..0*
TypeReference(Condition|Observation|DiagnosticReport|DocumentReference))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Communication.note
Definition

Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Control0..0*
TypeAnnotation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Communication
Definition

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.

Control0..*
2. Communication.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Communication.meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1 This element is affected by the following invariants: ele-1
TypeMeta(ProcessMeta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Communication.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Communication.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Communication.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrativehtmlxhtmldisplay
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Communication.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..0
TypeResource
Alternate Namesinline resourcesanonymous resourcescontained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. Communication.extension
Definition

An Extension

Control3..*
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Communication.extension:communicationProduct
SliceNamecommunicationProduct
Definition

Product generating the communication

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationProduct) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Communication.extension:communicationOnBehalfOf
SliceNamecommunicationOnBehalfOf
Definition

Attributed provider, location, or organization communication is on-behalf of

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationOnBehalfOf) (Extension Type: Reference(PractitionerPractitionerRoleOrganizationLocation)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Communication.extension:communicationContact
SliceNamecommunicationContact
Definition

Phone number, email, or address to contact

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationContact) (Extension Type: Choice of: Address, ContactPoint(CDMCommunicationContactPoint))
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Communication.extension:communicationMeasure
SliceNamecommunicationMeasure
Definition

Reference to the measure that resulted in the communication

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationMeasure) (Extension Type: Reference(Measure)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. Communication.extension:communicationCareGap
SliceNamecommunicationCareGap
Definition

ID of care gap for which we are communicating

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationCareGap) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. Communication.extension:communicationPrioritySequence
SliceNamecommunicationPrioritySequence
Definition

Priority of the communication request (1 = highest)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationPrioritySequence) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Communication.extension:communicationLanguage
SliceNamecommunicationLanguage
Definition

Language used for communication messaging content

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationLanguage) (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. Communication.extension:communicationTemplate
SliceNamecommunicationTemplate
Definition

ID or url reference to template to be used for communication

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationTemplate) (Extension Type: Choice of: string, Attachment)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. Communication.extension:communicationPayloadData
SliceNamecommunicationPayloadData
Definition

Contains dynamic data elements and vendor / medium specific elements to be included in the message payload

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationPayloadData) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
18. Communication.extension:communicationVendor
SliceNamecommunicationVendor
Definition

Vendor used to send the communication

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CommunicationVendor) (Extension Type: Reference(Organization)))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. Communication.extension:conversationType
SliceNameconversationType
Definition

Type of conversation, used for chat communications

Control0..1
TypeExtension(ConversationType) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. Communication.extension:communicationReengagement
SliceNamecommunicationReengagement
Definition

Sequence for subsequent communication attempts to reengage the patient

Control0..1
TypeExtension(CommunicationReengagement) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
21. Communication.extension:communicationRetryLimit
SliceNamecommunicationRetryLimit
Definition

Retry limit configuration, may vary by medium and vendor

Control0..1
TypeExtension(CommunicationRetryLimit) (Extension Type: Choice of: string, unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
22. Communication.extension:sentToVendor
SliceNamesentToVendor
Definition

Records date/time and outcome of communications sent to vendor

Control0..*
TypeExtension(SentToVendor) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
23. Communication.extension:sentToRecipient
SliceNamesentToRecipient
Definition

Records date/time and outcome of communication attempts with the recipient

Control0..*
TypeExtension(SentToRecipient) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Communication.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. Communication.identifier
Definition

Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Communication.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

Control0..*
Typecanonical(PlanDefinitionActivityDefinitionMeasureOperationDefinitionQuestionnaire))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Communication.instantiatesUri
Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

Control0..*
Typeuri
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Communication.basedOn
Definition

An order, proposal or plan fulfilled in whole or in part by this Communication.

Control0..*
TypeReference(EngagementCommunicationRequest))
Alternate Namesfulfills
Comments

This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Communication.partOf
Definition

Part of this action.

Control0..0
TypeReference(Resource))
Alternate Namescontainer
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Communication.inResponseTo
Definition

Prior communication that this communication is in response to.

Control0..0
TypeReference(Communication))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Communication.status
Definition

The status of the transmission.

Control1..1
BindingThe codes SHALL be taken from EventStatus The status of the communication
Typecode
Is Modifiertrue
Comments

This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Communication.statusReason
Definition

Captures the reason for the current state of the Communication.

Control0..1
BindingFor example codes, see Engagement Communication Status Reason Value Set
TypeCodeableConcept
Alternate NamesSuspended ReasonCancelled Reason
Comments

This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Communication.category
Definition

The type of message conveyed such as alert, notification, reminder, instruction, etc.

Control0..*
BindingFor example codes, see CommunicationCategory Codes for general categories of communications such as alerts, instructions, etc
TypeCodeableConcept
Comments

There may be multiple axes of categorization and one communication may serve multiple purposes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Communication.priority
Definition

Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.

Control0..1
BindingThe codes SHALL be taken from RequestPriority Codes indicating the relative importance of a communication
Typecode
Comments

Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.

Meaning if MissingIf missing, this communication should be treated with normal priority
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Communication.medium
Definition

Medium used as the mode of communication for engagement (phone | sms | email | mail | chat)

Control1..1
BindingThe codes SHOULD be taken from Engagement Communication Mode Value Set
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Communication.subject
Definition

The patient or group that was the focus of this communication.

Control0..1
TypeReference(PatientGroup))
Alternate Namespatient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Communication.topic
Definition

Description of the purpose/content, similar to a subject line in an email.

Control0..0
BindingFor example codes, see CommunicationTopic Codes describing the purpose or content of the communication
TypeCodeableConcept
Comments

Communication.topic.text can be used without any codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Communication.about
Definition

Other resources that pertain to this communication and to which this communication should be associated.

Control0..*
TypeReference(MeasurePopulationObservationCareGapDetectedIssue))
Comments

Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Communication.encounter
Definition

The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

Control0..0
TypeReference(Encounter))
Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Communication.sent
Definition

The time when this communication was sent.

Control0..0
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Communication.received
Definition

The time when this communication arrived at the destination.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Communication.recipient
Definition

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).

Control0..*
TypeReference(DeviceOrganizationPatientPractitionerPractitionerRoleRelatedPersonGroupCareTeamHealthcareService))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Communication.sender
Definition

The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

Control0..1
TypeReference(DeviceOrganizationPatientPractitionerPractitionerRoleRelatedPersonHealthcareService))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Communication.reasonCode
Definition

The reason or justification for the communication.

Control0..0
BindingFor example codes, see SNOMEDCTClinicalFindings Codes for describing reasons for the occurrence of a communication
TypeCodeableConcept
Comments

Textual reasons can be captured using reasonCode.text.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Communication.reasonReference
Definition

Indicates another resource whose existence justifies this communication.

Control0..0
TypeReference(ConditionObservationDiagnosticReportDocumentReference))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Communication.payload
Definition

Text, attachment(s), or resource(s) that was communicated to the recipient.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Communication.payload.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
48. Communication.payload.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
49. Communication.payload.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
50. Communication.payload.content[x]
Definition

A communicated content (or for multi-part communications, one portion of the communication).

Control1..1
TypeChoice of: string, Attachment, Reference(Resource))
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Communication.note
Definition

Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Control0..0
TypeAnnotation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))