This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R4
R3
R2
Patient
Care
Work
Group
|
Maturity Level : 2 | Trial Use | Security Category : Patient | Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson |
Detailed Descriptions for the elements in the CommunicationRequest resource.
| CommunicationRequest | |
| Element Id | CommunicationRequest |
| Definition |
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. |
|
|
|
| Type | DomainResource |
| CommunicationRequest.identifier | |
| Element Id | CommunicationRequest.identifier |
| Definition |
|
| Note |
This
is
a
business
|
|
|
0..* |
| Type | Identifier |
| Requirements | Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers. |
| Summary | true |
| Comments | This is a business identifier, not a resource identifier (see discussion ). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
| CommunicationRequest.basedOn | |
| Element Id | CommunicationRequest.basedOn |
| Definition |
A plan or proposal that is fulfilled in whole or in part by this request. |
|
|
0..* |
| Type | Reference ( Any ) |
| Requirements |
Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. |
| Alternate Names | fulfills |
| Summary | true |
| CommunicationRequest.replaces | |
| Element Id | CommunicationRequest.replaces |
| Definition |
Completed or terminated request(s) whose function is taken by this new request. |
|
|
0..* |
| Type | Reference ( CommunicationRequest ) |
| Requirements |
Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. |
| Alternate Names | supersedes; prior |
| Summary | true |
| Comments |
The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. |
| CommunicationRequest.groupIdentifier | |
| Element Id | CommunicationRequest.groupIdentifier |
| Definition |
A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. |
|
|
0..1 |
| Type | Identifier |
| Alternate Names | grouperId |
| Summary | true |
| Comments |
Requests
are
linked
either
by
a
|
| CommunicationRequest.status | |
| Element Id | CommunicationRequest.status |
| Definition |
The status of the proposal or order. |
|
|
1..1 |
| Terminology Binding | RequestStatus ( Required ) |
| Type | code |
| Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.) |
| Summary | true |
| CommunicationRequest.statusReason | |
| Element Id | CommunicationRequest.statusReason |
| Definition | Captures the reason for the current state of the CommunicationRequest. |
| Cardinality | 0..1 |
| Terminology Binding | CommunicationRequestStatusReason : |
| Type | CodeableConcept |
| Alternate Names | Suspended Reason; Cancelled Reason |
| Comments |
This
|
| CommunicationRequest.category | |
| Element Id | CommunicationRequest.category |
| Definition |
The type of message to be sent such as alert, notification, reminder, instruction, etc. |
|
|
0..* |
| Terminology Binding | CommunicationCategory ( Example ) |
| Type | CodeableConcept |
| Comments |
There may be multiple axes of categorization and one communication request may serve multiple purposes. |
| CommunicationRequest.priority | |
| Element Id | CommunicationRequest.priority |
| Definition |
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. |
|
|
0..1 |
| Terminology Binding |
|
| Type | code |
| Meaning if Missing | If missing, this task should be performed with normal priority |
| Summary | true |
|
|
|
| Element Id | CommunicationRequest.doNotPerform |
| Definition |
|
|
|
|
|
|
|
|
|
true (Reason: If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.) |
| Meaning if Missing | If do not perform is not specified, the request is a positive request e.g. "do perform" |
| Alternate Names | prohibited |
| Summary | true |
| Comments | The attributes provided with the request qualify what is not to be done. |
|
|
|
| Element Id | CommunicationRequest.medium |
| Definition |
|
|
|
|
|
|
|
| Type |
|
|
|
|
| Element Id | CommunicationRequest.subject |
| Definition |
The
|
|
|
|
| Type |
Reference
(
|
| Alternate Names | patient |
|
|
|
| Element Id | CommunicationRequest.about |
| Definition |
|
|
|
0..* |
| Type | Reference ( Any ) |
| Comments | Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces. |
|
|
|
| Element Id | CommunicationRequest.encounter |
| Definition |
The
|
|
|
0..1 |
| Type |
Reference
(
Encounter
|
| Summary |
|
|
|
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. |
| CommunicationRequest.payload | |
| Element Id | CommunicationRequest.payload |
| Definition |
Text, attachment(s), or resource(s) to be communicated to the recipient. |
|
|
0..* |
| CommunicationRequest.payload.content[x] | |
| Element Id | CommunicationRequest.payload.content[x] |
| Definition |
The communicated content (or for multi-part communications, one portion of the communication). |
|
|
1..1 |
| Type | string | Attachment | Reference ( Any ) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| CommunicationRequest.occurrence[x] | |
| Element Id | CommunicationRequest.occurrence[x] |
| Definition |
The time when this communication is to occur. |
|
|
0..1 |
| Type | dateTime | Period |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | timing |
| Summary | true |
| CommunicationRequest.authoredOn | |
| Element Id | CommunicationRequest.authoredOn |
| Definition |
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. |
|
|
0..1 |
| Type | dateTime |
| Alternate Names | createdOn |
| Summary | true |
|
|
|
| Element Id | CommunicationRequest.requester |
| Definition |
The
|
|
|
0..1 |
| Type |
Reference
(
|
| Alternate Names | author |
| Summary | true |
|
|
|
| Element Id | CommunicationRequest.recipient |
| Definition |
The
entity
(e.g.
person,
organization,
clinical
information
system,
device,
|
|
|
|
| Type |
Reference
(
|
|
|
|
| Element Id | CommunicationRequest.sender |
| Definition |
The
|
|
|
0..1 |
| Type | Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService ) |
|
|
true |
|
|
|
| Element Id | CommunicationRequest.reasonCode |
| Definition |
Describes why the request is being made in coded or textual form. |
|
|
0..* |
| Terminology Binding | v3 Code System ActReason ( Example ) |
| Type | CodeableConcept |
| Summary | true |
| Comments |
Textual
reasons
can
be
|
| CommunicationRequest.reasonReference | |
| Element Id | CommunicationRequest.reasonReference |
| Definition |
Indicates another resource whose existence justifies this request. |
|
|
0..* |
| Type | Reference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
| Summary | true |
| CommunicationRequest.note | |
| Element Id | CommunicationRequest.note |
| Definition |
Comments made about the request by the requester, sender, recipient, subject or other participants. |
|
|
0..* |
| Type | Annotation |