Imaging Diagnostic Report
0.0.1-current - ci-build International flag

Imaging Diagnostic Report, published by IHE Radiology Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/RAD.IDR/ and changes regularly. See the Directory of published versions

Resource Profile: IDRCommunication - Detailed Descriptions

Draft as of 2025-09-14

Definitions for the idr-communication resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Communication
2. Communication.text
Definition

A summary sentence describing the communication, as currently appears in report narratives.

Control1..?
Must Supporttrue
4. Communication.basedOn
Comments

This is often absent unless there was a specific request for the communication that can be referenced. See communication.reason for communications triggered by specific impression findings.

6. Communication.partOf
Comments

The current diagnostic report, which provides the context of the communication

Control1..1
TypeReference(IDR Imaging DiagnosticReport)
Must Supporttrue
8. Communication.status
Comments

Should be COMPLETED in many cases. When documenting attempted communications, the status might have another value.

Communication resources where the .status is not COMPLETED may trigger subsequent follow-up workflows, but the management of such follow-up is not reflected in the diagnostic report.

In some reporting workflows, such communications may be included in an Addendum to the report (e.g. when the report is distributed prior to the communication being successfully completed).

10. Communication.medium
Comments

For imaging, the value will typically be PHONE, or in the case of leaving a voicemail message, DICTATE.

Must Supporttrue
12. Communication.subject
Control1..?
TypeReference(Patient)
Must Supporttrue
14. Communication.topic
Comments

May contain the code for "summary-report". Sites may wish to use a code for critical findings.

Must Supporttrue
16. Communication.about
Comments

May reference any or all of the specific impression Conditions or recommendation ServiceRequests discussed during the communication if such information is made available to the encoding system.

TypeReference(IDR Report Impression Condition, IDR Recommendation ServiceRequest)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
18. Communication.encounter
Comments

Should either reference the encounter for the imaging procedure, or be absent.

20. Communication.sent
Control1..?
Must Supporttrue
22. Communication.received
Comments

For phone communications, this value will typically be the same time as Communication.sent. In the case of leaving a message, this will likely be be absent since it won't be known and the resource is not expected to be updated.

Must Supporttrue
24. Communication.recipient
Comments

For imaging, the value should be the patient or the referring clinician in most cases, but may be their staff.

Must Supporttrue
26. Communication.sender
Comments

For imaging, the value should be the imaging clinician in most cases but may be their staff.

Must Supporttrue
28. Communication.reason
Comments

May reference one or more of the specific impression Conditions or recommendation ServiceRequests that prompted the communication.

TypeCodeableReference(IDR Report Impression Condition, IDR Recommendation ServiceRequest)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles

Guidance on how to interpret the contents of this table can be foundhere

0. Communication
Definition

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

ShortA clinical or business level record of information being transmitted or shared
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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.

ShortA set of rules under which this content was created
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 its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Communication.text
Definition

A summary sentence describing the communication, as currently appears in report narratives.


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.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a 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.

Control10..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Communication.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline 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. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. 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 managable, 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Communication.basedOn
Definition

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

ShortRequest fulfilled by this communication
Comments

This is often absent unless there was a specific request for the communication that can be referenced. See communication.reason for communications triggered by specific impression findings.

Control0..*
TypeReference(CarePlan, CommunicationRequest, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest, Task, VisionPrescription)
Is Modifierfalse
Must Supportfalse
Summarytrue
Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Communication.partOf
Definition

A larger event (e.g. Communication, Procedure) of which this particular communication is a component or step.

ShortPart of referenced event (e.g. Communication, Procedure)
Comments

The current diagnostic report, which provides the context of the communication


The event the communication was part of - e.g. if you disclosed as "part" of counselling, it would be partOf that Procedure.

Control10..1*
TypeReference(IDR Imaging DiagnosticReport, Resource)
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate Namescontainer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Communication.status
Definition

The status of the transmission.

Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments

Should be COMPLETED in many cases. When documenting attempted communications, the status might have another value.

Communication resources where the .status is not COMPLETED may trigger subsequent follow-up workflows, but the management of such follow-up is not reflected in the diagnostic report.

In some reporting workflows, such communications may be included in an Addendum to the report (e.g. when the report is distributed prior to the communication being successfully completed).


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.

Control1..1
BindingThe codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status|6.0.0-ballot3
(required to http://hl7.org/fhir/ValueSet/event-status|6.0.0-ballot3)

The status of the communication.

Typecode
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Communication.medium
Definition

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

ShortA channel of communication
Comments

For imaging, the value will typically be PHONE, or in the case of leaving a voicemail message, DICTATE.

Control0..*
BindingFor example codes, see ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode
(example to http://terminology.hl7.org/ValueSet/v3-ParticipationMode)

Codes for communication mediums such as phone, fax, email, in person, etc.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Communication.subject
Definition

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

ShortFocus of message
Control10..1
TypeReference(Patient, Patient, Group)
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate Namespatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Communication.topic
Definition

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

ShortDescription of the purpose/content
Comments

May contain the code for "summary-report". Sites may wish to use a code for critical findings.


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

Control0..1
BindingFor example codes, see CommunicationTopichttp://hl7.org/fhir/ValueSet/communication-topic|6.0.0-ballot3
(example to http://hl7.org/fhir/ValueSet/communication-topic|6.0.0-ballot3)

Codes describing the purpose or content of the communication.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Communication.about
Definition

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

ShortResources that pertain to this communication
Comments

May reference any or all of the specific impression Conditions or recommendation ServiceRequests discussed during the communication if such information is made available to the encoding system.


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

Control0..*
TypeReference(IDR Report Impression Condition, IDR Recommendation ServiceRequest, Resource)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Communication.encounter
Definition

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

ShortThe Encounter during which this Communication was created
Comments

Should either reference the encounter for the imaging procedure, or be absent.


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.

Control0..1
TypeReference(Encounter)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Communication.sent
Definition

The time when this communication was sent.

ShortWhen sent
Control10..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Communication.received
Definition

The time when this communication arrived at the destination.

ShortWhen received
Comments

For phone communications, this value will typically be the same time as Communication.sent. In the case of leaving a message, this will likely be be absent since it won't be known and the resource is not expected to be updated.

Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Communication.recipient
Definition

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

ShortWho the information is shared with
Comments

For imaging, the value should be the patient or the referring clinician in most cases, but may be their staff.


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(CareTeam, Device, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Endpoint)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Communication.sender
Definition

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

ShortWho shares the information
Comments

For imaging, the value should be the imaging clinician in most cases but may be their staff.

Control0..1
TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService, Endpoint, CareTeam)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Communication.reason
Definition

The reason or justification for the communication.

ShortIndication for message
Comments

May reference one or more of the specific impression Conditions or recommendation ServiceRequests that prompted the communication.


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

Control0..*
BindingFor example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|6.0.0-ballot3
(example to http://hl7.org/fhir/ValueSet/clinical-findings|6.0.0-ballot3)

Codes for describing reasons for the occurrence of a communication.

TypeCodeableReference(IDR Report Impression Condition, IDR Recommendation ServiceRequest, Resource)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Communication
Definition

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

ShortA clinical or business level record of information being transmitted or shared
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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.id
Definition

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

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Communication.meta
Definition

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

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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.

ShortA set of rules under which this content was created
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 its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Communication.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Communication.text
Definition

A summary sentence describing the communication, as currently appears in report narratives.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a 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.

Control1..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Communication.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline 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. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Communication.extension
Definition

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 managable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. 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 managable, 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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.

ShortUnique identifier
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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Communication.basedOn
Definition

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

ShortRequest fulfilled by this communication
Comments

This is often absent unless there was a specific request for the communication that can be referenced. See communication.reason for communications triggered by specific impression findings.

Control0..*
TypeReference(CarePlan, CommunicationRequest, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest, Task, VisionPrescription)
Is Modifierfalse
Must Supportfalse
Summarytrue
Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Communication.partOf
Definition

A larger event (e.g. Communication, Procedure) of which this particular communication is a component or step.

ShortPart of referenced event (e.g. Communication, Procedure)
Comments

The current diagnostic report, which provides the context of the communication

Control1..1
TypeReference(IDR Imaging DiagnosticReport)
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate Namescontainer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Communication.inResponseTo
Definition

Prior communication that this communication is in response to.

ShortReply to
Control0..*
TypeReference(Communication)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Communication.status
Definition

The status of the transmission.

Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments

Should be COMPLETED in many cases. When documenting attempted communications, the status might have another value.

Communication resources where the .status is not COMPLETED may trigger subsequent follow-up workflows, but the management of such follow-up is not reflected in the diagnostic report.

In some reporting workflows, such communications may be included in an Addendum to the report (e.g. when the report is distributed prior to the communication being successfully completed).

Control1..1
BindingThe codes SHALL be taken from EventStatus
(required to http://hl7.org/fhir/ValueSet/event-status|6.0.0-ballot3)

The status of the communication.

Typecode
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Communication.statusReason
Definition

Captures the reason for the current state of the Communication.

ShortReason for current status
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.

Control0..1
BindingFor example codes, see CommunicationNotDoneReason
(example to http://hl7.org/fhir/ValueSet/communication-not-done-reason|6.0.0-ballot3)

Codes for the reason why a communication did not happen.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Alternate NamesSuspended Reason, Cancelled Reason
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Communication.category
Definition

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

ShortMessage category
Comments

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

Control0..*
BindingFor example codes, see CommunicationCategory
(example to http://hl7.org/fhir/ValueSet/communication-category|6.0.0-ballot3)

Codes for general categories of communications such as alerts, instructions, etc.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Communication.priority
Definition

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

Shortroutine | urgent | asap | stat
Comments

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

Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|6.0.0-ballot3)

Codes indicating the relative importance of a communication.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Meaning if MissingIf missing, this communication should be treated with normal priority
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Communication.medium
Definition

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

ShortA channel of communication
Comments

For imaging, the value will typically be PHONE, or in the case of leaving a voicemail message, DICTATE.

Control0..*
BindingFor example codes, see ParticipationMode
(example to http://terminology.hl7.org/ValueSet/v3-ParticipationMode)

Codes for communication mediums such as phone, fax, email, in person, etc.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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.

ShortFocus of message
Control1..1
TypeReference(Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate Namespatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Communication.topic
Definition

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

ShortDescription of the purpose/content
Comments

May contain the code for "summary-report". Sites may wish to use a code for critical findings.

Control0..1
BindingFor example codes, see CommunicationTopic
(example to http://hl7.org/fhir/ValueSet/communication-topic|6.0.0-ballot3)

Codes describing the purpose or content of the communication.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Communication.about
Definition

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

ShortResources that pertain to this communication
Comments

May reference any or all of the specific impression Conditions or recommendation ServiceRequests discussed during the communication if such information is made available to the encoding system.

Control0..*
TypeReference(IDR Report Impression Condition, IDR Recommendation ServiceRequest)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Communication.encounter
Definition

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

ShortThe Encounter during which this Communication was created
Comments

Should either reference the encounter for the imaging procedure, or be absent.

Control0..1
TypeReference(Encounter)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Communication.sent
Definition

The time when this communication was sent.

ShortWhen sent
Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Communication.received
Definition

The time when this communication arrived at the destination.

ShortWhen received
Comments

For phone communications, this value will typically be the same time as Communication.sent. In the case of leaving a message, this will likely be be absent since it won't be known and the resource is not expected to be updated.

Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Communication.recipient
Definition

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

ShortWho the information is shared with
Comments

For imaging, the value should be the patient or the referring clinician in most cases, but may be their staff.

Control0..*
TypeReference(CareTeam, Device, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Endpoint)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Communication.sender
Definition

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

ShortWho shares the information
Comments

For imaging, the value should be the imaging clinician in most cases but may be their staff.

Control0..1
TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService, Endpoint, CareTeam)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Communication.reason
Definition

The reason or justification for the communication.

ShortIndication for message
Comments

May reference one or more of the specific impression Conditions or recommendation ServiceRequests that prompted the communication.

Control0..*
BindingFor example codes, see SNOMEDCTClinicalFindings
(example to http://hl7.org/fhir/ValueSet/clinical-findings|6.0.0-ballot3)

Codes for describing reasons for the occurrence of a communication.

TypeCodeableReference(IDR Report Impression Condition, IDR Recommendation ServiceRequest)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Communication.payload
Definition

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

ShortMessage payload
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
56. 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.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
58. 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 managable, 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. 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 managable, 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Communication.payload.content[x]
Definition

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

ShortMessage part content
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.

Control1..1
TypeChoice of: Attachment, Reference(Resource), CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Communication.note
Definition

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

ShortComments made about the communication
Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))