text: # -*- coding: utf-8 -*-
  """
  Profile: http://hl7.org/fhir/StructureDefinition/Library
  Release: R5
  Version: 4.5.0
  Build ID: 0d95498
  Last updated: 2021-04-03T00:34:11.075+00:00
  """
  import typing
  from pydantic import Field
  from pydantic import root_validator
  
  from pydantic.error_wrappers import ErrorWrapper, ValidationError
  from pydantic.errors import MissingError, NoneIsNotAllowedError
  
  from . import fhirtypes
  
  
  from . import metadataresource
  
  
  class Library(metadataresource.MetadataResource):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Represents a library of quality improvement components.
      The Library resource is a general-purpose container for knowledge asset
      definitions. It can be used to describe and expose existing knowledge
      assets such as logic libraries and information model descriptions, as well
      as to describe a collection of knowledge assets.
      """
  
      resource_type = Field("Library", const=True)
  
      approvalDate: fhirtypes.Date = Field(
          None,
          alias="approvalDate",
          title="When the library was approved by publisher",
          description=(
              "The date on which the resource content was approved by the publisher. "
              "Approval happens once when the content is officially approved for "
              "usage."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      approvalDate__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_approvalDate", title="Extension field for ``approvalDate``."
      )
  
      author: typing.List[fhirtypes.ContactDetailType] = Field(
          None,
          alias="author",
          title="Who authored the content",
          description=(
              "An individiual or organization primarily involved in the creation and "
              "maintenance of the content."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      contact: typing.List[fhirtypes.ContactDetailType] = Field(
          None,
          alias="contact",
          title="Contact details for the publisher",
          description=(
              "Contact details to assist a user in finding and communicating with the"
              " publisher."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      content: typing.List[fhirtypes.AttachmentType] = Field(
          None,
          alias="content",
          title="Contents of the library, either embedded or referenced",
          description=(
              "The content of the library as an Attachment. The content may be a "
              "reference to a url, or may be directly embedded as a base-64 string. "
              "Either way, the contentType of the attachment determines how to "
              "interpret the content."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      copyright: fhirtypes.Markdown = Field(
          None,
          alias="copyright",
          title="Use and/or publishing restrictions",
          description=(
              "A copyright statement relating to the library and/or its contents. "
              "Copyright statements are generally legal restrictions on the use and "
              "publishing of the library."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      copyright__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_copyright", title="Extension field for ``copyright``."
      )
  
      dataRequirement: typing.List[fhirtypes.DataRequirementType] = Field(
          None,
          alias="dataRequirement",
          title="What data is referenced by this library",
          description=(
              "Describes a set of data that must be provided in order to be able to "
              "successfully perform the computations defined by the library."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      date: fhirtypes.DateTime = Field(
          None,
          alias="date",
          title="Date last changed",
          description=(
              "The date  (and optionally time) when the library was published. The "
              "date must change when the business version changes and it must change "
              "if the status code changes. In addition, it should change when the "
              "substantive content of the library changes."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      date__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_date", title="Extension field for ``date``."
      )
  
      description: fhirtypes.Markdown = Field(
          None,
          alias="description",
          title="Natural language description of the library",
          description=(
              "A free text natural language description of the library from a "
              "consumer's perspective."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      description__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_description", title="Extension field for ``description``."
      )
  
      editor: typing.List[fhirtypes.ContactDetailType] = Field(
          None,
          alias="editor",
          title="Who edited the content",
          description=(
              "An individual or organization primarily responsible for internal "
              "coherence of the content."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      effectivePeriod: fhirtypes.PeriodType = Field(
          None,
          alias="effectivePeriod",
          title="When the library is expected to be used",
          description=(
              "The period during which the library content was or is planned to be in"
              " active use."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      endorser: typing.List[fhirtypes.ContactDetailType] = Field(
          None,
          alias="endorser",
          title="Who endorsed the content",
          description=(
              "An individual or organization responsible for officially endorsing the"
              " content for use in some setting."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      experimental: bool = Field(
          None,
          alias="experimental",
          title="For testing purposes, not real usage",
          description=(
              "A Boolean value to indicate that this library is authored for testing "
              "purposes (or education/evaluation/marketing) and is not intended to be"
              " used for genuine usage."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      experimental__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_experimental", title="Extension field for ``experimental``."
      )
  
      identifier: typing.List[fhirtypes.IdentifierType] = Field(
          None,
          alias="identifier",
          title="Additional identifier for the library",
          description=(
              "A formal identifier that is used to identify this library when it is "
              "represented in other formats, or referenced in a specification, model,"
              " design or an instance. e.g. CMS or NQF identifiers for a measure "
              "artifact. Note that at least one identifier is required for non-"
              "experimental active artifacts."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      jurisdiction: typing.List[fhirtypes.CodeableConceptType] = Field(
          None,
          alias="jurisdiction",
          title="Intended jurisdiction for library (if applicable)",
          description=(
              "A legal or geographic region in which the library is intended to be "
              "used."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      lastReviewDate: fhirtypes.Date = Field(
          None,
          alias="lastReviewDate",
          title="When the library was last reviewed",
          description=(
              "The date on which the resource content was last reviewed. Review "
              "happens periodically after approval but does not change the original "
              "approval date."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      lastReviewDate__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_lastReviewDate", title="Extension field for ``lastReviewDate``."
      )
  
      name: fhirtypes.String = Field(
          None,
          alias="name",
          title="Name for this library (computer friendly)",
          description=(
              "A natural language name identifying the library. This name should be "
              "usable as an identifier for the module by machine processing "
              "applications such as code generation."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      name__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_name", title="Extension field for ``name``."
      )
  
      parameter: typing.List[fhirtypes.ParameterDefinitionType] = Field(
          None,
          alias="parameter",
          title="Parameters defined by the library",
          description="The parameter element defines parameters used by the library.",
          # if property is element of this resource.
          element_property=True,
      )
  
      publisher: fhirtypes.String = Field(
          None,
          alias="publisher",
          title="Name of the publisher (organization or individual)",
          description="The name of the organization or individual that published the library.",
          # if property is element of this resource.
          element_property=True,
      )
      publisher__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_publisher", title="Extension field for ``publisher``."
      )
  
      purpose: fhirtypes.Markdown = Field(
          None,
          alias="purpose",
          title="Why this library is defined",
          description=(
              "Explanation of why this library is needed and why it has been designed"
              " as it has."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      purpose__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_purpose", title="Extension field for ``purpose``."
      )
  
      relatedArtifact: typing.List[fhirtypes.RelatedArtifactType] = Field(
          None,
          alias="relatedArtifact",
          title="Additional documentation, citations, etc.",
          description=(
              "Related artifacts such as additional documentation, justification, or "
              "bibliographic references."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      reviewer: typing.List[fhirtypes.ContactDetailType] = Field(
          None,
          alias="reviewer",
          title="Who reviewed the content",
          description=(
              "An individual or organization primarily responsible for review of some"
              " aspect of the content."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      status: fhirtypes.Code = Field(
          None,
          alias="status",
          title="draft | active | retired | unknown",
          description=(
              "The status of this library. Enables tracking the life-cycle of the "
              "content."
          ),
          # if property is element of this resource.
          element_property=True,
          element_required=True,
          # note: Enum values can be used in validation,
          # but use in your own responsibilities, read official FHIR documentation.
          enum_values=["draft", "active", "retired", "unknown"],
      )
      status__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_status", title="Extension field for ``status``."
      )
  
      subjectCodeableConcept: fhirtypes.CodeableConceptType = Field(
          None,
          alias="subjectCodeableConcept",
          title="Type of individual the library content is focused on",
          description=(
              "A code or group definition that describes the intended subject of the "
              "contents of the library."
          ),
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e subject[x]
          one_of_many="subject",
          one_of_many_required=False,
      )
  
      subjectReference: fhirtypes.ReferenceType = Field(
          None,
          alias="subjectReference",
          title="Type of individual the library content is focused on",
          description=(
              "A code or group definition that describes the intended subject of the "
              "contents of the library."
          ),
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e subject[x]
          one_of_many="subject",
          one_of_many_required=False,
          # note: Listed Resource Type(s) should be allowed as Reference.
          enum_reference_types=["Group"],
      )
  
      subtitle: fhirtypes.String = Field(
          None,
          alias="subtitle",
          title="Subordinate title of the library",
          description=(
              "An explanatory or alternate title for the library giving additional "
              "information about its content."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      subtitle__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_subtitle", title="Extension field for ``subtitle``."
      )
  
      title: fhirtypes.String = Field(
          None,
          alias="title",
          title="Name for this library (human friendly)",
          description="A short, descriptive, user-friendly title for the library.",
          # if property is element of this resource.
          element_property=True,
      )
      title__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_title", title="Extension field for ``title``."
      )
  
      topic: typing.List[fhirtypes.CodeableConceptType] = Field(
          None,
          alias="topic",
          title="E.g. Education, Treatment, Assessment, etc.",
          description=(
              "Descriptive topics related to the content of the library. Topics "
              "provide a high-level categorization of the library that can be useful "
              "for filtering and searching."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      type: fhirtypes.CodeableConceptType = Field(
          ...,
          alias="type",
          title=(
              "logic-library | model-definition | asset-collection | module-" "definition"
          ),
          description=(
              "Identifies the type of library such as a Logic Library, Model "
              "Definition, Asset Collection, or Module Definition."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      url: fhirtypes.Uri = Field(
          None,
          alias="url",
          title=(
              "Canonical identifier for this library, represented as a URI (globally "
              "unique)"
          ),
          description=(
              "An absolute URI that is used to identify this library when it is "
              "referenced in a specification, model, design or an instance; also "
              "called its canonical identifier. This SHOULD be globally unique and "
              "SHOULD be a literal address at which at which an authoritative "
              "instance of this library is (or will be) published. This URL can be "
              "the target of a canonical reference. It SHALL remain the same when the"
              " library is stored on different servers."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      url__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_url", title="Extension field for ``url``."
      )
  
      usage: fhirtypes.String = Field(
          None,
          alias="usage",
          title="Describes the clinical usage of the library",
          description=(
              "A detailed description of how the library is used from a clinical "
              "perspective."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      usage__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_usage", title="Extension field for ``usage``."
      )
  
      useContext: typing.List[fhirtypes.UsageContextType] = Field(
          None,
          alias="useContext",
          title="The context that the content is intended to support",
          description=(
              "The content was developed with a focus and intent of supporting the "
              "contexts that are listed. These contexts may be general categories "
              "(gender, age, ...) or may be references to specific programs "
              "(insurance plans, studies, ...) and may be used to assist with "
              "indexing and searching for appropriate library instances."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      version: fhirtypes.String = Field(
          None,
          alias="version",
          title="Business version of the library",
          description=(
              "The identifier that is used to identify this version of the library "
              "when it is referenced in a specification, model, design or instance. "
              "This is an arbitrary value managed by the library author and is not "
              "expected to be globally unique. For example, it might be a timestamp "
              "(e.g. yyyymmdd) if a managed version is not available. There is also "
              "no expectation that versions can be placed in a lexicographical "
              "sequence. To provide a version consistent with the Decision Support "
              "Service specification, use the format Major.Minor.Revision (e.g. "
              "1.0.0). For more information on versioning knowledge assets, refer to "
              "the Decision Support Service specification. Note that a version is "
              "required for non-experimental active artifacts."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      version__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_version", title="Extension field for ``version``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``Library`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "meta",
              "implicitRules",
              "language",
              "text",
              "contained",
              "extension",
              "modifierExtension",
              "url",
              "identifier",
              "version",
              "name",
              "title",
              "status",
              "experimental",
              "date",
              "publisher",
              "contact",
              "description",
              "useContext",
              "jurisdiction",
              "purpose",
              "copyright",
              "approvalDate",
              "lastReviewDate",
              "effectivePeriod",
              "topic",
              "author",
              "editor",
              "reviewer",
              "endorser",
              "relatedArtifact",
              "url",
              "identifier",
              "version",
              "name",
              "title",
              "subtitle",
              "status",
              "experimental",
              "type",
              "subjectCodeableConcept",
              "subjectReference",
              "date",
              "publisher",
              "contact",
              "description",
              "useContext",
              "jurisdiction",
              "purpose",
              "usage",
              "copyright",
              "approvalDate",
              "lastReviewDate",
              "effectivePeriod",
              "topic",
              "author",
              "editor",
              "reviewer",
              "endorser",
              "relatedArtifact",
              "parameter",
              "dataRequirement",
              "content",
          ]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_922(
          cls, values: typing.Dict[str, typing.Any]
      ) -> typing.Dict[str, typing.Any]:
          """https://www.hl7.org/fhir/extensibility.html#Special-Case
          In some cases, implementers might find that they do not have appropriate data for
          an element with minimum cardinality = 1. In this case, the element must be present,
          but unless the resource or a profile on it has made the actual value of the primitive
          data type mandatory, it is possible to provide an extension that explains why
          the primitive value is not present.
          """
          required_fields = [("status", "status__ext")]
          _missing = object()
  
          def _fallback():
              return ""
  
          errors: typing.List["ErrorWrapper"] = []
          for name, ext in required_fields:
              field = cls.__fields__[name]
              ext_field = cls.__fields__[ext]
              value = values.get(field.alias, _missing)
              if value not in (_missing, None):
                  continue
              ext_value = values.get(ext_field.alias, _missing)
              missing_ext = True
              if ext_value not in (_missing, None):
                  if isinstance(ext_value, dict):
                      missing_ext = len(ext_value.get("extension", [])) == 0
                  elif (
                      getattr(ext_value.__class__, "get_resource_type", _fallback)()
                      == "FHIRPrimitiveExtension"
                  ):
                      if ext_value.extension and len(ext_value.extension) > 0:
                          missing_ext = False
                  else:
                      validate_pass = True
                      for validator in ext_field.type_.__get_validators__():
                          try:
                              ext_value = validator(v=ext_value)
                          except ValidationError as exc:
                              errors.append(ErrorWrapper(exc, loc=ext_field.alias))
                              validate_pass = False
                      if not validate_pass:
                          continue
                      if ext_value.extension and len(ext_value.extension) > 0:
                          missing_ext = False
              if missing_ext:
                  if value is _missing:
                      errors.append(ErrorWrapper(MissingError(), loc=field.alias))
                  else:
                      errors.append(
                          ErrorWrapper(NoneIsNotAllowedError(), loc=field.alias)
                      )
          if len(errors) > 0:
              raise ValidationError(errors, cls)  # type: ignore
  
          return values
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_one_of_many_922(
          cls, values: typing.Dict[str, typing.Any]
      ) -> typing.Dict[str, typing.Any]:
          """https://www.hl7.org/fhir/formats.html#choice
          A few elements have a choice of more than one data type for their content.
          All such elements have a name that takes the form nnn[x].
          The "nnn" part of the name is constant, and the "[x]" is replaced with
          the title-cased name of the type that is actually used.
          The table view shows each of these names explicitly.
  
          Elements that have a choice of data type cannot repeat - they must have a
          maximum cardinality of 1. When constructing an instance of an element with a
          choice of types, the authoring system must create a single element with a
          data type chosen from among the list of permitted data types.
          """
          one_of_many_fields = {"subject": ["subjectCodeableConcept", "subjectReference"]}
          for prefix, fields in one_of_many_fields.items():
              assert cls.__fields__[fields[0]].field_info.extra["one_of_many"] == prefix
              required = (
                  cls.__fields__[fields[0]].field_info.extra["one_of_many_required"]
                  is True
              )
              found = False
              for field in fields:
                  if field in values and values[field] is not None:
                      if found is True:
                          raise ValueError(
                              "Any of one field value is expected from "
                              f"this list {fields}, but got multiple!"
                          )
                      else:
                          found = True
              if required is True and found is False:
                  raise ValueError(f"Expect any of field value from this list {fields}.")
  
          return values
  