phpfhir/HL7/FHIR/STU3/src/FHIRResource/FHIRMeasure/FHIRMeasureSupplementalData.php

   1 <?php namespace HL7\FHIR\STU3\FHIRResource\FHIRMeasure;
   2
   3 /*!
   4  * This class was generated with the PHPFHIR library (https://github.com/dcarbone/php-fhir) using
   5  * class definitions from HL7 FHIR (https://www.hl7.org/fhir/)
   6  *
   7  * Class creation date: February 10th, 2018
   8  */
   9
  10 use HL7\FHIR\STU3\FHIRElement\FHIRBackboneElement;
  11
  12 /**
  13  * The Measure resource provides the definition of a quality measure.
  14  */
  15 class FHIRMeasureSupplementalData extends FHIRBackboneElement implements \JsonSerializable
  16 {
  17     /**
  18      * An identifier for the supplemental data.
  19      * @var \HL7\FHIR\STU3\FHIRElement\FHIRIdentifier
  20      */
  21     public $identifier = null;
  22
  23     /**
  24      * An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
  25      * @var \HL7\FHIR\STU3\FHIRElement\FHIRCodeableConcept[]
  26      */
  27     public $usage = [];
  28
  29     /**
  30      * The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.
  31      * @var \HL7\FHIR\STU3\FHIRElement\FHIRString
  32      */
  33     public $criteria = null;
  34
  35     /**
  36      * The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.
  37      * @var \HL7\FHIR\STU3\FHIRElement\FHIRString
  38      */
  39     public $path = null;
  40
  41     /**
  42      * @var string
  43      */
  44     private $_fhirElementName = 'Measure.SupplementalData';
  45
  46     /**
  47      * An identifier for the supplemental data.
  48      * @return \HL7\FHIR\STU3\FHIRElement\FHIRIdentifier
  49      */
  50     public function getIdentifier()
  51     {
  52         return $this->identifier;
  53     }
  54
  55     /**
  56      * An identifier for the supplemental data.
  57      * @param \HL7\FHIR\STU3\FHIRElement\FHIRIdentifier $identifier
  58      * @return $this
  59      */
  60     public function setIdentifier($identifier)
  61     {
  62         $this->identifier = $identifier;
  63         return $this;
  64     }
  65
  66     /**
  67      * An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
  68      * @return \HL7\FHIR\STU3\FHIRElement\FHIRCodeableConcept[]
  69      */
  70     public function getUsage()
  71     {
  72         return $this->usage;
  73     }
  74
  75     /**
  76      * An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
  77      * @param \HL7\FHIR\STU3\FHIRElement\FHIRCodeableConcept $usage
  78      * @return $this
  79      */
  80     public function addUsage($usage)
  81     {
  82         $this->usage[] = $usage;
  83         return $this;
  84     }
  85
  86     /**
  87      * The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.
  88      * @return \HL7\FHIR\STU3\FHIRElement\FHIRString
  89      */
  90     public function getCriteria()
  91     {
  92         return $this->criteria;
  93     }
  94
  95     /**
  96      * The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.
  97      * @param \HL7\FHIR\STU3\FHIRElement\FHIRString $criteria
  98      * @return $this
  99      */
 100     public function setCriteria($criteria)
 101     {
 102         $this->criteria = $criteria;
 103         return $this;
 104     }
 105
 106     /**
 107      * The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.
 108      * @return \HL7\FHIR\STU3\FHIRElement\FHIRString
 109      */
 110     public function getPath()
 111     {
 112         return $this->path;
 113     }
 114
 115     /**
 116      * The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.
 117      * @param \HL7\FHIR\STU3\FHIRElement\FHIRString $path
 118      * @return $this
 119      */
 120     public function setPath($path)
 121     {
 122         $this->path = $path;
 123         return $this;
 124     }
 125
 126     /**
 127      * @return string
 128      */
 129     public function get_fhirElementName()
 130     {
 131         return $this->_fhirElementName;
 132     }
 133
 134     /**
 135      * @param mixed $data
 136      */
 137     public function __construct($data = [])
 138     {
 139         if (is_array($data)) {
 140             if (isset($data['identifier'])) {
 141                 $this->setIdentifier($data['identifier']);
 142             }
 143             if (isset($data['usage'])) {
 144                 if (is_array($data['usage'])) {
 145                     foreach ($data['usage'] as $d) {
 146                         $this->addUsage($d);
 147                     }
 148                 } else {
 149                     throw new \InvalidArgumentException('"usage" must be array of objects or null, '.gettype($data['usage']).' seen.');
 150                 }
 151             }
 152             if (isset($data['criteria'])) {
 153                 $this->setCriteria($data['criteria']);
 154             }
 155             if (isset($data['path'])) {
 156                 $this->setPath($data['path']);
 157             }
 158         } else if (null !== $data) {
 159             throw new \InvalidArgumentException('$data expected to be array of values, saw "'.gettype($data).'"');
 160         }
 161         parent::__construct($data);
 162     }
 163
 164     /**
 165      * @return string
 166      */
 167     public function __toString()
 168     {
 169         return $this->get_fhirElementName();
 170     }
 171
 172     /**
 173      * @return array
 174      */
 175     public function jsonSerialize()
 176     {
 177         $json = parent::jsonSerialize();
 178         if (isset($this->identifier)) {
 179             $json['identifier'] = $this->identifier;
 180         }
 181         if (0 < count($this->usage)) {
 182             $json['usage'] = [];
 183             foreach ($this->usage as $usage) {
 184                 $json['usage'][] = $usage;
 185             }
 186         }
 187         if (isset($this->criteria)) {
 188             $json['criteria'] = $this->criteria;
 189         }
 190         if (isset($this->path)) {
 191             $json['path'] = $this->path;
 192         }
 193         return $json;
 194     }
 195
 196     /**
 197      * @param boolean $returnSXE
 198      * @param \SimpleXMLElement $sxe
 199      * @return string|\SimpleXMLElement
 200      */
 201     public function xmlSerialize($returnSXE = false, $sxe = null)
 202     {
 203         if (null === $sxe) {
 204             $sxe = new \SimpleXMLElement('<MeasureSupplementalData xmlns="http://hl7.org/fhir"></MeasureSupplementalData>');
 205         }
 206         parent::xmlSerialize(true, $sxe);
 207         if (isset($this->identifier)) {
 208             $this->identifier->xmlSerialize(true, $sxe->addChild('identifier'));
 209         }
 210         if (0 < count($this->usage)) {
 211             foreach ($this->usage as $usage) {
 212                 $usage->xmlSerialize(true, $sxe->addChild('usage'));
 213             }
 214         }
 215         if (isset($this->criteria)) {
 216             $this->criteria->xmlSerialize(true, $sxe->addChild('criteria'));
 217         }
 218         if (isset($this->path)) {
 219             $this->path->xmlSerialize(true, $sxe->addChild('path'));
 220         }
 221         if ($returnSXE) {
 222             return $sxe;
 223         }
 224         return $sxe->saveXML();
 225     }
 226 }