description: Defines the structure of CommunicationRequest resources used for in-product (web application) notifications.
package_name: his.lw
derivation: constraint
name: CommunicationRequestWebAppNotification
type: CommunicationRequest
elements:
  status: {short: 'Represents the current lifecycle state (e.g., active or revoked)', index: 0}
  intent:
    short: Always represents an order to deliver the notification
    pattern: {type: Code, value: order}
    index: 1
  priority:
    short: Default priority for UI alerts
    pattern: {type: Code, value: routine}
    index: 2
  medium:
    short: In-app channel definition
    index: 3
    elements:
      coding:
        pattern:
          type: Coding
          value: {code: WRITTEN, system: 'http://terminology.hl7.org/CodeSystem/v3-ParticipationMode'}
        index: 4
    required: [coding]
  authoredOn: {short: When the notification was generated, index: 5}
  recipient:
    type: Reference
    short: One or more target accounts (organization, patient, or contact)
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    index: 6
  payload:
    short: Notification content
    index: 7
    elements:
      content:
        short: Payload is provided as an Attachment
        choices: [contentAttachment]
        index: 9
      contentAttachment:
        type: Attachment
        short: Payload is provided as an Attachment
        choiceOf: content
        index: 10
        elements:
          contentType:
            short: Currently plain text payloads are supported
            pattern: {type: Code, value: text/plain}
            index: 11
          data: {short: Base64-encoded notification body, index: 12}
          title: {short: Short subject shown to the user, index: 13}
        required: [title, contentType, data]
package_version: 1.0.0
class: profile
kind: resource
url: https://dev.azure.com/LionwoodDev/HIS/_git/fhir/StructureDefinition/CommunicationRequest/webapp-notification
base: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
version: 1.0.0
required: [authoredOn, recipient, medium, payload]