R4 Ballot #1 (Mixed Normative/Trial use)
AdministrationThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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 R2
| Patient Care Work Group | Maturity Level: 2 | Trial Use | 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.
CommunicationRequest is one of the request resources in the FHIR workflow specification.
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:
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 and requests for therapy or counseling which would be handled by the ServiceRequest resource. The performance of a CommunicationRequest may result in a Communication resource.
This resource is referenced by CarePlan, ClaimResponse and ProcessResponse
Structure
UML Diagram (Legend)
XML Template
<CommunicationRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique identifier --></identifier> <basedOn><!-- 0..* Reference(Any) Fulfills plan or proposal --></basedOn> <replaces><!-- 0..* Reference(CommunicationRequest) Request(s) replaced by this request --></replaces> <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier> <status value="[code]"/><!-- 1..1 draft | active | suspended | cancelled | completed | entered-in-error | unknown --> <category><!-- 0..* CodeableConcept Message category --></category> <priority value="[code]"/><!-- 0..1 Message urgency --> <medium><!-- 0..* CodeableConcept A channel of communication --></medium> <subject><!-- 0..1 Reference(Patient|Group) Focus of message --></subject> <recipient><!-- 0..* Reference(Device|Organization|Patient|Practitioner| RelatedPerson|Group|CareTeam) Message recipient --></recipient> <about><!-- 0..* Reference(Any) Resources that pertain to this communication request --></about> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or episode leading to message --></context> <payload> <!-- 0..* Message payload --> <content[x]><!-- 1..1 string|Attachment|Reference(Any) Message part content --></content[x]> </payload> <occurrence[x]><!-- 0..1 dateTime|Period When scheduled --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When request transitioned to being actionable --> <requester><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization| Patient|RelatedPerson|Device) Who/what is requesting service --></requester> <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson|HealthcareService) Message sender --></sender> <reasonCode><!-- 0..* CodeableConcept Why is communication needed? --></reasonCode> <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport| DocumentReference) Why is communication needed? --></reasonReference> <note><!-- 0..* Annotation Comments made about communication request --></note> </CommunicationRequest>
JSON Template
{
"resourceType" : "CommunicationRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique identifier
"basedOn" : [{ Reference(Any) }], // Fulfills plan or proposal
"replaces" : [{ Reference(CommunicationRequest) }], // Request(s) replaced by this request
"groupIdentifier" : { Identifier }, // Composite request this is part of
"status" : "<code>", // R! draft | active | suspended | cancelled | completed | entered-in-error | unknown
"category" : [{ CodeableConcept }], // Message category
"priority" : "<code>", // Message urgency
"medium" : [{ CodeableConcept }], // A channel of communication
"subject" : { Reference(Patient|Group) }, // Focus of message
"recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
RelatedPerson|Group|CareTeam) }], // Message recipient
"about" : [{ Reference(Any) }], // Resources that pertain to this communication request
"context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode leading to message
"payload" : [{ // Message payload
// content[x]: Message part content. One of these 3:
"contentString" : "<string>"
"contentAttachment" : { Attachment }
"contentReference" : { Reference(Any) }
}],
// occurrence[x]: When scheduled. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"authoredOn" : "<dateTime>", // When request transitioned to being actionable
"requester" : { Reference(Practitioner|PractitionerRole|Organization|
Patient|RelatedPerson|Device) }, // Who/what is requesting service
"sender" : { Reference(Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson|HealthcareService) }, // Message sender
"reasonCode" : [{ CodeableConcept }], // Why is communication needed?
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference) }], // Why is communication needed?
"note" : [{ Annotation }] // Comments made about communication request
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| CommunicationRequest | |
| CommunicationRequest.about |
|
| CommunicationRequest.payload.content[x] |
|
| CommunicationRequest.requester |
|
| CommunicationRequest.sender |
|
| CommunicationRequest.reasonReference |
|
| CommunicationRequest.topic |
|
| CommunicationRequest.requester.agent |
|
| CommunicationRequest.requester.onBehalfOf |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 1 fail round-trip testing and 1 r3 resources are invalid (1 errors).). Note: these have note yet been updated to be R3 to R4
Structure
XML Template
<CommunicationRequest xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "CommunicationRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique identifier
"basedOn" : [{ Reference(Any) }], // Fulfills plan or proposal
"replaces" : [{ Reference(CommunicationRequest) }], // Request(s) replaced by this request
"groupIdentifier" : { Identifier }, // Composite request this is part of
"status" : "<code>", // R! draft | active | suspended | cancelled | completed | entered-in-error | unknown
"category" : [{ CodeableConcept }], // Message category
"priority" : "<code>", // Message urgency
"medium" : [{ CodeableConcept }], // A channel of communication
"subject" : { Reference(Patient|Group) }, // Focus of message
"recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
RelatedPerson|Group|CareTeam) }], // Message recipient
"about" : [{ Reference(Any) }], // Resources that pertain to this communication request
"context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode leading to message
"payload" : [{ // Message payload
// content[x]: Message part content. One of these 3:
"contentString" : "<string>"
"contentAttachment" : { Attachment }
"contentReference" : { Reference(Any) }
}],
// occurrence[x]: When scheduled. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"authoredOn" : "<dateTime>", // When request transitioned to being actionable
"requester" : { Reference(Practitioner|PractitionerRole|Organization|
Patient|RelatedPerson|Device) }, // Who/what is requesting service
"sender" : { Reference(Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson|HealthcareService) }, // Message sender
"reasonCode" : [{ CodeableConcept }], // Why is communication needed?
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference) }], // Why is communication needed?
"note" : [{ Annotation }] // Comments made about communication request
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| CommunicationRequest | |
| CommunicationRequest.about |
|
| CommunicationRequest.payload.content[x] |
|
| CommunicationRequest.requester |
|
| CommunicationRequest.sender |
|
| CommunicationRequest.reasonReference |
|
| CommunicationRequest.topic |
|
| CommunicationRequest.requester.agent |
|
| CommunicationRequest.requester.onBehalfOf |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 1 fail round-trip testing and 1 r3 resources are invalid (1 errors).). Note: these have note yet been updated to be R3 to R4
Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| CommunicationRequest.status | The status of the communication request. | Required | RequestStatus |
| CommunicationRequest.category | Codes for general categories of communications such as alerts, instruction, etc. | Example | CommunicationCategory |
| CommunicationRequest.priority | Codes indicating the relative importance of a communication request. | Required | RequestPriority |
| CommunicationRequest.medium | Codes for communication mediums such as phone, fax, email, in person, etc. | Example | v3 Code System ParticipationMode |
| CommunicationRequest.reasonCode | Codes for describing reasons for the occurrence of a communication. | Example | v3 Code System ActReason |
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
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.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| authored | date | When request transitioned to being actionable | CommunicationRequest.authoredOn | |
| based-on | reference | Fulfills plan or proposal | CommunicationRequest.basedOn (Any) | |
| category | token | Message category | CommunicationRequest.category | |
| context | reference | Encounter or episode leading to message | CommunicationRequest.context (EpisodeOfCare, Encounter) | |
| encounter | reference | Encounter leading to message | CommunicationRequest.context (Encounter) | |
| group-identifier | token | Composite request this is part of | CommunicationRequest.groupIdentifier | |
| identifier | token | Unique identifier | CommunicationRequest.identifier | |
| medium | token | A channel of communication | CommunicationRequest.medium | |
| occurrence | date | When scheduled | CommunicationRequest.occurrence.as(dateTime) | |
| patient | reference | Focus of message | CommunicationRequest.subject (Patient) | |
| priority | token | Message urgency | CommunicationRequest.priority | |
| recipient | reference | Message recipient | CommunicationRequest.recipient (Practitioner, Group, Organization, CareTeam, Device, Patient, RelatedPerson) | |
| replaces | reference | Request(s) replaced by this request | CommunicationRequest.replaces (CommunicationRequest) | |
| requester | reference | Who/what is requesting service | CommunicationRequest.requester (Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson) | |
| sender | reference | Message sender | CommunicationRequest.sender (Practitioner, Organization, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson) | |
| status | token | draft | active | suspended | cancelled | completed | entered-in-error | unknown | CommunicationRequest.status | |
| subject | reference | Focus of message | CommunicationRequest.subject (Group, Patient) |
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:14+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change