Skip to main content

CommunicationRequest

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. If the element is present, it must have either a @value, an @id, or extensions

type CommunicationRequest implements Resource {
  identifier: [Identifier]
  basedOn: [Reference]
  replaces: [Reference]
  groupIdentifier: Identifier
  status: String
  statusReason: CodeableConcept
  category: [CodeableConcept]
  priority: String
  doNotPerform: Boolean
  medium: [CodeableConcept]
  subject: Reference
  about: [Reference]
  encounter: Reference
  payload: [CommunicationRequestPayload]
  occurrenceDateTime: Date
  occurrencePeriod: Period
  authoredOn: Date
  requester: Reference
  recipient: [Reference]
  sender: Reference
  reasonCode: [CodeableConcept]
  reasonReference: [Reference]
  note: [Annotation]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

CommunicationRequest.identifier ● [Identifier] list object​

Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

CommunicationRequest.basedOn ● [Reference] list object​

A plan or proposal that is fulfilled in whole or in part by this request.

CommunicationRequest.replaces ● [Reference] list object​

Completed or terminated request(s) whose function is taken by this new request.

CommunicationRequest.groupIdentifier ● Identifier object​

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.

CommunicationRequest.status ● String scalar​

The status of the proposal or order.

CommunicationRequest.statusReason ● CodeableConcept object​

Captures the reason for the current state of the CommunicationRequest.

CommunicationRequest.category ● [CodeableConcept] list object​

The type of message to be sent such as alert, notification, reminder, instruction, etc.

CommunicationRequest.priority ● String scalar​

Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

CommunicationRequest.doNotPerform ● Boolean scalar​

If true indicates that the CommunicationRequest is asking for the specified action to not occur.

CommunicationRequest.medium ● [CodeableConcept] list object​

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

CommunicationRequest.subject ● Reference object​

The patient or group that is the focus of this communication request.

CommunicationRequest.about ● [Reference] list object​

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

CommunicationRequest.encounter ● Reference object​

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

CommunicationRequest.payload ● [CommunicationRequestPayload] list object​

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

CommunicationRequest.occurrenceDateTime ● Date scalar​

The time when this communication is to occur. (choose any one of occurrence*, but only one)

CommunicationRequest.occurrencePeriod ● Period object​

The time when this communication is to occur. (choose any one of occurrence*, but only one)

CommunicationRequest.authoredOn ● Date scalar​

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

CommunicationRequest.requester ● Reference object​

The device, individual, or organization who initiated the request and has responsibility for its activation.

CommunicationRequest.recipient ● [Reference] list object​

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

CommunicationRequest.sender ● Reference object​

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

CommunicationRequest.reasonCode ● [CodeableConcept] list object​

Describes why the request is being made in coded or textual form.

CommunicationRequest.reasonReference ● [Reference] list object​

Indicates another resource whose existence justifies this request.

CommunicationRequest.note ● [Annotation] list object​

Comments made about the request by the requester, sender, recipient, subject or other participants.

CommunicationRequest.text ● Narrative object​

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.

CommunicationRequest.contained ● [Resource] list interface​

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

CommunicationRequest.extension ● [Extension] list object​

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

CommunicationRequest.modifierExtension ● [Extension] list object​

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 manageable, 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).

CommunicationRequest.id ● String scalar​

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

CommunicationRequest.meta ● Meta object​

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.

CommunicationRequest.implicitRules ● Uri scalar​

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.

CommunicationRequest.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

CommunicationRequest query ● CommunicationRequestCreate mutation ● CommunicationRequestList query ● CommunicationRequestUpdate mutation