STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.5.1.4 StructureDefinition: QICore-Communication - Detailed Descriptions

Definitions for the qicore-communication Profile.

Communication(QICore-Communication)
Definition

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.

Control0..*
TypeCommunication
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. Bundles always have an id, though it is usually a generated UUID.

Communication.meta
Definition

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

Control0..1
TypeMeta
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.

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 as much as possible.

Communication.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
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).

Communication.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

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

Communication.extension (http://hl7.org/fhir/StructureDefinition/communication-reasonNotPerformed)
Definition

Explanation for rejection or failure of the communication. Applicable only if the status is suspended, rejected, or failed.

Control0..1
TypeExtension (Extension Type: CodeableConcept)
Comments

We need a value set for this field.

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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

Communication.identifier
Definition

Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Control0..*
TypeIdentifier
Communication.category
Definition

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

Control0..1
BindingCodes for general categories of communications such as alerts, instruction, etc.
TypeCodeableConcept
Must Supporttrue
Communication.sender
Definition

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

Control0..1
TypeChoice of: Reference(QICore-Practitioner), Reference(QICore-Patient), Reference(QICore-Device), Reference(QICore-RelatedPerson), Reference(QICore-Organization)
Must Supporttrue
Communication.recipient
Definition

The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need 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 in aggregate (all emails confirmed received by a particular time).

Control0..*
TypeChoice of: Reference(QICore-Device), Reference(QICore-Organization), Reference(QICore-Patient), Reference(QICore-Practitioner), Reference(QICore-RelatedPerson), Reference(Group)
Must Supporttrue
Communication.payload
Definition

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

Control0..*
TypeBackboneElement
Communication.payload.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Communication.payload.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
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.

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

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]
Communication.medium
Definition

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

Control0..*
BindingThe type of channel used for the communication, for example, telephone, fax, email.
For example codes, see QICore Communication Medium Codes
TypeCodeableConcept
Communication.status
Definition

The status of the transmission.

Control0..1
BindingThe status of the communication.
The codes SHALL be taken from CommunicationStatus
Typecode
Is Modifiertrue
Must Supporttrue
Communication.encounter
Definition

The encounter within which the communication was sent.

Control0..1
TypeReference(QICore-Encounter)
Must Supporttrue
Communication.sent
Definition

The time when this communication was sent.

Control0..1
TypedateTime
Must Supporttrue
Communication.received
Definition

The time when this communication arrived at the destination.

Control0..1
TypedateTime
Must Supporttrue
Communication.reason
Definition

The reason or justification for the communication.

Control0..*
BindingCodes for describing reasons for the occurrence of a communication.
TypeCodeableConcept
Communication.subject
Definition

The patient who was the focus of this communication.

Control0..1
TypeReference(QICore-Patient)
Must Supporttrue
Communication.requestDetail
Definition

The communication request that was responsible for producing this communication.

Control0..1
TypeReference(CommunicationRequest)