This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.23 Resource CommunicationRequest - Content

Patient Care icon

Work Group

Maturity Level: 2

Trial Use

Security Category: Patient

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

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.

8.23.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.23.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 performance of a CommunicationRequest may result in a Communication resource.

8.23.3 References to this Resource

Implements: Request
Resource References: CarePlan, ClaimResponse, itself, DocumentReference and GuidanceResponse

Structure

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest	TU		DomainResource	A request for information to be sent to a receiver 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
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| 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 (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)	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)	Who should share the information
reason	Σ	0..*	CodeableReference(Any)	Why is communication needed? Binding: v3 Code System ActReason (Example)
note		0..*	Annotation	Comments made about communication request
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<CommunicationRequest xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <basedOn><!-- 0..* Reference(Any) Fulfills plan or proposal --></basedOn>
 <replaces><!-- 0..* Reference(CommunicationRequest) Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>
 <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <category><!-- 0..* CodeableConcept Message category --></category>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if request is prohibiting action -->
 <medium><!-- 0..* CodeableConcept A channel of communication  --></medium>
 <subject><!-- 0..1 Reference(Group|Patient) Focus of message --></subject>
 <about><!-- 0..* Reference(Any) Resources that pertain to this communication request --></about>
 <encounter><!-- 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created --></encounter>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 Attachment|Reference(Any)|CodeableConcept Message part content --></content[x]>
 </payload>
 <occurrence[x]><!-- 0..1 dateTime|Period When scheduled --></occurrence[x]>
 <authoredOn value="[dateTime]"/><!-- 0..1 When request transitioned to being actionable -->
 <requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who asks for the information to be shared --></requester>
 <recipient><!-- 0..* Reference(CareTeam|Device|Endpoint|Group|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who to share the information with --></recipient>
 <informationProvider><!-- 0..* Reference(Device|Endpoint|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who should share the information --></informationProvider>
 <reason><!-- 0..* CodeableReference(Any) Why is communication needed?  --></reason>
 <note><!-- 0..* Annotation Comments made about communication request --></note>
</CommunicationRequest>

JSON Template

{
  "resourceType" : "CommunicationRequest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "basedOn" : [{ Reference(Any) }], // Fulfills plan or proposal
  "replaces" : [{ Reference(CommunicationRequest) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "statusReason" : { CodeableConcept }, // Reason for current status
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // routine | urgent | asap | stat
  "doNotPerform" : <boolean>, // True if request is prohibiting action
  "medium" : [{ CodeableConcept }], // A channel of communication 
  "subject" : { Reference(Group|Patient) }, // Focus of message
  "about" : [{ Reference(Any) }], // Resources that pertain to this communication request
  "encounter" : { Reference(Encounter) }, // The Encounter during which this CommunicationRequest was created
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentAttachment" : { Attachment },
    "contentReference" : { Reference(Any) },
    "contentCodeableConcept" : { CodeableConcept }
  }],
  // occurrence[x]: When scheduled. One of these 2:
  "occurrenceDateTime" : "<dateTime>",
  "occurrencePeriod" : { Period },
  "authoredOn" : "<dateTime>", // When request transitioned to being actionable
  "requester" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Who asks for the information to be shared
  "recipient" : [{ Reference(CareTeam|Device|Endpoint|Group|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who to share the information with
  "informationProvider" : [{ Reference(Device|Endpoint|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who should share the information
  "reason" : [{ CodeableReference(Any) }], // Why is communication needed? 
  "note" : [{ Annotation }] // Comments made about communication request
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:CommunicationRequest;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Unique identifier
  fhir:basedOn  ( [ Reference(Any) ] ... ) ; # 0..* Fulfills plan or proposal
  fhir:replaces  ( [ Reference(CommunicationRequest) ] ... ) ; # 0..* Request(s) replaced by this request
  fhir:groupIdentifier [ Identifier ] ; # 0..1 Composite request this is part of
  fhir:status [ code ] ; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
  fhir:statusReason [ CodeableConcept ] ; # 0..1 Reason for current status
  fhir:intent [ code ] ; # 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Message category
  fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat
  fhir:doNotPerform [ boolean ] ; # 0..1 True if request is prohibiting action
  fhir:medium  ( [ CodeableConcept ] ... ) ; # 0..* A channel of communication
  fhir:subject [ Reference(Group|Patient) ] ; # 0..1 Focus of message
  fhir:about  ( [ Reference(Any) ] ... ) ; # 0..* Resources that pertain to this communication request
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 The Encounter during which this CommunicationRequest was created
  fhir:payload ( [ # 0..* Message payload
    # content[x] : 1..1 Message part content. One of these 3
      fhir:content [  a fhir:Attachment ; Attachment ]
      fhir:content [  a fhir:Reference ; Reference(Any) ]
      fhir:content [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  # occurrence[x] : 0..1 When scheduled. One of these 2
    fhir:occurrence [  a fhir:dateTime ; dateTime ]
    fhir:occurrence [  a fhir:Period ; Period ]
  fhir:authoredOn [ dateTime ] ; # 0..1 When request transitioned to being actionable
  fhir:requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who asks for the information to be shared
  fhir:recipient  ( [ Reference(CareTeam|Device|Endpoint|Group|HealthcareService|Organization|Patient|
  Practitioner|PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who to share the information with
  fhir:informationProvider  ( [ Reference(Device|Endpoint|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who should share the information
  fhir:reason  ( [ CodeableReference(Any) ] ... ) ; # 0..* Why is communication needed?
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Comments made about communication request
]

Changes from both R4 and R4B

CommunicationRequest

CommunicationRequest.intent

Added Mandatory Element

CommunicationRequest.payload.content[x]

Add Type CodeableConcept
Remove Type string

CommunicationRequest.recipient

Type Reference: Added Target Type Endpoint

CommunicationRequest.informationProvider

Renamed from sender to informationProvider
Max Cardinality changed from 1 to *
Type Reference: Added Target Type Endpoint

CommunicationRequest.reason

Added Element

CommunicationRequest.reasonCode

Deleted (-> CommunicationRequest.reason)

CommunicationRequest.reasonReference

Deleted (-> CommunicationRequest.reason)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

Name	Flags	Card.	Type	Description & Constraints
CommunicationRequest	TU		DomainResource	A request for information to be sent to a receiver 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
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| 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 (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)	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)	Who should share the information
reason	Σ	0..*	CodeableReference(Any)	Why is communication needed? Binding: v3 Code System ActReason (Example)
note		0..*	Annotation	Comments made about communication request
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<CommunicationRequest xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique identifier --></identifier>
 <basedOn><!-- 0..* Reference(Any) Fulfills plan or proposal --></basedOn>
 <replaces><!-- 0..* Reference(CommunicationRequest) Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>
 <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <category><!-- 0..* CodeableConcept Message category --></category>
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if request is prohibiting action -->
 <medium><!-- 0..* CodeableConcept A channel of communication  --></medium>
 <subject><!-- 0..1 Reference(Group|Patient) Focus of message --></subject>
 <about><!-- 0..* Reference(Any) Resources that pertain to this communication request --></about>
 <encounter><!-- 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created --></encounter>
 <payload>  <!-- 0..* Message payload -->
  <content[x]><!-- 1..1 Attachment|Reference(Any)|CodeableConcept Message part content --></content[x]>
 </payload>
 <occurrence[x]><!-- 0..1 dateTime|Period When scheduled --></occurrence[x]>
 <authoredOn value="[dateTime]"/><!-- 0..1 When request transitioned to being actionable -->
 <requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who asks for the information to be shared --></requester>
 <recipient><!-- 0..* Reference(CareTeam|Device|Endpoint|Group|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who to share the information with --></recipient>
 <informationProvider><!-- 0..* Reference(Device|Endpoint|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who should share the information --></informationProvider>
 <reason><!-- 0..* CodeableReference(Any) Why is communication needed?  --></reason>
 <note><!-- 0..* Annotation Comments made about communication request --></note>
</CommunicationRequest>

JSON Template

{
  "resourceType" : "CommunicationRequest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "basedOn" : [{ Reference(Any) }], // Fulfills plan or proposal
  "replaces" : [{ Reference(CommunicationRequest) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "statusReason" : { CodeableConcept }, // Reason for current status
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // routine | urgent | asap | stat
  "doNotPerform" : <boolean>, // True if request is prohibiting action
  "medium" : [{ CodeableConcept }], // A channel of communication 
  "subject" : { Reference(Group|Patient) }, // Focus of message
  "about" : [{ Reference(Any) }], // Resources that pertain to this communication request
  "encounter" : { Reference(Encounter) }, // The Encounter during which this CommunicationRequest was created
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentAttachment" : { Attachment },
    "contentReference" : { Reference(Any) },
    "contentCodeableConcept" : { CodeableConcept }
  }],
  // occurrence[x]: When scheduled. One of these 2:
  "occurrenceDateTime" : "<dateTime>",
  "occurrencePeriod" : { Period },
  "authoredOn" : "<dateTime>", // When request transitioned to being actionable
  "requester" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Who asks for the information to be shared
  "recipient" : [{ Reference(CareTeam|Device|Endpoint|Group|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who to share the information with
  "informationProvider" : [{ Reference(Device|Endpoint|HealthcareService|
   Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who should share the information
  "reason" : [{ CodeableReference(Any) }], // Why is communication needed? 
  "note" : [{ Annotation }] // Comments made about communication request
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:CommunicationRequest;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Unique identifier
  fhir:basedOn  ( [ Reference(Any) ] ... ) ; # 0..* Fulfills plan or proposal
  fhir:replaces  ( [ Reference(CommunicationRequest) ] ... ) ; # 0..* Request(s) replaced by this request
  fhir:groupIdentifier [ Identifier ] ; # 0..1 Composite request this is part of
  fhir:status [ code ] ; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
  fhir:statusReason [ CodeableConcept ] ; # 0..1 Reason for current status
  fhir:intent [ code ] ; # 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Message category
  fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat
  fhir:doNotPerform [ boolean ] ; # 0..1 True if request is prohibiting action
  fhir:medium  ( [ CodeableConcept ] ... ) ; # 0..* A channel of communication
  fhir:subject [ Reference(Group|Patient) ] ; # 0..1 Focus of message
  fhir:about  ( [ Reference(Any) ] ... ) ; # 0..* Resources that pertain to this communication request
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 The Encounter during which this CommunicationRequest was created
  fhir:payload ( [ # 0..* Message payload
    # content[x] : 1..1 Message part content. One of these 3
      fhir:content [  a fhir:Attachment ; Attachment ]
      fhir:content [  a fhir:Reference ; Reference(Any) ]
      fhir:content [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  # occurrence[x] : 0..1 When scheduled. One of these 2
    fhir:occurrence [  a fhir:dateTime ; dateTime ]
    fhir:occurrence [  a fhir:Period ; Period ]
  fhir:authoredOn [ dateTime ] ; # 0..1 When request transitioned to being actionable
  fhir:requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who asks for the information to be shared
  fhir:recipient  ( [ Reference(CareTeam|Device|Endpoint|Group|HealthcareService|Organization|Patient|
  Practitioner|PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who to share the information with
  fhir:informationProvider  ( [ Reference(Device|Endpoint|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who should share the information
  fhir:reason  ( [ CodeableReference(Any) ] ... ) ; # 0..* Why is communication needed?
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Comments made about communication request
]

Changes from both R4 and R4B

CommunicationRequest

CommunicationRequest.intent

Added Mandatory Element

CommunicationRequest.payload.content[x]

Add Type CodeableConcept
Remove Type string

CommunicationRequest.recipient

Type Reference: Added Target Type Endpoint

CommunicationRequest.informationProvider

Renamed from sender to informationProvider
Max Cardinality changed from 1 to *
Type Reference: Added Target Type Endpoint

CommunicationRequest.reason

Added Element

CommunicationRequest.reasonCode

Deleted (-> CommunicationRequest.reason)

CommunicationRequest.reasonReference

Deleted (-> CommunicationRequest.reason)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

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

8.23.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	Example	Identifies the primary means by which an Entity participates in an Act.
CommunicationRequest.reason	ActReason	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".

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

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.23.4.2 CommunicationRequest.sender and CommunicationRequest.recepient

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.23.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
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, 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)	66 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, 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)