FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.24 Resource CommunicationRequest - Content

Patient Care icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Patient Compartments: Device, Encounter, Group, Patient, Practitioner, RelatedPerson

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

8.24.1 Scope and Usage

CommunicationRequest is one of the request resources in the FHIR workflow specification.

This resource is a record of a request for a communication to be performed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The requester requests the sender to send the payload to the recipient. The sender and receivers may be patients, practitioners, related persons, organizations, and devices. Uses of communication request include:

  • A computer-based decision-support system requesting a reminder or alert be delivered to a responsible provider
  • A physician requesting notification from the nurse if a patient's temperature exceeds a value
  • A monitoring system or a provider requesting a staff member or department to notify a public health agency of a patient presenting with a communicable disease reportable to the public health agency
  • A computer-based decision-support system proposes to send educational material to a patient

8.24.2 Boundaries and Relationships

This resource is a record of a request. It does not represent the actual flow of communication.

The use of CommunicationRequest excludes requests for referrals and requests for therapy or counseling which would be handled by the ServiceRequest resource. The fulfillment of a CommunicationRequest may result in a Communication resource.

The CommunicationRequest resource represents an authorization for a service to be provided. Details about the fulfillment of the authorization are handled by the Task resource. For further information about this separation of responsibilities, refer to the Fulfillment/Execution section of the Request pattern.

8.24.3 References to this Resource

8.24.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest TU DomainResource A request to convey information from a sender to a recipient

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Unique identifier

... basedOn Σ 0..* Reference(Any) Fulfills plan or proposal

... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request

... status ?!Σ 1..1 code draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown
Binding: RequestStatus (Required)
... statusReason 0..1 CodeableConcept Reason for current status
Binding: CommunicationRequest Status Reason (Example)
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (Required)
... category 0..* CodeableConcept Message category
Binding: Communication Category (Example)

... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (Required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode icon (Example)

... subject 0..1 Reference(Patient | Group) Focus of message
... about 0..* Reference(Any) Resources that pertain to this communication request

... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created
... payload 0..* BackboneElement Message payload

.... content[x] 1..1 Message part content
..... contentAttachment Attachment
..... contentReference Reference(Any)
..... contentCodeableConcept CodeableConcept
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | Group) Who asks for the information to be shared
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) Who to share the information with

... informationProvider Σ 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | Group) Who should share the information

... reason Σ 0..* CodeableReference(Any) Why is communication needed?
Binding: v3 Code System ActReason icon (Example)

... note 0..* Annotation Comments made about communication request


doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

8.24.4.1 Terminology Bindings

Path ValueSet Type Documentation
CommunicationRequest.status RequestStatus Required

Codes identifying the lifecycle stage of a request.
CommunicationRequest.statusReason CommunicationRequestStatusReason Example

Example codes indicating the reason why a CommunicationRequest is on hold or revoked. Note that these are in no way complete and might not even be appropriate for some uses.
CommunicationRequest.intent RequestIntent Required

Codes indicating the degree of authority/intentionality associated with a request.
CommunicationRequest.category CommunicationCategory Example

Codes for general categories of communications such as alerts, instructions, etc.
CommunicationRequest.priority RequestPriority Required

Identifies the level of importance to be assigned to actioning the request.
CommunicationRequest.medium ParticipationMode icon Example

Identifies the primary means by which an Entity participates in an Act.
CommunicationRequest.reason ActReason icon Example

A set of codes specifying the motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act. Examples: Example reasons that might qualify for being coded in this field might be: "routine requirement", "infectious disease reporting requirement", "on patient request", "required by law".

Notes to reviewers:

At this time, the code bindings are placeholders to be fleshed out upon further review by the community.

8.24.4.2 CommunicationRequest.sender and CommunicationRequest.recepient

CommunicationRequest.sender allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService and CommunicationRequest.recipient allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService - but it is not unusual to have a communication target - even a defined one - where it is unknown what kind of role the person is playing.

If the communication request is to or from an individual, whose role is not known (practitioner, patient or related person), - for example, only email address is captured in the system; then RelatedPerson should be used by default.

8.24.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
about reference Resources that pertain to this communication request CommunicationRequest.about
(Any)
authored date When request transitioned to being actionable CommunicationRequest.authoredOn
based-on reference Fulfills plan or proposal CommunicationRequest.basedOn
(Any)
category token Message category CommunicationRequest.category
encounter reference The Encounter during which this CommunicationRequest was created CommunicationRequest.encounter
(Encounter)		 29 Resources
group-identifier token Composite request this is part of CommunicationRequest.groupIdentifier
identifier token Unique identifier CommunicationRequest.identifier 65 Resources
information-provider reference Who should share the information CommunicationRequest.informationProvider
(Practitioner, Group, Organization, Endpoint, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson)
medium token A channel of communication CommunicationRequest.medium
occurrence date When scheduled CommunicationRequest.occurrence.ofType(dateTime) | CommunicationRequest.occurrence.ofType(Period)
patient reference Focus of message CommunicationRequest.subject.where(resolve() is Patient)
(Patient)		 65 Resources
priority token routine | urgent | asap | stat CommunicationRequest.priority
recipient reference Who to share the information with CommunicationRequest.recipient
(Practitioner, Group, Organization, CareTeam, Endpoint, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson)
replaces reference Request(s) replaced by this request CommunicationRequest.replaces
(CommunicationRequest)
requester reference Who asks for the information to be shared CommunicationRequest.requester
(Practitioner, Group, Organization, Device, Patient, PractitionerRole, RelatedPerson)
status token draft | active | on-hold | revoked | completed | entered-in-error | unknown CommunicationRequest.status
subject reference Focus of message CommunicationRequest.subject
(Group, Patient)