src/FHIR/R4/FHIRElement/FHIRIdentifier.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  * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
  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 FHIRIdentifier extends FHIRElement implements \JsonSerializable
  72 {
  73     /**
  74      * The purpose of this identifier.
  75      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRIdentifierUse
  76      */
  77     public $use = null;
  78
  79     /**
  80      * A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
  81      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCodeableConcept
  82      */
  83     public $type = null;
  84
  85     /**
  86      * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
  87      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRUri
  88      */
  89     public $system = null;
  90
  91     /**
  92      * The portion of the identifier typically relevant to the user and which is unique within the context of the system.
  93      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
  94      */
  95     public $value = null;
  96
  97     /**
  98      * Time period during which identifier is/was valid for use.
  99      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRPeriod
 100      */
 101     public $period = null;
 102
 103     /**
 104      * Organization that issued/manages the identifier.
 105      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRReference
 106      */
 107     public $assigner = null;
 108
 109     /**
 110      * @var string
 111      */
 112     private $_fhirElementName = 'Identifier';
 113
 114     /**
 115      * The purpose of this identifier.
 116      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRIdentifierUse
 117      */
 118     public function getUse()
 119     {
 120         return $this->use;
 121     }
 122
 123     /**
 124      * The purpose of this identifier.
 125      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRIdentifierUse $use
 126      * @return $this
 127      */
 128     public function setUse($use)
 129     {
 130         $this->use = $use;
 131         return $this;
 132     }
 133
 134     /**
 135      * A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
 136      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCodeableConcept
 137      */
 138     public function getType()
 139     {
 140         return $this->type;
 141     }
 142
 143     /**
 144      * A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
 145      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCodeableConcept $type
 146      * @return $this
 147      */
 148     public function setType($type)
 149     {
 150         $this->type = $type;
 151         return $this;
 152     }
 153
 154     /**
 155      * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
 156      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRUri
 157      */
 158     public function getSystem()
 159     {
 160         return $this->system;
 161     }
 162
 163     /**
 164      * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
 165      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRUri $system
 166      * @return $this
 167      */
 168     public function setSystem($system)
 169     {
 170         $this->system = $system;
 171         return $this;
 172     }
 173
 174     /**
 175      * The portion of the identifier typically relevant to the user and which is unique within the context of the system.
 176      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 177      */
 178     public function getValue()
 179     {
 180         return $this->value;
 181     }
 182
 183     /**
 184      * The portion of the identifier typically relevant to the user and which is unique within the context of the system.
 185      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $value
 186      * @return $this
 187      */
 188     public function setValue($value)
 189     {
 190         $this->value = $value;
 191         return $this;
 192     }
 193
 194     /**
 195      * Time period during which identifier is/was valid for use.
 196      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRPeriod
 197      */
 198     public function getPeriod()
 199     {
 200         return $this->period;
 201     }
 202
 203     /**
 204      * Time period during which identifier is/was valid for use.
 205      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRPeriod $period
 206      * @return $this
 207      */
 208     public function setPeriod($period)
 209     {
 210         $this->period = $period;
 211         return $this;
 212     }
 213
 214     /**
 215      * Organization that issued/manages the identifier.
 216      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRReference
 217      */
 218     public function getAssigner()
 219     {
 220         return $this->assigner;
 221     }
 222
 223     /**
 224      * Organization that issued/manages the identifier.
 225      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRReference $assigner
 226      * @return $this
 227      */
 228     public function setAssigner($assigner)
 229     {
 230         $this->assigner = $assigner;
 231         return $this;
 232     }
 233
 234     /**
 235      * @return string
 236      */
 237     public function get_fhirElementName()
 238     {
 239         return $this->_fhirElementName;
 240     }
 241
 242     /**
 243      * @param mixed $data
 244      */
 245     public function __construct($data = [])
 246     {
 247         if (is_array($data)) {
 248             if (isset($data['use'])) {
 249                 $this->setUse($data['use']);
 250             }
 251             if (isset($data['type'])) {
 252                 $this->setType($data['type']);
 253             }
 254             if (isset($data['system'])) {
 255                 $this->setSystem($data['system']);
 256             }
 257             if (isset($data['value'])) {
 258                 $this->setValue($data['value']);
 259             }
 260             if (isset($data['period'])) {
 261                 $this->setPeriod($data['period']);
 262             }
 263             if (isset($data['assigner'])) {
 264                 $this->setAssigner($data['assigner']);
 265             }
 266         } elseif (null !== $data) {
 267             throw new \InvalidArgumentException('$data expected to be array of values, saw "' . gettype($data) . '"');
 268         }
 269         parent::__construct($data);
 270     }
 271
 272     /**
 273      * @return string
 274      */
 275     public function __toString()
 276     {
 277         return (string)$this->getValue();
 278     }
 279
 280     /**
 281      * @return array
 282      */
 283     public function jsonSerialize(): mixed
 284     {
 285         $json = parent::jsonSerialize();
 286         if (isset($this->use)) {
 287             $json['use'] = $this->use;
 288         }
 289         if (isset($this->type)) {
 290             $json['type'] = $this->type;
 291         }
 292         if (isset($this->system)) {
 293             $json['system'] = $this->system;
 294         }
 295         if (isset($this->value)) {
 296             $json['value'] = $this->value;
 297         }
 298         if (isset($this->period)) {
 299             $json['period'] = $this->period;
 300         }
 301         if (isset($this->assigner)) {
 302             $json['assigner'] = $this->assigner;
 303         }
 304         return $json;
 305     }
 306
 307     /**
 308      * @param boolean $returnSXE
 309      * @param \SimpleXMLElement $sxe
 310      * @return string|\SimpleXMLElement
 311      */
 312     public function xmlSerialize($returnSXE = false, $sxe = null)
 313     {
 314         if (null === $sxe) {
 315             $sxe = new \SimpleXMLElement('<Identifier xmlns="http://hl7.org/fhir"></Identifier>');
 316         }
 317         parent::xmlSerialize(true, $sxe);
 318         if (isset($this->use)) {
 319             $this->use->xmlSerialize(true, $sxe->addChild('use'));
 320         }
 321         if (isset($this->type)) {
 322             $this->type->xmlSerialize(true, $sxe->addChild('type'));
 323         }
 324         if (isset($this->system)) {
 325             $this->system->xmlSerialize(true, $sxe->addChild('system'));
 326         }
 327         if (isset($this->value)) {
 328             $this->value->xmlSerialize(true, $sxe->addChild('value'));
 329         }
 330         if (isset($this->period)) {
 331             $this->period->xmlSerialize(true, $sxe->addChild('period'));
 332         }
 333         if (isset($this->assigner)) {
 334             $this->assigner->xmlSerialize(true, $sxe->addChild('assigner'));
 335         }
 336         if ($returnSXE) {
 337             return $sxe;
 338         }
 339         return $sxe->saveXML();
 340     }
 341 }