FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Patient Care icon Work Group   Normative Maturity Level : 2   Trial Use Security Category : Patient Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson

Detailed Descriptions for the elements in the Communication resource.

Control Control Control Control Alternate Names container Control Control Requirements Control Control Control Control Control Control Alternate Names Control Control Comments Control Control Control
Definition Element Id Communication
Definition

An occurrence A clinical or business level record of information being transmitted; transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency was notified about communication to a provider/reporter in response to a case report for a reportable condition.

Short Display A clinical or business level record of information being transmitted or shared
Cardinality 1..1 0..*
Invariants Type Defined on this element DomainResource com-1 : Not Done Reason can only be specified if NotDone is "true" ( expression
Summary : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason))) false
Definition Element Id Communication.identifier
Definition

Identifiers associated with Business identifiers assigned to this Communication that are defined communication by business processes and/ the performer or used to refer to it when a direct URL reference to other systems which remain constant as the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). updated and propagates from server to server.

Note Short Display Unique identifier
Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Requirements

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

Summary true
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.

Definition Element Id Communication.basedOn
Definition

A protocol, guideline, An order, proposal or other definition that was adhered to plan fulfilled in whole or in part by this communication event. Communication.

Short Display Request fulfilled by this communication
Cardinality 0..*
Type Reference ( PlanDefinition CarePlan | ActivityDefinition CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | Task | VisionPrescription )
Alternate Names fulfills
Summary true
Definition Element Id Communication.partOf
Definition

An order, proposal or plan fulfilled in whole or in part by A larger event (e.g. Communication, Procedure) of which this Communication. particular communication is a component or step.

Short Display Part of referenced event (e.g. Communication, Procedure)
Cardinality 0..*
Type Reference ( Any )
Hierarchy This reference is part of a strict Hierarchy
Alternate Names fulfills container
Summary true
Comments

This must point to some sort The event the communication was part of a 'Request' resource, such - e.g. if you disclosed as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc. "part" of counselling, it would be partOf that Procedure.

Definition Element Id Communication.inResponseTo
Definition

Part of Prior communication that this action. communication is in response to.

Short Display Reply to
Cardinality 0..*
Type Reference ( Any Communication )
Summary true false
Definition Element Id Communication.status
Definition

The status of the transmission.

Short Display preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Cardinality 1..1
Terminology Binding EventStatus ( Required )
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summary true
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.

Definition Element Id Communication.statusReason
Definition

If true, indicates that Captures the described communication event did not actually occur. reason for the current state of the Communication.

Short Display Reason for current status
Cardinality 0..1
Type Terminology Binding boolean Communication Not Done Reason ( Example )
Is Modifier Type true CodeableConcept
Alternate Names Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. Suspended Reason; Cancelled Reason
Summary true
Comments

This element is labeled as a modifier because it marks the communication generally only used for "exception" statuses such as a communication that did not occur. "not-done", "suspended" or "aborted". The more attributes are populated, the more constrained reason for performing the negated statement is. event at all is captured in reasonCode, not here.

Definition Element Id Communication.category
Definition

Describes why the communication event did not occur in coded and/or textual form. The type of message conveyed such as alert, notification, reminder, instruction, etc.

Short Display Message category
Control Cardinality 0..1 0..*
Terminology Binding CommunicationNotDoneReason Communication Category ( Example )
Type CodeableConcept
Summary true false
Invariants Comments Affect this element com-1 : Not Done Reason can only

There may be specified if NotDone is "true" ( expression : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason))) multiple axes of categorization and one communication may serve multiple purposes.

Definition Element Id Communication.priority
Definition

The type of message conveyed Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as alert, notification, reminder, instruction, etc. stat, urgent, routine.

Short Display routine | urgent | asap | stat
Cardinality 0..* 0..1
Terminology Binding CommunicationCategory RequestPriority ( Example Required )
Type code
Meaning if Missing If missing, this communication should be treated with normal priority
CodeableConcept Summary true
Comments

There may be multiple axes of categorization and one Used to prioritize workflow (such as which communication may serve multiple purposes. to read first) when the communication is planned or in progress.

Definition Element Id Communication.medium
Definition

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

Short Display A channel of communication
Cardinality 0..*
Terminology Binding v3 Code System ParticipationMode icon ( Example )
Type CodeableConcept
Summary false
Definition Element Id Communication.subject
Definition

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

Short Display Focus of message
Cardinality 0..1
Type Reference ( Patient | Group )
Alternate Names patient
Summary true
Definition Element Id Communication.topic
Definition

The entity (e.g. person, organization, clinical information system, or device) which was the target Description of the communication. If receipts need purpose/content, similar to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured subject line in aggregate (all emails confirmed received by a particular time). an email.

Short Display Description of the purpose/content
Cardinality 0..* 0..1
Type Terminology Binding Reference Communication Topic ( Device | Organization | Patient Example | Practitioner )
Type | RelatedPerson CodeableConcept | Group
Summary ) false
Comments

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

Definition Element Id Communication.about
Definition

The Other resources which were responsible for or related that pertain to producing this communication. communication and to which this communication should be associated.

Short Display Resources that pertain to this communication
Cardinality 0..*
Type Reference ( Any )
Summary false
Comments

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

Definition Element Id Communication.encounter
Definition

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

Short Display The Encounter during which this Communication was created
Cardinality 0..1
Type Reference ( Encounter | EpisodeOfCare )
Summary encounter true
Summary Comments true

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.

Definition Element Id Communication.sent
Definition

The time when this communication was sent.

Short Display When sent
Control Cardinality 0..1
Type dateTime
Summary false
Definition Element Id Communication.received
Definition

The time when this communication arrived at the destination.

Short Display When received
Cardinality 0..1
Type dateTime
Summary false
Definition Element Id Communication.recipient
Definition

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

Short Display Who the information is shared with
Cardinality 0..1 0..*
Type Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint )
Summary false
Comments

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

Definition Element Id Communication.sender
Definition

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

Control Short Display 0..* Who shares the information
Terminology Binding Cardinality SNOMED CT Clinical Findings ( Example ) 0..1
Type CodeableConcept Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam )
Summary true false
Element Id Communication.reason
Definition

Indicates another resource whose existence justifies this The reason or justification for the communication.

Short Display Indication for message
Cardinality 0..*
Terminology Binding SNOMED CT Clinical Findings ( Example )
Type Reference CodeableReference ( Condition | Observation Any )
Summary true
Comments

Textual reasons can be captured using reason.concept.text.

Definition Element Id Communication.payload
Definition

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

Short Display Message payload
Cardinality 0..*
Summary false
Definition Element Id Communication.payload.content[x]
Definition

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

Short Display Message part content
Cardinality 1..1
Type string | Attachment | Reference ( Any ) )| CodeableConcept
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Summary false
Comments

The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.

If the content isn't codified, contentCodeableConcept.text can be used.

When using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.

Definition Element Id Communication.note
Definition

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

Short Display Comments made about the communication
Control Cardinality 0..*
Type Annotation
Summary false