src/FHIR/R4/FHIRElement/FHIRCoding.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  * A reference to a code defined by a terminology system.
  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 FHIRCoding extends FHIRElement implements \JsonSerializable
  72 {
  73     /**
  74      * The identification of the code system that defines the meaning of the symbol in the code.
  75      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRUri
  76      */
  77     public $system = null;
  78
  79     /**
  80      * The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
  81      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
  82      */
  83     public $version = null;
  84
  85     /**
  86      * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  87      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
  88      */
  89     public $code = null;
  90
  91     /**
  92      * A representation of the meaning of the code in the system, following the rules of the system.
  93      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
  94      */
  95     public $display = null;
  96
  97     /**
  98      * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
  99      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRBoolean
 100      */
 101     public $userSelected = null;
 102
 103     /**
 104      * @var string
 105      */
 106     private $_fhirElementName = 'Coding';
 107
 108     /**
 109      * The identification of the code system that defines the meaning of the symbol in the code.
 110      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRUri
 111      */
 112     public function getSystem()
 113     {
 114         return $this->system;
 115     }
 116
 117     /**
 118      * The identification of the code system that defines the meaning of the symbol in the code.
 119      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRUri $system
 120      * @return $this
 121      */
 122     public function setSystem($system)
 123     {
 124         $this->system = $system;
 125         return $this;
 126     }
 127
 128     /**
 129      * The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
 130      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 131      */
 132     public function getVersion()
 133     {
 134         return $this->version;
 135     }
 136
 137     /**
 138      * The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
 139      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $version
 140      * @return $this
 141      */
 142     public function setVersion($version)
 143     {
 144         $this->version = $version;
 145         return $this;
 146     }
 147
 148     /**
 149      * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
 150      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCode
 151      */
 152     public function getCode()
 153     {
 154         return $this->code;
 155     }
 156
 157     /**
 158      * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
 159      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCode $code
 160      * @return $this
 161      */
 162     public function setCode($code)
 163     {
 164         $this->code = $code;
 165         return $this;
 166     }
 167
 168     /**
 169      * A representation of the meaning of the code in the system, following the rules of the system.
 170      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 171      */
 172     public function getDisplay()
 173     {
 174         return $this->display;
 175     }
 176
 177     /**
 178      * A representation of the meaning of the code in the system, following the rules of the system.
 179      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $display
 180      * @return $this
 181      */
 182     public function setDisplay($display)
 183     {
 184         $this->display = $display;
 185         return $this;
 186     }
 187
 188     /**
 189      * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
 190      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRBoolean
 191      */
 192     public function getUserSelected()
 193     {
 194         return $this->userSelected;
 195     }
 196
 197     /**
 198      * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
 199      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRBoolean $userSelected
 200      * @return $this
 201      */
 202     public function setUserSelected($userSelected)
 203     {
 204         $this->userSelected = $userSelected;
 205         return $this;
 206     }
 207
 208     /**
 209      * @return string
 210      */
 211     public function get_fhirElementName()
 212     {
 213         return $this->_fhirElementName;
 214     }
 215
 216     /**
 217      * @param mixed $data
 218      */
 219     public function __construct($data = [])
 220     {
 221         if (is_array($data)) {
 222             if (isset($data['system'])) {
 223                 $this->setSystem($data['system']);
 224             }
 225             if (isset($data['version'])) {
 226                 $this->setVersion($data['version']);
 227             }
 228             if (isset($data['code'])) {
 229                 $this->setCode($data['code']);
 230             }
 231             if (isset($data['display'])) {
 232                 $this->setDisplay($data['display']);
 233             }
 234             if (isset($data['userSelected'])) {
 235                 $this->setUserSelected($data['userSelected']);
 236             }
 237         } elseif (null !== $data) {
 238             throw new \InvalidArgumentException('$data expected to be array of values, saw "' . gettype($data) . '"');
 239         }
 240         parent::__construct($data);
 241     }
 242
 243     /**
 244      * @return string
 245      */
 246     public function __toString()
 247     {
 248         return $this->get_fhirElementName();
 249     }
 250
 251     /**
 252      * @return array
 253      */
 254     public function jsonSerialize(): mixed
 255     {
 256         $json = parent::jsonSerialize();
 257         if (isset($this->system)) {
 258             $json['system'] = $this->system;
 259         }
 260         if (isset($this->version)) {
 261             $json['version'] = $this->version;
 262         }
 263         if (isset($this->code)) {
 264             $json['code'] = $this->code;
 265         }
 266         if (isset($this->display)) {
 267             $json['display'] = $this->display;
 268         }
 269         if (isset($this->userSelected)) {
 270             $json['userSelected'] = $this->userSelected;
 271         }
 272         return $json;
 273     }
 274
 275     /**
 276      * @param boolean $returnSXE
 277      * @param \SimpleXMLElement $sxe
 278      * @return string|\SimpleXMLElement
 279      */
 280     public function xmlSerialize($returnSXE = false, $sxe = null)
 281     {
 282         if (null === $sxe) {
 283             $sxe = new \SimpleXMLElement('<Coding xmlns="http://hl7.org/fhir"></Coding>');
 284         }
 285         parent::xmlSerialize(true, $sxe);
 286         if (isset($this->system)) {
 287             $this->system->xmlSerialize(true, $sxe->addChild('system'));
 288         }
 289         if (isset($this->version)) {
 290             $this->version->xmlSerialize(true, $sxe->addChild('version'));
 291         }
 292         if (isset($this->code)) {
 293             $this->code->xmlSerialize(true, $sxe->addChild('code'));
 294         }
 295         if (isset($this->display)) {
 296             $this->display->xmlSerialize(true, $sxe->addChild('display'));
 297         }
 298         if (isset($this->userSelected)) {
 299             $this->userSelected->xmlSerialize(true, $sxe->addChild('userSelected'));
 300         }
 301         if ($returnSXE) {
 302             return $sxe;
 303         }
 304         return $sxe->saveXML();
 305     }
 306 }