Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

8.21 Resource CommunicationRequest - Content

Patient Care Work GroupMaturity Level: 2 Trial UseSecurity 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.21.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.21.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.21.3 References to this Resource

8.21.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest TUDomainResourceA request for information to be sent to a receiver

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

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

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

... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
... statusReason 0..1CodeableConceptReason for current status
CommunicationRequest Status Reason (Example)
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... category 0..*CodeableConceptMessage category
CommunicationCategory (Example)

... priority Σ0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
ParticipationMode (Example)

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

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

.... content[x] 1..1Message part content
..... contentAttachmentAttachment
..... contentReferenceReference(Any)
..... contentCodeableConceptCodeableConcept
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester Σ0..1Reference(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?
v3 Code System ActReason (Example)

... note 0..*AnnotationComments made about communication request


doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

CommunicationRequest (DomainResource)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 serveridentifier : Identifier [0..*]A plan or proposal that is fulfilled in whole or in part by this requestbasedOn : Reference [0..*] « Any »Completed or terminated request(s) whose function is taken by this new requestreplaces : Reference [0..*] « CommunicationRequest »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 formgroupIdentifier : Identifier [0..1]The status of the proposal or order (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)RequestStatus! »Captures the reason for the current state of the CommunicationRequeststatusReason : CodeableConcept [0..1] « null (Strength=Example) CommunicationRequestStatusRea...?? »Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain (this element modifies the meaning of other elements)intent : code [1..1] « null (Strength=Required)RequestIntent! »The type of message to be sent such as alert, notification, reminder, instruction, etccategory : CodeableConcept [0..*] « null (Strength=Example)CommunicationCategory?? »Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routinepriority : code [0..1] « null (Strength=Required)RequestPriority! »If true indicates that the CommunicationRequest is asking for the specified action to *not* occur (this element modifies the meaning of other elements)doNotPerform : boolean [0..1]A channel that was used for this communication (e.g. email, fax)medium : CodeableConcept [0..*] « null (Strength=Example)ParticipationMode?? »The patient or group that is the focus of this communication requestsubject : Reference [0..1] « Patient|Group »Other resources that pertain to this communication request and to which this communication request should be associatedabout : Reference [0..*] « Any »The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associatedencounter : Reference [0..1] « Encounter »The time when this communication is to occuroccurrence[x] : DataType [0..1] « dateTime|Period »For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activationauthoredOn : dateTime [0..1]The device, individual, or organization who asks for the information to be sharedrequester : Reference [0..1] « Practitioner|PractitionerRole| Organization|Patient|RelatedPerson|Device »The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communicationrecipient : Reference [0..*] « Device|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson|Group|CareTeam| HealthcareService|Endpoint »The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communicationinformationProvider : Reference [0..*] « Device|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson|HealthcareService| Endpoint »Describes why the request is being made in coded or textual formreason : CodeableReference [0..*] « Any; null (Strength=Example)ActReason?? »Comments made about the request by the requester, sender, recipient, subject or other participantsnote : Annotation [0..*]PayloadThe communicated content (or for multi-part communications, one portion of the communication)content[x] : DataType [1..1] « Attachment|Reference(Any)| CodeableConcept »Text, attachment(s), or resource(s) to be communicated to the recipientpayload[0..*]

XML Template

<CommunicationRequest xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


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

Changes since R4

CommunicationRequest
CommunicationRequest.intent
  • Added Mandatory Element
CommunicationRequest.payload.content[x]
  • Add Type CodeableConcept, CodeableConcept
  • Remove Type string, string
  • Remove Type string, string
CommunicationRequest.recipient
  • Type Reference: Added Target Type Endpoint
  • Type Reference: Added Target Type Endpoint
CommunicationRequest.informationProvider
  • Added Element
CommunicationRequest.reason
  • Added Element
CommunicationRequest.sender
  • deleted
CommunicationRequest.reasonCode
  • deleted
CommunicationRequest.reasonReference
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest TUDomainResourceA request for information to be sent to a receiver

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

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

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

... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
... statusReason 0..1CodeableConceptReason for current status
CommunicationRequest Status Reason (Example)
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... category 0..*CodeableConceptMessage category
CommunicationCategory (Example)

... priority Σ0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
ParticipationMode (Example)

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

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

.... content[x] 1..1Message part content
..... contentAttachmentAttachment
..... contentReferenceReference(Any)
..... contentCodeableConceptCodeableConcept
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester Σ0..1Reference(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?
v3 Code System ActReason (Example)

... note 0..*AnnotationComments made about communication request


doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

CommunicationRequest (DomainResource)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 serveridentifier : Identifier [0..*]A plan or proposal that is fulfilled in whole or in part by this requestbasedOn : Reference [0..*] « Any »Completed or terminated request(s) whose function is taken by this new requestreplaces : Reference [0..*] « CommunicationRequest »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 formgroupIdentifier : Identifier [0..1]The status of the proposal or order (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)RequestStatus! »Captures the reason for the current state of the CommunicationRequeststatusReason : CodeableConcept [0..1] « null (Strength=Example) CommunicationRequestStatusRea...?? »Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain (this element modifies the meaning of other elements)intent : code [1..1] « null (Strength=Required)RequestIntent! »The type of message to be sent such as alert, notification, reminder, instruction, etccategory : CodeableConcept [0..*] « null (Strength=Example)CommunicationCategory?? »Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routinepriority : code [0..1] « null (Strength=Required)RequestPriority! »If true indicates that the CommunicationRequest is asking for the specified action to *not* occur (this element modifies the meaning of other elements)doNotPerform : boolean [0..1]A channel that was used for this communication (e.g. email, fax)medium : CodeableConcept [0..*] « null (Strength=Example)ParticipationMode?? »The patient or group that is the focus of this communication requestsubject : Reference [0..1] « Patient|Group »Other resources that pertain to this communication request and to which this communication request should be associatedabout : Reference [0..*] « Any »The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associatedencounter : Reference [0..1] « Encounter »The time when this communication is to occuroccurrence[x] : DataType [0..1] « dateTime|Period »For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activationauthoredOn : dateTime [0..1]The device, individual, or organization who asks for the information to be sharedrequester : Reference [0..1] « Practitioner|PractitionerRole| Organization|Patient|RelatedPerson|Device »The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communicationrecipient : Reference [0..*] « Device|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson|Group|CareTeam| HealthcareService|Endpoint »The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communicationinformationProvider : Reference [0..*] « Device|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson|HealthcareService| Endpoint »Describes why the request is being made in coded or textual formreason : CodeableReference [0..*] « Any; null (Strength=Example)ActReason?? »Comments made about the request by the requester, sender, recipient, subject or other participantsnote : Annotation [0..*]PayloadThe communicated content (or for multi-part communications, one portion of the communication)content[x] : DataType [1..1] « Attachment|Reference(Any)| CodeableConcept »Text, attachment(s), or resource(s) to be communicated to the recipientpayload[0..*]

XML Template

<CommunicationRequest xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


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

Changes since Release 4

CommunicationRequest
CommunicationRequest.intent
  • Added Mandatory Element
CommunicationRequest.payload.content[x]
  • Add Type CodeableConcept, CodeableConcept
  • Remove Type string, string
  • Remove Type string, string
CommunicationRequest.recipient
  • Type Reference: Added Target Type Endpoint
  • Type Reference: Added Target Type Endpoint
CommunicationRequest.informationProvider
  • Added Element
CommunicationRequest.reason
  • Added Element
CommunicationRequest.sender
  • deleted
CommunicationRequest.reasonCode
  • deleted
CommunicationRequest.reasonReference
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

 

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

8.21.4.1 Terminology Bindings

PathDefinitionTypeReference
CommunicationRequest.status

Codes identifying the lifecycle stage of a request.

RequiredRequestStatus
CommunicationRequest.statusReason

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.

ExampleCommunicationRequestStatusReason
CommunicationRequest.intent

Codes indicating the degree of authority/intentionality associated with a request.

RequiredRequestIntent
CommunicationRequest.category

Codes for general categories of communications such as alerts, instructions, etc.

ExampleCommunicationCategory
CommunicationRequest.priority

Identifies the level of importance to be assigned to actioning the request.

RequiredRequestPriority
CommunicationRequest.medium

Identifies the primary means by which an Entity participates in an Act.

ExampleParticipationMode
CommunicationRequest.reason

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

ExampleActReason

Notes to reviewers:

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

8.21.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.21.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
authored NdateWhen request transitioned to being actionableCommunicationRequest.authoredOn
based-onreferenceFulfills plan or proposalCommunicationRequest.basedOn
(Any)
categorytokenMessage categoryCommunicationRequest.category
encounterreferenceThe Encounter during which this CommunicationRequest was createdCommunicationRequest.encounter
(Encounter)
group-identifiertokenComposite request this is part ofCommunicationRequest.groupIdentifier
identifiertokenUnique identifierCommunicationRequest.identifier
information-providerreferenceWho should share the informationCommunicationRequest.informationProvider
(Practitioner, Organization, Endpoint, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson)
mediumtokenA channel of communicationCommunicationRequest.medium
occurrencedateWhen scheduledCommunicationRequest.occurrence.ofType(dateTime) | CommunicationRequest.occurrence.ofType(Period)
patientreferenceFocus of messageCommunicationRequest.subject.where(resolve() is Patient)
(Patient)
priority Ntokenroutine | urgent | asap | statCommunicationRequest.priority
recipientreferenceWho to share the information withCommunicationRequest.recipient
(Practitioner, Group, Organization, CareTeam, Endpoint, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson)
replacesreferenceRequest(s) replaced by this requestCommunicationRequest.replaces
(CommunicationRequest)
requesterreferenceWho asks for the information to be sharedCommunicationRequest.requester
(Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson)
status Ntokendraft | active | on-hold | revoked | completed | entered-in-error | unknownCommunicationRequest.status
subjectreferenceFocus of messageCommunicationRequest.subject
(Group, Patient)