description: 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.
package_name: hl7.fhir.r5.core
derivation: specialization
name: CommunicationRequest
type: CommunicationRequest
elements:
  category:
    short: Message category
    type: CodeableConcept
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/communication-category'}
    index: 6
  payload:
    type: BackboneElement
    short: Message payload
    array: true
    index: 13
    elements:
      content:
        short: Message part content
        choices: [contentAttachment, contentReference, contentCodeableConcept]
        index: 15
      contentAttachment: {short: Message part content, type: Attachment, choiceOf: content, index: 16}
      contentReference:
        short: Message part content
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        choiceOf: content
        index: 17
      contentCodeableConcept: {short: Message part content, type: CodeableConcept, choiceOf: content, index: 18}
    required: [contentAttachment, contentReference, content, contentCodeableConcept]
  encounter:
    short: The Encounter during which this CommunicationRequest was created
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    isSummary: true
    index: 12
  medium:
    type: CodeableConcept
    short: A channel of communication
    binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ParticipationMode'}
    array: true
    index: 9
  informationProvider:
    short: Who should share the information
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Endpoint', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    array: true
    isSummary: true
    index: 26
  recipient:
    short: Who to share the information with
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Endpoint', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    array: true
    index: 25
  statusReason:
    short: Reason for current status
    type: CodeableConcept
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/communication-request-status-reason'}
    index: 5
  authoredOn: {short: When request transitioned to being actionable, type: dateTime, isSummary: true, index: 23}
  note: {type: Annotation, short: Comments made about communication request, array: true, index: 28}
  reason:
    short: Why is communication needed?
    type: CodeableReference
    array: true
    binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActReason'}
    isSummary: true
    index: 27
  requester:
    short: Who asks for the information to be shared
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    isSummary: true
    index: 24
  priority:
    short: routine | urgent | asap | stat
    type: code
    meaningWhenMissing: If missing, this task should be performed with normal priority
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|4.4.0'}
    isSummary: true
    index: 7
  occurrencePeriod: {short: When scheduled, type: Period, choiceOf: occurrence, isSummary: true, index: 22}
  status:
    isModifier: true
    short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-status|4.4.0'}
    isModifierReason: 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.
    isSummary: true
    index: 4
  groupIdentifier: {short: Composite request this is part of, type: Identifier, isSummary: true, index: 3}
  identifier: {short: Unique identifier, type: Identifier, array: true, isSummary: true, index: 0}
  doNotPerform: {isModifier: true, short: True if request is prohibiting action, type: boolean, meaningWhenMissing: 'If do not perform is not specified, the request is a positive request e.g. "do perform"', isModifierReason: '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.', isSummary: true, index: 8}
  replaces:
    short: Request(s) replaced by this request
    refers: ['http://hl7.org/fhir/StructureDefinition/CommunicationRequest']
    type: Reference
    array: true
    isSummary: true
    index: 2
  basedOn:
    short: Fulfills plan or proposal
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    isSummary: true
    index: 1
  occurrenceDateTime: {short: When scheduled, type: dateTime, choiceOf: occurrence, isSummary: true, index: 21}
  subject:
    short: Focus of message
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    index: 10
  occurrence:
    short: When scheduled
    choices: [occurrenceDateTime, occurrencePeriod]
    isSummary: true
    index: 20
  about:
    short: Resources that pertain to this communication request
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 11
package_version: 4.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.4.0
required: [status]