description: null
package_name: hl7.fhir.r4b.core
derivation: specialization
name: CommunicationRequest
type: CommunicationRequest
elements:
  category:
    isModifier: false
    short: Message category
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/communication-category'}
    isSummary: false
    index: 6
  payload:
    isModifier: false
    short: Message payload
    index: 13
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      content:
        isModifier: false
        short: Message part content
        mustSupport: false
        choices: [contentString, contentAttachment, contentReference]
        isSummary: false
        index: 15
      contentString: {isModifier: false, short: Message part content, type: string, mustSupport: false, choiceOf: content, isSummary: false, index: 16}
      contentAttachment: {isModifier: false, short: Message part content, type: Attachment, mustSupport: false, choiceOf: content, isSummary: false, index: 17}
      contentReference:
        isModifier: false
        short: Message part content
        index: 18
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        mustSupport: false
        choiceOf: content
        isSummary: false
    required: [contentAttachment, contentString, contentReference, content]
    isSummary: false
  encounter:
    isModifier: false
    short: Encounter created as part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 12
  medium:
    isModifier: false
    short: A channel of communication
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ParticipationMode'}
    isSummary: false
    index: 9
  recipient:
    isModifier: false
    short: Message recipient
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', '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
    mustSupport: false
    array: true
    isSummary: false
    index: 25
  reasonCode:
    isModifier: false
    short: Why is communication needed?
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActReason'}
    isSummary: true
    index: 27
  statusReason: {isModifier: false, short: Reason for current status, type: CodeableConcept, mustSupport: false, isSummary: false, index: 5}
  authoredOn: {isModifier: false, short: When request transitioned to being actionable, type: dateTime, mustSupport: false, isSummary: true, index: 23}
  note: {isModifier: false, short: Comments made about communication request, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 29}
  requester:
    isModifier: false
    short: Who/what is requesting service
    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
    mustSupport: false
    isSummary: true
    index: 24
  priority:
    isModifier: false
    short: routine | urgent | asap | stat
    type: code
    mustSupport: false
    meaningWhenMissing: If missing, this task should be performed with normal priority
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|4.1.0'}
    isSummary: true
    index: 7
  occurrencePeriod: {isModifier: false, short: When scheduled, type: Period, mustSupport: false, choiceOf: occurrence, isSummary: true, index: 22}
  status:
    isModifier: true
    short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    index: 4
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-status|4.1.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
  groupIdentifier: {isModifier: false, short: Composite request this is part of, type: Identifier, mustSupport: false, isSummary: true, index: 3}
  sender:
    isModifier: false
    short: Message sender
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', '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
    mustSupport: false
    isSummary: true
    index: 26
  identifier: {isModifier: false, short: Unique identifier, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  doNotPerform: {isModifier: true, short: True if request is prohibiting action, type: boolean, mustSupport: false, 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:
    isModifier: false
    short: Request(s) replaced by this request
    refers: ['http://hl7.org/fhir/StructureDefinition/CommunicationRequest']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 2
  basedOn:
    isModifier: false
    short: Fulfills plan or proposal
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 1
  occurrenceDateTime: {isModifier: false, short: When scheduled, type: dateTime, mustSupport: false, choiceOf: occurrence, isSummary: true, index: 21}
  subject:
    isModifier: false
    short: Focus of message
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 10
  occurrence:
    isModifier: false
    short: When scheduled
    mustSupport: false
    choices: [occurrenceDateTime, occurrencePeriod]
    isSummary: true
    index: 20
  about:
    isModifier: false
    short: Resources that pertain to this communication request
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 11
  reasonReference:
    isModifier: false
    short: Why is communication needed?
    refers: ['http://hl7.org/fhir/StructureDefinition/Condition', 'http://hl7.org/fhir/StructureDefinition/DiagnosticReport', 'http://hl7.org/fhir/StructureDefinition/DocumentReference', 'http://hl7.org/fhir/StructureDefinition/Observation']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 28
package_version: 4.1.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.1.0
required: [status]