pgee70 / cda

lib/ClinicalDocument.php

<?php

/**
 * The MIT License
 *
 * Copyright 2016 Julien Fastré <julien.fastre@champs-libres.coop>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace i3Soft\CDA;

use i3Soft\CDA\DataType\Identifier\InstanceIdentifier;
use i3Soft\CDA\Elements\TypeId;
use i3Soft\CDA\Helper\ReferenceManager;
use i3Soft\CDA\Interfaces\ClassCodeInterface;
use i3Soft\CDA\Interfaces\MoodCodeInterface;
use i3Soft\CDA\Traits\AuthenticatorTrait;
use i3Soft\CDA\Traits\AuthorizationTrait;
use i3Soft\CDA\Traits\AuthorsTrait;
use i3Soft\CDA\Traits\ClassCodeTrait;
use i3Soft\CDA\Traits\CodeTrait;
use i3Soft\CDA\Traits\CompletionCodeTrait;
use i3Soft\CDA\Traits\ConfidentialityCodeTrait;
use i3Soft\CDA\Traits\CopyTimeTrait;
use i3Soft\CDA\Traits\CustodianTrait;
use i3Soft\CDA\Traits\DataEntererTrait;
use i3Soft\CDA\Traits\DocumentationOfsTrait;
use i3Soft\CDA\Traits\EffectiveTimeTrait;
use i3Soft\CDA\Traits\IdTrait;
use i3Soft\CDA\Traits\InformantsTrait;
use i3Soft\CDA\Traits\InformationRecipientsTrait;
use i3Soft\CDA\Traits\LanguageCodeTrait;
use i3Soft\CDA\Traits\LegalAuthenticatorTrait;
use i3Soft\CDA\Traits\MoodCodeTrait;
use i3Soft\CDA\Traits\ParticipantsTrait;
use i3Soft\CDA\Traits\RealmCodesTrait;
use i3Soft\CDA\Traits\RecordTargetsTrait;
use i3Soft\CDA\Traits\SetIdTrait;
use i3Soft\CDA\Traits\TemplateIdsTrait;
use i3Soft\CDA\Traits\TitleTrait;
use i3Soft\CDA\Traits\TypeIdTrait;
use i3Soft\CDA\Traits\VersionNumberTrait;

/**
 * Root class for clinical document
 *
 * @author Julien Fastré <julien.fastre@champs-libres.coop>
 * @author Peter Gee <https://github.com/pgee70>
 */
class ClinicalDocument implements ClassCodeInterface, MoodCodeInterface
{
  const NS_CDA_URI = 'urn:hl7-org:v3';
  const VERSION    = '1.0.6';

  use RealmCodesTrait;
  use TypeIdTrait;
  use TemplateIdsTrait;
  use IdTrait;
  use CodeTrait;
  use TitleTrait;
  use EffectiveTimeTrait;
  use ConfidentialityCodeTrait;
  use LanguageCodeTrait;
  use SetIdTrait;
  use VersionNumberTrait;
  use CompletionCodeTrait;
  use CopyTimeTrait;
  use RecordTargetsTrait;
  use AuthorsTrait;
  use DataEntererTrait;
  use InformantsTrait;
  use CustodianTrait;
  use InformationRecipientsTrait;
  use legalAuthenticatorTrait;
  use AuthenticatorTrait;
  use ParticipantsTrait;
  // use InFulfillmentOfsTrait;
  use DocumentationOfsTrait;
  // use RelatedDocumentsTrait;
  use AuthorizationTrait;

  // use ComponentOfTrait;
  // use ComponentTrait;
  use ClassCodeTrait;
  use MoodCodeTrait;
  /**
   * Referer assigned to this document  *
   *
   * @var ReferenceManager
   */
  private $referenceManager;
  /**
   * the root component
   *
   * @var Component\RootBodyComponent
   */
  private $rootComponent;
  private $informationRecipient;

The private property $informationRecipient is not used, and could be removed.

  private $inFulfillmentOf;

The private property $inFulfillmentOf is not used, and could be removed.

  private $documentationOf;

The private property $documentationOf is not used, and could be removed.

  private $relatedDocument;

The private property $relatedDocument is not used, and could be removed.

  /** @var string  the xmlns:ext attribute - leave empty string to not render. */
  private $attributeXmlnsExt;
  /** @var string the xmlns:xs attribute - leave as empty string to not render */
  private $attributeXmlNsXs;
  /** @var array the three parameters of the attribute Namespace */
  private $attributeNs;

  /**
   * ClinicalDocument constructor.
   */
  public function __construct ()
  {
    $this->rootComponent    = new Component\RootBodyComponent();
    $this->referenceManager = new ReferenceManager();
    $this->setTypeId(new TypeId(new InstanceIdentifier('2.16.840.1.113883.1.3', 'POCD_HD000040')))
      ->setAttributeNs(self::getNS_XSI_URI(), 'xsi:schemaLocation', 'CDA-ES-v1_3.xsd')
      ->setAttributeXmlnsExt('http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0')
      ->setAttributeXmlNsXs('http://www.w3.org/2001/XMLSchema')
      ->setAcceptableClassCodes(['', ClassCodeInterface::CLINICAL_DOCUMENT])
      ->setClassCode('')
      ->setAcceptableMoodCodes(['', MoodCodeInterface::EVENT])
      ->setMoodCode('');
  }

  public static function getNS_XSI_URI (): string { return 'http://www.w3.org/2001/XMLSchema-instance'; }

  public static function getNS (): string { return ''; }

  /**
   *
   * @return ReferenceManager
   */
  public function getReferenceManager (): ReferenceManager
  {
    return $this->referenceManager;
  }

  /**
   *
   * @param \DOMDocument|null $doc
   *
   * @return \DOMDocument
   */
  public function toDOMDocument (\DOMDocument $doc = NULL): \DOMDocument
  {
    $doc = $doc ?? new \DOMDocument('1.0', 'UTF-8');
    $el  = $doc->createElementNS(self::NS_CDA_URI, 'ClinicalDocument');
    $doc->appendChild($el);
    // set the NS
    if (implode('', $this->getAttributeNs()))
    {
      $el->setAttributeNS(
        $this->getAttributeNs()[0],
        $this->getAttributeNs()[1],
        $this->getAttributeNs()[2]
      );
    }
    if ($xmlNsExt = $this->getAttributeXmlnsExt())
    {
      $el->setAttribute('xmlns:ext', $xmlNsExt);
    }
    if ($xmlNsXs = $this->getAttributeXmlNsXs())
    {
      $el->setAttribute('xmlns:xs', $xmlNsXs);
    }
    if ($this->hasClassCode())
    {
      $el->setAttribute('classCode', $this->getClassCode());
    }
    if ($this->hasMoodCode())
    {
      $el->setAttribute('moodCode', $this->getMoodCode());
    }
    $this->renderRealmCodes($el, $doc)
      ->renderTypeId($el, $doc)
      ->renderTemplateIds($el, $doc)
      ->renderId($el, $doc)
      ->renderCode($el, $doc)
      ->renderTitle($el, $doc)
      ->renderEffectiveTime($el, $doc)
      ->renderConfidentialityCode($el, $doc)
      ->renderLanguageCode($el, $doc)
      ->renderSetId($el, $doc)
      ->renderVersionNumber($el, $doc)
      ->renderCopyTime($el, $doc)
      ->renderCompletionCode($el, $doc)
      ->renderRecordTargets($el, $doc)
      ->renderAuthors($el, $doc)
      ->renderDataEnter($el, $doc)
      ->renderInformants($el, $doc)
      ->renderCustodian($el, $doc)
      ->renderInformationRecipients($el, $doc)
      ->renderLegalAuthenticator($el, $doc)
      ->renderAuthenticator($el, $doc)
      ->renderParticipants($el, $doc)
      // todo inFulfillmentOf
      ->renderDocumentationOfs($el, $doc)
      // todo relatedDocument
      ->renderAuthorization($el, $doc);
    // todo componentOf
    // add components
    if (FALSE === $this->getRootComponent()->isEmpty())
    {
      $el->appendChild($this->getRootComponent()->toDOMElement($doc));
    }
    return $doc;
  }

  /**
   * @return array
   */
  public function getAttributeNs (): array
  {
    return $this->attributeNs;
  }

  /**
   * @param string $namespaceUri
   * @param string $qualifiedName
   * @param string $value
   *
   * @return ClinicalDocument
   */
  public function setAttributeNs (string $namespaceUri, string $qualifiedName, string $value): self
  {
    $this->attributeNs = [$namespaceUri, $qualifiedName, $value];
    return $this;
  }

  /**
   * @return string
   */
  public function getAttributeXmlnsExt (): string
  {
    return $this->attributeXmlnsExt;
  }

  /**
   * @param string $attributeXmlnsExt
   *
   * @return self
   */
  public function setAttributeXmlnsExt (string $attributeXmlnsExt): self
  {
    $this->attributeXmlnsExt = $attributeXmlnsExt;
    return $this;
  }

  /**
   * @return string
   */
  public function getAttributeXmlNsXs (): string
  {
    return $this->attributeXmlNsXs;
  }

  /**
   * @param string $attributeXmlNsXs
   *
   * @return self
   */
  public function setAttributeXmlNsXs (string $attributeXmlNsXs): self
  {
    $this->attributeXmlNsXs = $attributeXmlNsXs;
    return $this;
  }

  /**
   *
   * @return Component\RootBodyComponent
   */
  public function getRootComponent (): Component\RootBodyComponent
  {
    return $this->rootComponent;
  }
}