This page is part of the FHIR Specification (v3.0.2: STU 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 . Page versions: R5 R4B R4 R3 R2
Patient Care Work Group | Maturity Level: 2 | Trial Use | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the CommunicationRequest resource.
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. |
Control | 1..1 |
CommunicationRequest.identifier | |
Definition | 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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
CommunicationRequest.basedOn | |
Definition | A plan or proposal that is fulfilled in whole or in part by this request. |
Control | 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 | |
Definition | Completed or terminated request(s) whose function is taken by this new request. |
Control | 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 | |
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. |
Control | 0..1 |
Type | Identifier |
Alternate Names | grouperId |
Summary | true |
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
CommunicationRequest.status | |
Definition | The status of the proposal or order. |
Control | 1..1 |
Terminology Binding | RequestStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid. |
CommunicationRequest.category | |
Definition | The type of message to be sent such as alert, notification, reminder, instruction, etc. |
Control | 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 | |
Definition | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. |
Control | 0..1 |
Terminology Binding | RequestPriority (Required) |
Type | code |
Meaning if Missing | If missing, this task should be performed with normal priority |
Summary | true |
CommunicationRequest.medium | |
Definition | A channel that was used for this communication (e.g. email, fax). |
Control | 0..* |
Terminology Binding | v3 Code System ParticipationMode (Example) |
Type | CodeableConcept |
CommunicationRequest.subject | |
Definition | The patient or group that is the focus of this communication request. |
Control | 0..1 |
Type | Reference(Patient | Group) |
Alternate Names | patient |
CommunicationRequest.recipient | |
Definition | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. |
Control | 0..* |
Type | Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam) |
CommunicationRequest.topic | |
Definition | The resources which were related to producing this communication request. |
Control | 0..* |
Type | Reference(Any) |
CommunicationRequest.context | |
Definition | The encounter or episode of care within which the communication request was created. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Alternate Names | encounter |
Summary | true |
CommunicationRequest.payload | |
Definition | Text, attachment(s), or resource(s) to be communicated to the recipient. |
Control | 0..* |
CommunicationRequest.payload.content[x] | |
Definition | The communicated content (or for multi-part communications, one portion of the communication). |
Control | 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] | |
Definition | The time when this communication is to occur. |
Control | 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 | |
Definition | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. |
Control | 0..1 |
Type | dateTime |
Alternate Names | createdOn |
Summary | true |
CommunicationRequest.sender | |
Definition | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. |
Control | 0..1 |
Type | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
CommunicationRequest.requester | |
Definition | The individual who initiated the request and has responsibility for its activation. |
Control | 0..1 |
Alternate Names | author |
Summary | true |
Invariants | Defined on this element cmr-1: onBehalfOf can only be specified if agent is practitioner or device (expression : (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not(), xpath: contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))) |
CommunicationRequest.requester.agent | |
Definition | The device, practitioner, etc. who initiated the request. |
Control | 1..1 |
Type | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) |
Summary | true |
CommunicationRequest.requester.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Control | 0..1 |
Type | Reference(Organization) |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. |
Summary | true |
Invariants | Affect this element cmr-1: onBehalfOf can only be specified if agent is practitioner or device (expression : (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not(), xpath: contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))) |
CommunicationRequest.reasonCode | |
Definition | Describes why the request is being made in coded or textual form. |
Control | 0..* |
Terminology Binding | v3 Code System ActReason (Example) |
Type | CodeableConcept |
Summary | true |
Comments | Textual reasons can be caprued using reasonCode.text. |
CommunicationRequest.reasonReference | |
Definition | Indicates another resource whose existence justifies this request. |
Control | 0..* |
Type | Reference(Condition | Observation) |
Summary | true |
CommunicationRequest.note | |
Definition | Comments made about the request by the requester, sender, recipient, subject or other participants. |
Control | 0..* |
Type | Annotation |