FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R4 R3 R2

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

Detailed Descriptions for the elements in the Communication resource.

Requirements Invariants Communication.category Alternate Names
Communication
Element Id 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.

Control Cardinality 1..1 0..*
Invariants Type Defined on this element com-1 : Not Done Reason can only be specified if NotDone is "true" ( expression DomainResource : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason)))
Communication.identifier
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 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.

Communication.definition Communication.instantiatesCanonical
Element Id Communication.instantiatesCanonical
Definition

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

Control Cardinality 0..*
Type Reference canonical ( PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire )
Summary true
Communication.instantiatesUri
Element Id 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.

Cardinality 0..*
Type uri
Summary true
Comments

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

Communication.basedOn
Element Id Communication.basedOn
Definition

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

Control Cardinality 0..*
Type Reference ( Any )
Alternate Names fulfills
Summary true
Comments

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

Communication.partOf
Element Id Communication.partOf
Definition

Part of this action.

Control Cardinality 0..*
Type Reference ( Any )
Alternate Names container
Summary true
Communication.inResponseTo
Element Id Communication.inResponseTo
Definition

Prior communication that this communication is in response to.

Cardinality 0..*
Type Reference ( Communication )
Communication.status
Element Id Communication.status
Definition

The status of the transmission.

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

Communication.notDone Communication.statusReason
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.

Control Cardinality 0..1
Type Terminology Binding boolean CommunicationNotDoneReason ( 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.

Communication.notDoneReason Communication.category
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.

Control Cardinality 0..1 0..*
Terminology Binding CommunicationNotDoneReason CommunicationCategory ( Example )
Type CodeableConcept
Summary Comments true

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

Affect this element Communication.priority com-1 : Not Done Reason can only be specified if NotDone is "true" ( expression : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason)))
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.

Control Cardinality 0..* 0..1
Terminology Binding CommunicationCategory Request priority ( Example Required )
Type CodeableConcept code
Meaning if Missing If missing, this communication should be treated with normal priority
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.

Communication.medium
Element Id Communication.medium
Definition

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

Control Cardinality 0..*
Terminology Binding v3 Code System ParticipationMode ( Example )
Type CodeableConcept
Communication.subject
Element Id Communication.subject
Definition

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

Control Cardinality 0..1
Type Reference ( Patient | Group )
Alternate Names patient
Summary true
Communication.recipient Communication.topic
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 to be tracked by individual, a separate resource instance will need purpose/content, similar 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.

Control Cardinality 0..* 0..1
Type Terminology Binding Reference CommunicationTopic ( Device | Organization | Patient | Practitioner Example | RelatedPerson )
Type | Group CodeableConcept )
Comments

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

Communication.topic Communication.about
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.

Control Cardinality 0..*
Type Reference ( Any )
Comments

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

Communication.context Communication.encounter
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.

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

Communication.sent
Element Id Communication.sent
Definition

The time when this communication was sent.

Control Cardinality 0..1
Type dateTime
Communication.received
Element Id Communication.received
Definition

The time when this communication arrived at the destination.

Control Cardinality 0..1
Type dateTime
Communication.recipient
Element Id 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).

Cardinality 0..*
Type Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService )
Communication.sender
Element Id Communication.sender
Definition

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

Control Cardinality 0..1
Type Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService )
Communication.reasonCode
Element Id Communication.reasonCode
Definition

The reason or justification for the communication.

Control Cardinality 0..*
Terminology Binding SNOMED CT Clinical Findings ( Example )
Type CodeableConcept
Summary true
Comments

Textual reasons can be caprued captured using reasonCode.text.

Communication.reasonReference
Element Id Communication.reasonReference
Definition

Indicates another resource whose existence justifies this communication.

Control Cardinality 0..*
Type Reference ( Condition | Observation | DiagnosticReport | DocumentReference )
Summary true
Communication.payload
Element Id Communication.payload
Definition

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

Control Cardinality 0..*
Communication.payload.content[x]
Element Id Communication.payload.content[x]
Definition

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

Control Cardinality 1..1
Type string | Attachment | Reference ( Any )
[x] Note See Choice of Data Types for further information about how to use [x]
Communication.note
Element Id Communication.note
Definition

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

Control Cardinality 0..*
Type Annotation