DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 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 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.

Summary true Type CodeableConcept Summary Summary code
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.category CommunicationRequest.basedOn
Definition

The type of message to be sent such as alert, notification, reminder, instruction, etc. A plan or proposal that is fulfilled in whole or in part by this request.

Control 0..1 0..*
Binding Type CommunicationCategory : Codes for general categories of communications such as alerts, instruction, etc. Reference ( Any )
Requirements

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

Alternate Names fulfills
Summary true
CommunicationRequest.sender CommunicationRequest.replaces
Definition

The entity (e.g. person, organization, clinical information system, Completed or device) which terminated request(s) whose function is to be the source of the communication. taken by this new request.

Control 0..1 0..*
Type Reference ( Device | Organization | Patient | Practitioner | RelatedPerson 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.recipient CommunicationRequest.groupIdentifier
Definition

The entity (e.g. person, organization, clinical information system, A shared identifier common to all requests that were authorized more or device) which is less simultaneously by a single author, representing the intended target identifier of the communication. requisition, prescription or similar form.

Control 0..* 0..1
Type Reference ( Device | Organization | Patient | Practitioner | RelatedPerson 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.payload CommunicationRequest.status
Definition

Text, attachment(s), or resource(s) to be communicated to The status of the recipient. proposal or order.

Control 0..* 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.payload.content[x] CommunicationRequest.category
Definition

The communicated content (or for multi-part communications, one portion type of the communication). message to be sent such as alert, notification, reminder, instruction, etc.

Control 1..1 0..*
Terminology Binding CommunicationCategory ( Example )
Type string CodeableConcept | Attachment
Comments

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

| Reference 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 ( Any Required )
[x] Note Type See Choice of Data Types code for further information about how to use [x]
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: Codes for communication mediums such as phone, fax, email, in person, etc. ParticipationMode ( Example )
Type CodeableConcept
CommunicationRequest.subject
Definition

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

Control true 0..1
Type Reference ( Patient | Group )
Alternate Names patient
CommunicationRequest.requester CommunicationRequest.recipient
Definition

The responsible person who authorizes this order, e.g. physician. This may be different than entity (e.g. person, organization, clinical information system, device, group, or care team) which is the author intended target of the order statement, e.g. clerk, who may have entered the statement into the order entry application. communication.

Control 0..1 0..*
Type Reference ( Practitioner Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam )
CommunicationRequest.topic
Definition

The resources which were related to producing this communication request.

Control true 0..*
Type Reference ( Any )
CommunicationRequest.status CommunicationRequest.context
Definition

The status encounter or episode of care within which the proposal or order. communication request was created.

Control 0..1
Binding Type CommunicationRequestStatus: The status of the communication. Reference ( Required Encounter | EpisodeOfCare )
Alternate Names encounter
Type Summary true
CommunicationRequest.payload
Is Modifier Definition true

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

Summary Control true 0..*
CommunicationRequest.encounter CommunicationRequest.payload.content[x]
Definition

The encounter within which communicated content (or for multi-part communications, one portion of the communication request was created. communication).

Control 0..1 1..1
Type string | Attachment | Reference ( Encounter Any )
Summary [x] Note true See Choice of Data Types for further information about how to use [x]
CommunicationRequest.scheduled[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.reason CommunicationRequest.authoredOn
Definition

The reason or justification for For draft requests, indicates the communication request. date of initial creation. For requests with other statuses, indicates the date of activation.

Control 0..* 0..1
Binding Type CommunicationReason : Codes for describing reasons for 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 occurrence source of a the communication.

Control 0..1
Type CodeableConcept 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.requestedOn CommunicationRequest.requester.agent
Definition

The time when device, practitioner, etc. who initiated the request was made. request.

Control 0..1 1..1
Type dateTime Reference ( Practitioner | Organization | Patient | RelatedPerson | Device )
Summary true
CommunicationRequest.subject CommunicationRequest.requester.onBehalfOf
Definition

The patient who is organization the focus of this communication request. device or practitioner was acting on behalf of.

Control 0..1
Type Reference ( Patient 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.priority CommunicationRequest.reasonCode
Definition

Characterizes how quickly Describes why the proposed act must be initiated. Includes concepts such as stat, urgent, routine. request is being made in coded or textual form.

Control 0..1 0..*
Terminology Binding DiagnosticOrderPriority: Codes indicating the relative importance of a communication request. 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