src/Events/PatientDocuments/PatientDocumentViewCCDAEvent.php

   1 <?php
   2
   3 /**
   4  * PatientDocumentViewCCDAEvent is fired when a ccda document (CCD/CCR/etc) is being viewed in the system.  Consumers
   5  * of the event can transform the content of the CCDA before it is displayed to the end user or downloaded.
   6  *
   7  * The format field can be used to determine whether the output will be a xml, or html document allowing consumers to
   8  * modify the contents.
   9  *
  10  * @package openemr
  11  * @link      http://www.open-emr.org
  12  * @author    Stephen Nielson <snielson@discoverandchange.com>
  13  * @copyright Copyright (c) 2022 Discover and Change <snielson@discoverandchange.com>
  14  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  15  */
  16
  17 namespace OpenEMR\Events\PatientDocuments;
  18
  19 class PatientDocumentViewCCDAEvent
  20 {
  21     /**
  22      * Name of the event
  23      */
  24     const EVENT_NAME = "patient.ccda.view";
  25
  26     /**
  27      * @var int The database identifier for the generated ccda as stored in the ccda table
  28      */
  29     private $ccdaId;
  30
  31     /**
  32      * @var int The database identifier for the ccda document stored in the database if it exists
  33      */
  34     private $documentId;
  35
  36     /**
  37      * @var string The type of ccda document.  Valid options are currently CCD/Referral/CCDA
  38      */
  39     private $ccdaType;
  40
  41     /**
  42      * @var string The CCDA document content that is to be viewed / output to the screen by the final event consumer
  43      */
  44     private $content;
  45
  46     /**
  47      * @var string The path to the stylesheet that was last used to transform the content (empty if no stylesheet was used)
  48      */
  49     private $stylesheetPath;
  50
  51     /**
  52      * @var string xml|html The output format we want to view the ccda in.  Default is html for the human readable format
  53      */
  54     private $format;
  55
  56     /**
  57      * @var boolean True if the ccda should ignore the user preferences (trimming, sort order, etc).  Default false
  58      */
  59     private $ignoreUserPreferences;
  60
  61     public function __construct()
  62     {
  63         $this->format = "html";
  64         $this->ignoreUserPreferences = false;
  65         $this->stylesheetPath = "";
  66         $this->ccdaId = 0;
  67         $this->documentId = 0;
  68     }
  69
  70     /**
  71      * @return int
  72      */
  73     public function getCcdaId(): int
  74     {
  75         return $this->ccdaId;
  76     }
  77
  78     /**
  79      * @param int $ccdaId
  80      * @return PatientDocumentViewCCDAEvent
  81      */
  82     public function setCcdaId(int $ccdaId): PatientDocumentViewCCDAEvent
  83     {
  84         $this->ccdaId = $ccdaId;
  85         return $this;
  86     }
  87
  88     /**
  89      * @return int
  90      */
  91     public function getDocumentId(): int
  92     {
  93         return $this->documentId;
  94     }
  95
  96     /**
  97      * @param int $documentId
  98      * @return PatientDocumentViewCCDAEvent
  99      */
 100     public function setDocumentId(int $documentId): PatientDocumentViewCCDAEvent
 101     {
 102         $this->documentId = $documentId;
 103         return $this;
 104     }
 105
 106     /**
 107      * @return string
 108      */
 109     public function getStylesheetPath(): string
 110     {
 111         return $this->stylesheetPath;
 112     }
 113
 114     /**
 115      * @param string $stylesheetPath
 116      * @return PatientDocumentViewCCDAEvent
 117      */
 118     public function setStylesheetPath(string $stylesheetPath): PatientDocumentViewCCDAEvent
 119     {
 120         $this->stylesheetPath = $stylesheetPath;
 121         return $this;
 122     }
 123
 124     /**
 125      * @return string
 126      */
 127     public function getCcdaType(): string
 128     {
 129         return $this->ccdaType;
 130     }
 131
 132     /**
 133      * @param string $ccdaType
 134      * @return PatientDocumentViewCCDAEvent
 135      */
 136     public function setCcdaType(string $ccdaType): PatientDocumentViewCCDAEvent
 137     {
 138         $this->ccdaType = $ccdaType;
 139         return $this;
 140     }
 141
 142     /**
 143      * @return string
 144      */
 145     public function getContent(): string
 146     {
 147         return $this->content;
 148     }
 149
 150     /**
 151      * @param string $content
 152      * @return PatientDocumentViewCCDAEvent
 153      */
 154     public function setContent(string $content): PatientDocumentViewCCDAEvent
 155     {
 156         $this->content = $content;
 157         return $this;
 158     }
 159
 160     /**
 161      * @return string
 162      */
 163     public function getFormat(): string
 164     {
 165         return $this->format;
 166     }
 167
 168     /**
 169      * @param string $format
 170      * @return PatientDocumentViewCCDAEvent
 171      */
 172     public function setFormat(string $format): PatientDocumentViewCCDAEvent
 173     {
 174         $this->format = $format;
 175         return $this;
 176     }
 177
 178     /**
 179      * @return bool
 180      */
 181     public function shouldIgnoreUserPreferences(): bool
 182     {
 183         return $this->ignoreUserPreferences;
 184     }
 185
 186     /**
 187      * @param bool $ignoreUserPreferences
 188      * @return PatientDocumentViewCCDAEvent
 189      */
 190     public function setIgnoreUserPreferences(bool $ignoreUserPreferences): PatientDocumentViewCCDAEvent
 191     {
 192         $this->ignoreUserPreferences = $ignoreUserPreferences;
 193         return $this;
 194     }
 195 }