src/FHIR/R4/FHIRElement/FHIRParameterDefinition.php

   1 <?php
   2
   3 namespace OpenEMR\FHIR\R4\FHIRElement;
   4
   5 /*!
   6  * This class was generated with the PHPFHIR library (https://github.com/dcarbone/php-fhir) using
   7  * class definitions from HL7 FHIR (https://www.hl7.org/fhir/)
   8  *
   9  * Class creation date: June 14th, 2019
  10  *
  11  * PHPFHIR Copyright:
  12  *
  13  * Copyright 2016-2017 Daniel Carbone (daniel.p.carbone@gmail.com)
  14  *
  15  * Licensed under the Apache License, Version 2.0 (the "License");
  16  * you may not use this file except in compliance with the License.
  17  * You may obtain a copy of the License at
  18  *
  19  *        http://www.apache.org/licenses/LICENSE-2.0
  20  *
  21  * Unless required by applicable law or agreed to in writing, software
  22  * distributed under the License is distributed on an "AS IS" BASIS,
  23  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  24  * See the License for the specific language governing permissions and
  25  * limitations under the License.
  26  *
  27  *
  28  * FHIR Copyright Notice:
  29  *
  30  *   Copyright (c) 2011+, HL7, Inc.
  31  *   All rights reserved.
  32  *
  33  *   Redistribution and use in source and binary forms, with or without modification,
  34  *   are permitted provided that the following conditions are met:
  35  *
  36  *    * Redistributions of source code must retain the above copyright notice, this
  37  *      list of conditions and the following disclaimer.
  38  *    * Redistributions in binary form must reproduce the above copyright notice,
  39  *      this list of conditions and the following disclaimer in the documentation
  40  *      and/or other materials provided with the distribution.
  41  *    * Neither the name of HL7 nor the names of its contributors may be used to
  42  *      endorse or promote products derived from this software without specific
  43  *      prior written permission.
  44  *
  45  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  46  *   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  47  *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  48  *   IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  49  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  50  *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  51  *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  52  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  53  *   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  54  *   POSSIBILITY OF SUCH DAMAGE.
  55  *
  56  *
  57  *   Generated on Thu, Dec 27, 2018 22:37+1100 for FHIR v4.0.0
  58  *
  59  *   Note: the schemas & schematrons do not contain all of the rules about what makes resources
  60  *   valid. Implementers will still need to be familiar with the content of the specification and with
  61  *   any profiles that apply to the resources in order to make a conformant implementation.
  62  *
  63  */
  64
  65 use OpenEMR\FHIR\R4\FHIRElement;
  66
  67 /**
  68  * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
  69  * If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions
  70  */
  71 class FHIRParameterDefinition extends FHIRElement implements \JsonSerializable
  72 {
  73     /**
  74      * The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
  75      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
  76      */
  77     public $name = null;
  78
  79     /**
  80      * Whether the parameter is input or output for the module.
  81      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
  82      */
  83     public $use = null;
  84
  85     /**
  86      * The minimum number of times this parameter SHALL appear in the request or response.
  87      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRInteger
  88      */
  89     public $min = null;
  90
  91     /**
  92      * The maximum number of times this element is permitted to appear in the request or response.
  93      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
  94      */
  95     public $max = null;
  96
  97     /**
  98      * A brief discussion of what the parameter is for and how it is used by the module.
  99      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 100      */
 101     public $documentation = null;
 102
 103     /**
 104      * The type of the parameter.
 105      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
 106      */
 107     public $type = null;
 108
 109     /**
 110      * If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
 111      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCanonical
 112      */
 113     public $profile = null;
 114
 115     /**
 116      * @var string
 117      */
 118     private $_fhirElementName = 'ParameterDefinition';
 119
 120     /**
 121      * The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
 122      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
 123      */
 124     public function getName()
 125     {
 126         return $this->name;
 127     }
 128
 129     /**
 130      * The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
 131      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCode $name
 132      * @return $this
 133      */
 134     public function setName($name)
 135     {
 136         $this->name = $name;
 137         return $this;
 138     }
 139
 140     /**
 141      * Whether the parameter is input or output for the module.
 142      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
 143      */
 144     public function getUse()
 145     {
 146         return $this->use;
 147     }
 148
 149     /**
 150      * Whether the parameter is input or output for the module.
 151      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCode $use
 152      * @return $this
 153      */
 154     public function setUse($use)
 155     {
 156         $this->use = $use;
 157         return $this;
 158     }
 159
 160     /**
 161      * The minimum number of times this parameter SHALL appear in the request or response.
 162      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRInteger
 163      */
 164     public function getMin()
 165     {
 166         return $this->min;
 167     }
 168
 169     /**
 170      * The minimum number of times this parameter SHALL appear in the request or response.
 171      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRInteger $min
 172      * @return $this
 173      */
 174     public function setMin($min)
 175     {
 176         $this->min = $min;
 177         return $this;
 178     }
 179
 180     /**
 181      * The maximum number of times this element is permitted to appear in the request or response.
 182      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 183      */
 184     public function getMax()
 185     {
 186         return $this->max;
 187     }
 188
 189     /**
 190      * The maximum number of times this element is permitted to appear in the request or response.
 191      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $max
 192      * @return $this
 193      */
 194     public function setMax($max)
 195     {
 196         $this->max = $max;
 197         return $this;
 198     }
 199
 200     /**
 201      * A brief discussion of what the parameter is for and how it is used by the module.
 202      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 203      */
 204     public function getDocumentation()
 205     {
 206         return $this->documentation;
 207     }
 208
 209     /**
 210      * A brief discussion of what the parameter is for and how it is used by the module.
 211      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $documentation
 212      * @return $this
 213      */
 214     public function setDocumentation($documentation)
 215     {
 216         $this->documentation = $documentation;
 217         return $this;
 218     }
 219
 220     /**
 221      * The type of the parameter.
 222      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
 223      */
 224     public function getType()
 225     {
 226         return $this->type;
 227     }
 228
 229     /**
 230      * The type of the parameter.
 231      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCode $type
 232      * @return $this
 233      */
 234     public function setType($type)
 235     {
 236         $this->type = $type;
 237         return $this;
 238     }
 239
 240     /**
 241      * If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
 242      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCanonical
 243      */
 244     public function getProfile()
 245     {
 246         return $this->profile;
 247     }
 248
 249     /**
 250      * If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
 251      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCanonical $profile
 252      * @return $this
 253      */
 254     public function setProfile($profile)
 255     {
 256         $this->profile = $profile;
 257         return $this;
 258     }
 259
 260     /**
 261      * @return string
 262      */
 263     public function get_fhirElementName()
 264     {
 265         return $this->_fhirElementName;
 266     }
 267
 268     /**
 269      * @param mixed $data
 270      */
 271     public function __construct($data = [])
 272     {
 273         if (is_array($data)) {
 274             if (isset($data['name'])) {
 275                 $this->setName($data['name']);
 276             }
 277             if (isset($data['use'])) {
 278                 $this->setUse($data['use']);
 279             }
 280             if (isset($data['min'])) {
 281                 $this->setMin($data['min']);
 282             }
 283             if (isset($data['max'])) {
 284                 $this->setMax($data['max']);
 285             }
 286             if (isset($data['documentation'])) {
 287                 $this->setDocumentation($data['documentation']);
 288             }
 289             if (isset($data['type'])) {
 290                 $this->setType($data['type']);
 291             }
 292             if (isset($data['profile'])) {
 293                 $this->setProfile($data['profile']);
 294             }
 295         } elseif (null !== $data) {
 296             throw new \InvalidArgumentException('$data expected to be array of values, saw "' . gettype($data) . '"');
 297         }
 298         parent::__construct($data);
 299     }
 300
 301     /**
 302      * @return string
 303      */
 304     public function __toString()
 305     {
 306         return $this->get_fhirElementName();
 307     }
 308
 309     /**
 310      * @return array
 311      */
 312     public function jsonSerialize(): mixed
 313     {
 314         $json = parent::jsonSerialize();
 315         if (isset($this->name)) {
 316             $json['name'] = $this->name;
 317         }
 318         if (isset($this->use)) {
 319             $json['use'] = $this->use;
 320         }
 321         if (isset($this->min)) {
 322             $json['min'] = $this->min;
 323         }
 324         if (isset($this->max)) {
 325             $json['max'] = $this->max;
 326         }
 327         if (isset($this->documentation)) {
 328             $json['documentation'] = $this->documentation;
 329         }
 330         if (isset($this->type)) {
 331             $json['type'] = $this->type;
 332         }
 333         if (isset($this->profile)) {
 334             $json['profile'] = $this->profile;
 335         }
 336         return $json;
 337     }
 338
 339     /**
 340      * @param boolean $returnSXE
 341      * @param \SimpleXMLElement $sxe
 342      * @return string|\SimpleXMLElement
 343      */
 344     public function xmlSerialize($returnSXE = false, $sxe = null)
 345     {
 346         if (null === $sxe) {
 347             $sxe = new \SimpleXMLElement('<ParameterDefinition xmlns="http://hl7.org/fhir"></ParameterDefinition>');
 348         }
 349         parent::xmlSerialize(true, $sxe);
 350         if (isset($this->name)) {
 351             $this->name->xmlSerialize(true, $sxe->addChild('name'));
 352         }
 353         if (isset($this->use)) {
 354             $this->use->xmlSerialize(true, $sxe->addChild('use'));
 355         }
 356         if (isset($this->min)) {
 357             $this->min->xmlSerialize(true, $sxe->addChild('min'));
 358         }
 359         if (isset($this->max)) {
 360             $this->max->xmlSerialize(true, $sxe->addChild('max'));
 361         }
 362         if (isset($this->documentation)) {
 363             $this->documentation->xmlSerialize(true, $sxe->addChild('documentation'));
 364         }
 365         if (isset($this->type)) {
 366             $this->type->xmlSerialize(true, $sxe->addChild('type'));
 367         }
 368         if (isset($this->profile)) {
 369             $this->profile->xmlSerialize(true, $sxe->addChild('profile'));
 370         }
 371         if ($returnSXE) {
 372             return $sxe;
 373         }
 374         return $sxe->saveXML();
 375     }
 376 }