DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

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 . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

5.22 5.24 Resource CommunicationRequest - Content Resource CommunicationRequest - Content

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
Patient Care Patient Care Work Group Work Group Maturity Level : 1 Maturity Level : 1 Compartments : : Device , , Encounter , , Patient , , Practitioner , , RelatedPerson

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

5.22.1 Scope and Usage 5.24.1 Scope and Usage This resource is a record of a request for a communication to be performed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The sender and receivers may be patients, practitioners, related persons, organizations, and devices. Uses of communication request include: A computer-based decision-support system requesting a reminder or alert be delivered to a responsible provider A physician requesting notification from the nurse if a patient's temperature exceeds a value A monitoring system or a provider requesting a staff member or department to notify a public health agency of a patient presenting with a communicable disease reportable to the public health agency A computer-based decision-support system proposes to send educational material to a patient

This resource is a record of a request for a communication to be performed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The sender and receivers may be patients, practitioners, related persons, organizations, and devices. Uses of communication request include:

  • A computer-based decision-support system requesting a reminder or alert be delivered to a responsible provider
  • A physician requesting notification from the nurse if a patient's temperature exceeds a value
  • A monitoring system or a provider requesting a staff member or department to notify a public health agency of a patient presenting with a communicable disease reportable to the public health agency
  • A computer-based decision-support system proposes to send educational material to a patient

5.22.2 Boundaries and Relationships 5.24.2 Boundaries and Relationships This resource is a record of a request. It does not represent the actual flow of communication. The use of

This resource is a record of a request. It does not represent the actual flow of communication. The use of CommunicationRequest excludes requests for referrals which are covered by the excludes requests for referrals which are covered by the ReferralRequest resource. It also excludes requests for therapy or counseling which would be handled by the resource. It also excludes requests for therapy or counseling which would be handled by the ProcedureRequest resource. The performance of a resource. The performance of a CommunicationRequest may result in a may result in a Communication resource. This resource is referenced by resource.

This resource is referenced by CarePlan , , ClinicalImpression and and Communication

5.22.3 Resource Content 5.24.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . CommunicationRequest Σ DomainResource A request for information to be sent to a receiver A request for information to be sent to a receiver
. . . identifier Σ 0..* Identifier Unique identifier Unique identifier
. . . category Σ 0..1 CodeableConcept Message category Message category
. . . sender Σ 0..1 Reference ( Device | | Organization | | Patient | | Practitioner | | RelatedPerson ) Message sender Message sender
. . . recipient Σ 0..* Reference ( Device | | Organization | | Patient | | Practitioner | | RelatedPerson ) Message recipient Message recipient
. . . payload Σ 0..* BackboneElement Message payload Message payload
. . . . content[x] Σ 1..1 Message part content Message part content
. . . . . contentString string
. . . . . contentAttachment Attachment
. . . . contentReference . contentReference Reference ( Any )
. . . medium Σ 0..* CodeableConcept A channel of communication A channel of communication
v3 Code System ParticipationMode ( v3 Code System ParticipationMode ( Example )
. . . requester Σ 0..1 Reference ( Practitioner | | Patient | | RelatedPerson ) An individual who requested a communication An individual who requested a communication
. . . status ?! ?! Σ 0..1 code proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
CommunicationRequestStatus ( ( Required )
. . . encounter Σ 0..1 Reference ( Encounter ) Encounter leading to message Encounter leading to message
. . . scheduled[x] Σ 0..1 When scheduled When scheduled
. . . . scheduledDateTime dateTime
. . . . scheduledPeriod Period
. . . reason Σ 0..* CodeableConcept Indication for message Indication for message
. . . requestedOn Σ 0..1 dateTime When ordered or proposed When ordered or proposed
. . . subject Σ 0..1 Reference ( Patient ) Focus of message Focus of message
. . . priority Σ 0..1 CodeableConcept Message urgency Message urgency
DiagnosticOrderPriority ( ( Example )

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

CommunicationRequest ( ( DomainResource ) A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system identifier : : Identifier [0..*] [0..*] The type of message to be sent such as alert, notification, reminder, instruction, etc The type of message to be sent such as alert, notification, reminder, instruction, etc category : : CodeableConcept [0..1] [0..1] The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication sender : : Reference [0..1] « [0..1] « Device | Organization | Patient | Practitioner | RelatedPerson » » The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication recipient : : Reference [0..*] « [0..*] « Device | Organization | Patient | Practitioner | RelatedPerson » » A channel that was used for this communication (e.g. email, fax) A channel that was used for this communication (e.g. email, fax) medium : : CodeableConcept [0..*] « [0..*] « Codes for communication mediums such as phone, fax, email, in person, etc. (Strength=Example) Codes for communication mediums such as phone, fax, email, in person, etc. (Strength=Example) v3 Code System ParticipationM... v3 Code System ParticipationM... ?? » ?? » The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application requester : : Reference [0..1] « [0..1] « Practitioner | Patient | RelatedPerson » » The status of the proposal or order (this element modifies the meaning of other elements) The status of the proposal or order (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « The status of the communication. (Strength=Required) The status of the communication. (Strength=Required) CommunicationRequestStatus ! » ! » The encounter within which the communication request was created The encounter within which the communication request was created encounter : : Reference [0..1] « [0..1] « Encounter » » The time when this communication is to occur The time when this communication is to occur scheduled[x] : : Type [0..1] « [0..1] « dateTime | Period » » The reason or justification for the communication request The reason or justification for the communication request reason : : CodeableConcept [0..*] [0..*] The time when the request was made The time when the request was made requestedOn : : dateTime [0..1] [0..1] The patient who is the focus of this communication request The patient who is the focus of this communication request subject : : Reference [0..1] « [0..1] « Patient » » Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine priority : : CodeableConcept [0..1] « [0..1] « Codes indicating the relative importance of a communication request. (Strength=Example) Codes indicating the relative importance of a communication request. (Strength=Example) DiagnosticOrderPriority ?? » ?? » Payload The communicated content (or for multi-part communications, one portion of the communication) The communicated content (or for multi-part communications, one portion of the communication) content[x] : : Type [1..1] « [1..1] « string | Attachment | Reference ( Any ) » ) » Text, attachment(s), or resource(s) to be communicated to the recipient Text, attachment(s), or resource(s) to be communicated to the recipient payload [0..*]

XML Template XML Template 

<CommunicationRequest xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <category><!-- 0..1 CodeableConcept Message category --></category>
 <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) Message sender --></sender>
 <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) Message recipient --></recipient>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]>
 </payload>
 <</medium>

 <medium><!-- 0..* CodeableConcept A channel of communication --></medium>

 <requester><!-- 0..1 Reference(Practitioner|Patient|RelatedPerson) An individual who requested a communication --></requester>
 <status value="[code]"/><!-- 0..1 proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed -->
 <encounter><!-- 0..1 Reference(Encounter) Encounter leading to message --></encounter>
 <scheduled[x]><!-- 0..1 dateTime|Period When scheduled --></scheduled[x]>
 <reason><!-- 0..* CodeableConcept Indication for message --></reason>
 <requestedOn value="[dateTime]"/><!-- 0..1 When ordered or proposed -->
 <subject><!-- 0..1 Reference(Patient) Focus of message --></subject>
 <priority><!-- 0..1 CodeableConcept Message urgency --></priority>
</CommunicationRequest>

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . CommunicationRequest Σ DomainResource A request for information to be sent to a receiver A request for information to be sent to a receiver
. . . identifier Σ 0..* Identifier Unique identifier Unique identifier
. . . category Σ 0..1 CodeableConcept Message category Message category
. . . sender Σ 0..1 Reference ( Device | | Organization | | Patient | | Practitioner | | RelatedPerson ) Message sender Message sender
. . . recipient Σ 0..* Reference ( Device | | Organization | | Patient | | Practitioner | | RelatedPerson ) Message recipient Message recipient
. . . payload Σ 0..* BackboneElement Message payload Message payload
. . . . content[x] Σ 1..1 Message part content Message part content
. . . . . contentString string
. . . . . contentAttachment Attachment
. . . . contentReference . contentReference Reference ( Any )
. . . medium Σ 0..* CodeableConcept A channel of communication A channel of communication
v3 Code System ParticipationMode ( v3 Code System ParticipationMode ( Example )
. . . requester Σ 0..1 Reference ( Practitioner | | Patient | | RelatedPerson ) An individual who requested a communication An individual who requested a communication
. . . status ?! ?! Σ 0..1 code proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
CommunicationRequestStatus ( ( Required )
. . . encounter Σ 0..1 Reference ( Encounter ) Encounter leading to message Encounter leading to message
. . . scheduled[x] Σ 0..1 When scheduled When scheduled
. . . . scheduledDateTime dateTime
. . . . scheduledPeriod Period
. . . reason Σ 0..* CodeableConcept Indication for message Indication for message
. . . requestedOn Σ 0..1 dateTime When ordered or proposed When ordered or proposed
. . . subject Σ 0..1 Reference ( Patient ) Focus of message Focus of message
. . . priority Σ 0..1 CodeableConcept Message urgency Message urgency
DiagnosticOrderPriority ( ( Example )

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

CommunicationRequest ( ( DomainResource ) A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system identifier : : Identifier [0..*] [0..*] The type of message to be sent such as alert, notification, reminder, instruction, etc The type of message to be sent such as alert, notification, reminder, instruction, etc category : : CodeableConcept [0..1] [0..1] The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication sender : : Reference [0..1] « [0..1] « Device | Organization | Patient | Practitioner | RelatedPerson » » The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication recipient : : Reference [0..*] « [0..*] « Device | Organization | Patient | Practitioner | RelatedPerson » » A channel that was used for this communication (e.g. email, fax) A channel that was used for this communication (e.g. email, fax) medium : : CodeableConcept [0..*] « [0..*] « Codes for communication mediums such as phone, fax, email, in person, etc. (Strength=Example) Codes for communication mediums such as phone, fax, email, in person, etc. (Strength=Example) v3 Code System ParticipationM... v3 Code System ParticipationM... ?? » ?? » The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application requester : : Reference [0..1] « [0..1] « Practitioner | Patient | RelatedPerson » » The status of the proposal or order (this element modifies the meaning of other elements) The status of the proposal or order (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « The status of the communication. (Strength=Required) The status of the communication. (Strength=Required) CommunicationRequestStatus ! » ! » The encounter within which the communication request was created The encounter within which the communication request was created encounter : : Reference [0..1] « [0..1] « Encounter » » The time when this communication is to occur The time when this communication is to occur scheduled[x] : : Type [0..1] « [0..1] « dateTime | Period » » The reason or justification for the communication request The reason or justification for the communication request reason : : CodeableConcept [0..*] [0..*] The time when the request was made The time when the request was made requestedOn : : dateTime [0..1] [0..1] The patient who is the focus of this communication request The patient who is the focus of this communication request subject : : Reference [0..1] « [0..1] « Patient » » Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine priority : : CodeableConcept [0..1] « [0..1] « Codes indicating the relative importance of a communication request. (Strength=Example) Codes indicating the relative importance of a communication request. (Strength=Example) DiagnosticOrderPriority ?? » ?? » Payload The communicated content (or for multi-part communications, one portion of the communication) The communicated content (or for multi-part communications, one portion of the communication) content[x] : : Type [1..1] « [1..1] « string | Attachment | Reference ( Any ) » ) » Text, attachment(s), or resource(s) to be communicated to the recipient Text, attachment(s), or resource(s) to be communicated to the recipient payload [0..*]

XML Template XML Template 

<CommunicationRequest xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <category><!-- 0..1 CodeableConcept Message category --></category>
 <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) Message sender --></sender>
 <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) Message recipient --></recipient>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]>
 </payload>
 <</medium>

 <medium><!-- 0..* CodeableConcept A channel of communication --></medium>

 <requester><!-- 0..1 Reference(Practitioner|Patient|RelatedPerson) An individual who requested a communication --></requester>
 <status value="[code]"/><!-- 0..1 proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed -->
 <encounter><!-- 0..1 Reference(Encounter) Encounter leading to message --></encounter>
 <scheduled[x]><!-- 0..1 dateTime|Period When scheduled --></scheduled[x]>
 <reason><!-- 0..* CodeableConcept Indication for message --></reason>
 <requestedOn value="[dateTime]"/><!-- 0..1 When ordered or proposed -->
 <subject><!-- 0..1 Reference(Patient) Focus of message --></subject>
 <priority><!-- 0..1 CodeableConcept Message urgency --></priority>
</CommunicationRequest>

  Alternate definitions:

Alternate definitions: Schema / Schematron , Resource Profile ( , Resource Profile ( XML , , JSON ), ), Questionnaire

5.22.3.1 Terminology Bindings 5.24.3.1 Terminology Bindings

Path Definition Type Reference
CommunicationRequest.category CommunicationRequest.category Codes for general categories of communications such as alerts, instruction, etc. Codes for general categories of communications such as alerts, instruction, etc. Unknown No details provided yet No details provided yet
CommunicationRequest.medium CommunicationRequest.medium Codes for communication mediums such as phone, fax, email, in person, etc. Codes for communication mediums such as phone, fax, email, in person, etc. Example v3 Code System ParticipationMode v3 Code System ParticipationMode
CommunicationRequest.status CommunicationRequest.status The status of the communication. The status of the communication. Required CommunicationRequestStatus
CommunicationRequest.reason CommunicationRequest.reason Codes for describing reasons for the occurrence of a communication. Codes for describing reasons for the occurrence of a communication. Unknown No details provided yet No details provided yet
CommunicationRequest.priority CommunicationRequest.priority Codes indicating the relative importance of a communication request. Codes indicating the relative importance of a communication request. Example DiagnosticOrderPriority Notes to reviewers: At this time, the code bindings are placeholders to be fleshed out upon further review by the community.

Notes to reviewers:

At this time, the code bindings are placeholders to be fleshed out upon further review by the community.

5.22.3.2 5.24.3.2 CommunicationRequest.sender and CommunicationRequest.recepient CommunicationRequest.sender and CommunicationRequest.recepient CommunicationRequest.sender and CommunicationRequest.recipient allow Patient|Practitioner|RelatedPerson - but it is not unusual to have a communication target - even a defined one - where it is unknown what kind of role the person is playing. If the communication request is to or from an individual, whose role is not known (practitioner, patient or related person), - for example, only email address is captured in the system; then RelatedPerson should be used by default.

CommunicationRequest.sender and CommunicationRequest.recipient allow Patient|Practitioner|RelatedPerson - but it is not unusual to have a communication target - even a defined one - where it is unknown what kind of role the person is playing.

If the communication request is to or from an individual, whose role is not known (practitioner, patient or related person), - for example, only email address is captured in the system; then RelatedPerson should be used by default.

5.22.4 Search Parameters 5.24.4 Search Parameters Search parameters for this resource. The common parameters also apply. See

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. for more information about searching in REST, messaging, and services.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
Name Type Description Paths
category token Message category Message category CommunicationRequest.category
encounter reference Encounter leading to message Encounter leading to message CommunicationRequest.encounter
( Encounter )
identifier token Unique identifier Unique identifier CommunicationRequest.identifier
medium token A channel of communication A channel of communication CommunicationRequest.medium
patient reference Focus of message Focus of message CommunicationRequest.subject
( Patient )
priority token Message urgency Message urgency CommunicationRequest.priority
recipient reference Message recipient Message recipient CommunicationRequest.recipient
( Device , , Patient , , Organization , , Practitioner , , RelatedPerson )
requested date When ordered or proposed When ordered or proposed CommunicationRequest.requestedOn
requester reference An individual who requested a communication An individual who requested a communication CommunicationRequest.requester
( Patient , , Practitioner , , RelatedPerson )
sender reference Message sender Message sender CommunicationRequest.sender
( Device , , Patient , , Organization , , Practitioner , , RelatedPerson )
status token proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed CommunicationRequest.status
subject reference Focus of message Focus of message CommunicationRequest.subject
( Patient )
time date When scheduled When scheduled CommunicationRequest.scheduledDateTime