type: resource-definitionsresource: CommunicationRequest

CommunicationRequest Definitions

CommunicationRequest

A request to convey information from a sender to a recipient

Definition: A request to convey information from a sender to a recipient.

Cardinality: 0..*

Mappings: workflow=Request; w5=workflow.order

CommunicationRequest.identifier

Unique identifier

Definition: 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.

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.

Requirements: Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Request.identifier; w5=FiveWs.identifier

CommunicationRequest.basedOn

Fulfills plan or proposal

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

Requirements: Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Aliases: fulfills

Cardinality: 0..*

Type: Reference(Resource)

Summary: true

Mappings: workflow=Request.basedOn; rim=.outboundRelationship[typeCode=FLFS].target

CommunicationRequest.replaces

Request(s) replaced by this request

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

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.

Requirements: Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Aliases: supersedes, prior

Cardinality: 0..*

Type: Reference(CommunicationRequest)

Summary: true

Mappings: workflow=Request.replaces; rim=.outboundRelationship[typeCode=RPLC].target

CommunicationRequest.groupIdentifier

Composite request this is part of

Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

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.

Aliases: grouperId

Cardinality: 0..1

Type: Identifier

Summary: true

Mappings: workflow=Request.groupIdentifier; rim=.inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier

CommunicationRequest.status

Definition: The status of the proposal or order.

Cardinality: 1..1

Type: code

Binding: required:request-status

Summary: true

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

Mappings: workflow=Request.status; w5=FiveWs.status

CommunicationRequest.statusReason

Reason for current status

Definition: Captures the reason for the current state of the CommunicationRequest.

Comments: This is generally only used for "exception" statuses such as "on-hold" or "revoked". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here.

Aliases: Suspended Reason, Cancelled Reason

Cardinality: 0..1

Type: CodeableConcept

Binding: example:communication-request-status-reason

Mappings: workflow=Request.statusReason; rim=.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

CommunicationRequest.intent

Definition: Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

Comments: This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.

One exception to this is that the granularity of CommunicationRequest.intent is allowed to change. For example, a Request identified as an "order" might later be clarified to be a "filler-order". Or, in rarer cases (to meet recipient constraints), the reverse might also occur.

Requirements: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Cardinality: 1..1

Type: code

Binding: required:request-intent

Summary: true

Is Modifier: true (Reason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request)

Mappings: workflow=Request.intent; w5=FiveWs.class

CommunicationRequest.category

Message category

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

Comments: There may be multiple axes of categorization and one communication request may serve multiple purposes.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:communication-category

Mappings: w5=FiveWs.class

CommunicationRequest.priority

routine | urgent | asap | stat

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

Meaning if Missing: If missing, this task should be performed with normal priority

Cardinality: 0..1

Type: code

Binding: required:request-priority

Summary: true

Mappings: workflow=Request.priority; w5=FiveWs.grade

CommunicationRequest.doNotPerform

True if request is prohibiting action

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

Comments: The attributes provided with the request qualify what is not to be done.

Meaning if Missing: If do not perform is not specified, the request is a positive request e.g. "do perform"

Aliases: prohibited

Cardinality: 0..1

Type: boolean

Summary: true

Is Modifier: 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.)

Mappings: workflow=Request.doNotPerform

CommunicationRequest.medium

A channel of communication

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:v3-ParticipationMode

CommunicationRequest.subject

Focus of message

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

Aliases: patient

Cardinality: 0..1

Type: Reference(Patient, Group)

Mappings: workflow=Request.subject; w5=FiveWs.subject

CommunicationRequest.about

Resources that pertain to this communication request

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

Comments: Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.

Cardinality: 0..*

Type: Reference(Resource)

Mappings: workflow=Request.supportingInfo; w5=FiveWs.context

CommunicationRequest.encounter

The Encounter during which this CommunicationRequest was created

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

Comments: 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.

Cardinality: 0..1

Type: Reference(Encounter)

Summary: true

Mappings: workflow=Request.encounter; w5=FiveWs.context

CommunicationRequest.payload

Message payload

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

Cardinality: 0..*

Type: BackboneElement

CommunicationRequest.payload.content[x]

Message part content

Definition: The content (or for multi-part communications, one portion of the communication) to be communicated.

Comments: The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.

If the content isn't codified, contentCodeableConcept.text can be used.

When using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.

Cardinality: 1..1

Type: Attachment, Reference(Resource), CodeableConcept

Mappings: workflow=Request.note

CommunicationRequest.occurrence[x]

When scheduled

Definition: The time when this communication is to occur.

Aliases: timing

Cardinality: 0..1

Type: dateTime, Period

Summary: true

Mappings: workflow=Request.occurrence[x]; w5=FiveWs.planned

CommunicationRequest.authoredOn

When request transitioned to being actionable

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

Aliases: createdOn

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Request.authoredOn; w5=FiveWs.recorded

CommunicationRequest.requester

Who asks for the information to be shared

Definition: The device, individual, or organization who asks for the information to be shared.

Comments: Using Group is only allowed when the group represents a family or a household and does not represent groups of Practitioners.

Aliases: author

Cardinality: 0..1

Type: Reference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device, Group)

Summary: true

Mappings: workflow=Request.requester; w5=FiveWs.author; rim=.participation[typeCode=AUT].role

CommunicationRequest.recipient

Who to share the information with

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

Cardinality: 0..*

Type: Reference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService, Endpoint)

Mappings: workflow=Request.performer; w5=FiveWs.actor

CommunicationRequest.informationProvider

Who should share the information

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

Comments: Entities being requested to provide the information. Using Group is only allowed when the group represents a family or a household and does not represent groups of Practitioners.

Cardinality: 0..*

Type: Reference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService, Endpoint, Group)

Summary: true

Mappings: workflow=Request.performer; w5=FiveWs.actor

CommunicationRequest.reason

Why is communication needed?

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

Comments: Textual reasons can be captured using reasonCode.text.

Cardinality: 0..*

Type: CodeableReference

Binding: example:v3-ActReason

Summary: true

Mappings: workflow=Request.reason; w5=FiveWs.why[x]; rim=.reasonCode

CommunicationRequest.note

Comments made about communication request

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

Cardinality: 0..*

Type: Annotation

Mappings: workflow=Request.note; rim=.inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]