src/FHIR/R4/FHIRElement/FHIRRelatedArtifact.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  * Related artifacts such as additional documentation, justification, or bibliographic references.
  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 FHIRRelatedArtifact extends FHIRElement implements \JsonSerializable
  72 {
  73     /**
  74      * The type of relationship to the related artifact.
  75      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRRelatedArtifactType
  76      */
  77     public $type = null;
  78
  79     /**
  80      * A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
  81      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
  82      */
  83     public $label = null;
  84
  85     /**
  86      * A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
  87      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRString
  88      */
  89     public $display = null;
  90
  91     /**
  92      * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
  93      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRMarkdown
  94      */
  95     public $citation = null;
  96
  97     /**
  98      * A url for the artifact that can be followed to access the actual content.
  99      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRUrl
 100      */
 101     public $url = null;
 102
 103     /**
 104      * The document being referenced, represented as an attachment. This is exclusive with the resource element.
 105      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRAttachment
 106      */
 107     public $document = null;
 108
 109     /**
 110      * The related resource, such as a library, value set, profile, or other knowledge resource.
 111      * @var \OpenEMR\FHIR\R4\FHIRElement\FHIRCanonical
 112      */
 113     public $resource = null;
 114
 115     /**
 116      * @var string
 117      */
 118     private $_fhirElementName = 'RelatedArtifact';
 119
 120     /**
 121      * The type of relationship to the related artifact.
 122      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRRelatedArtifactType
 123      */
 124     public function getType()
 125     {
 126         return $this->type;
 127     }
 128
 129     /**
 130      * The type of relationship to the related artifact.
 131      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRRelatedArtifactType $type
 132      * @return $this
 133      */
 134     public function setType($type)
 135     {
 136         $this->type = $type;
 137         return $this;
 138     }
 139
 140     /**
 141      * A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
 142      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 143      */
 144     public function getLabel()
 145     {
 146         return $this->label;
 147     }
 148
 149     /**
 150      * A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
 151      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $label
 152      * @return $this
 153      */
 154     public function setLabel($label)
 155     {
 156         $this->label = $label;
 157         return $this;
 158     }
 159
 160     /**
 161      * A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
 162      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRString
 163      */
 164     public function getDisplay()
 165     {
 166         return $this->display;
 167     }
 168
 169     /**
 170      * A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
 171      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRString $display
 172      * @return $this
 173      */
 174     public function setDisplay($display)
 175     {
 176         $this->display = $display;
 177         return $this;
 178     }
 179
 180     /**
 181      * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
 182      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRMarkdown
 183      */
 184     public function getCitation()
 185     {
 186         return $this->citation;
 187     }
 188
 189     /**
 190      * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
 191      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRMarkdown $citation
 192      * @return $this
 193      */
 194     public function setCitation($citation)
 195     {
 196         $this->citation = $citation;
 197         return $this;
 198     }
 199
 200     /**
 201      * A url for the artifact that can be followed to access the actual content.
 202      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRUrl
 203      */
 204     public function getUrl()
 205     {
 206         return $this->url;
 207     }
 208
 209     /**
 210      * A url for the artifact that can be followed to access the actual content.
 211      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRUrl $url
 212      * @return $this
 213      */
 214     public function setUrl($url)
 215     {
 216         $this->url = $url;
 217         return $this;
 218     }
 219
 220     /**
 221      * The document being referenced, represented as an attachment. This is exclusive with the resource element.
 222      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRAttachment
 223      */
 224     public function getDocument()
 225     {
 226         return $this->document;
 227     }
 228
 229     /**
 230      * The document being referenced, represented as an attachment. This is exclusive with the resource element.
 231      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRAttachment $document
 232      * @return $this
 233      */
 234     public function setDocument($document)
 235     {
 236         $this->document = $document;
 237         return $this;
 238     }
 239
 240     /**
 241      * The related resource, such as a library, value set, profile, or other knowledge resource.
 242      * @return \OpenEMR\FHIR\R4\FHIRElement\FHIRCanonical
 243      */
 244     public function getResource()
 245     {
 246         return $this->resource;
 247     }
 248
 249     /**
 250      * The related resource, such as a library, value set, profile, or other knowledge resource.
 251      * @param \OpenEMR\FHIR\R4\FHIRElement\FHIRCanonical $resource
 252      * @return $this
 253      */
 254     public function setResource($resource)
 255     {
 256         $this->resource = $resource;
 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['type'])) {
 275                 $this->setType($data['type']);
 276             }
 277             if (isset($data['label'])) {
 278                 $this->setLabel($data['label']);
 279             }
 280             if (isset($data['display'])) {
 281                 $this->setDisplay($data['display']);
 282             }
 283             if (isset($data['citation'])) {
 284                 $this->setCitation($data['citation']);
 285             }
 286             if (isset($data['url'])) {
 287                 $this->setUrl($data['url']);
 288             }
 289             if (isset($data['document'])) {
 290                 $this->setDocument($data['document']);
 291             }
 292             if (isset($data['resource'])) {
 293                 $this->setResource($data['resource']);
 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->type)) {
 316             $json['type'] = $this->type;
 317         }
 318         if (isset($this->label)) {
 319             $json['label'] = $this->label;
 320         }
 321         if (isset($this->display)) {
 322             $json['display'] = $this->display;
 323         }
 324         if (isset($this->citation)) {
 325             $json['citation'] = $this->citation;
 326         }
 327         if (isset($this->url)) {
 328             $json['url'] = $this->url;
 329         }
 330         if (isset($this->document)) {
 331             $json['document'] = $this->document;
 332         }
 333         if (isset($this->resource)) {
 334             $json['resource'] = $this->resource;
 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('<RelatedArtifact xmlns="http://hl7.org/fhir"></RelatedArtifact>');
 348         }
 349         parent::xmlSerialize(true, $sxe);
 350         if (isset($this->type)) {
 351             $this->type->xmlSerialize(true, $sxe->addChild('type'));
 352         }
 353         if (isset($this->label)) {
 354             $this->label->xmlSerialize(true, $sxe->addChild('label'));
 355         }
 356         if (isset($this->display)) {
 357             $this->display->xmlSerialize(true, $sxe->addChild('display'));
 358         }
 359         if (isset($this->citation)) {
 360             $this->citation->xmlSerialize(true, $sxe->addChild('citation'));
 361         }
 362         if (isset($this->url)) {
 363             $this->url->xmlSerialize(true, $sxe->addChild('url'));
 364         }
 365         if (isset($this->document)) {
 366             $this->document->xmlSerialize(true, $sxe->addChild('document'));
 367         }
 368         if (isset($this->resource)) {
 369             $this->resource->xmlSerialize(true, $sxe->addChild('resource'));
 370         }
 371         if ($returnSXE) {
 372             return $sxe;
 373         }
 374         return $sxe->saveXML();
 375     }
 376 }