text: # -*- coding: utf-8 -*-
  """
  Profile: http://hl7.org/fhir/StructureDefinition/ValueSet
  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 canonicalresource
  
  
  class ValueSet(canonicalresource.CanonicalResource):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      A set of codes drawn from one or more code systems.
      A ValueSet resource instance specifies a set of codes drawn from one or
      more code systems, intended for use in a particular context. Value sets
      link between [CodeSystem](codesystem.html) definitions and their use in
      [coded elements](terminologies.html).
      """
  
      resource_type = Field("ValueSet", const=True)
  
      compose: fhirtypes.ValueSetComposeType = Field(
          None,
          alias="compose",
          title="Content logical definition of the value set (CLD)",
          description=(
              "A set of criteria that define the contents of the value set by "
              "including or excluding codes selected from the specified code "
              "system(s) that the value set draws from. This is also known as the "
              "Content Logical Definition (CLD)."
          ),
          # 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,
      )
  
      copyright: fhirtypes.Markdown = Field(
          None,
          alias="copyright",
          title="Use and/or publishing restrictions",
          description=(
              "A copyright statement relating to the value set and/or its contents. "
              "Copyright statements are generally legal restrictions on the use and "
              "publishing of the value set."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      copyright__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_copyright", title="Extension field for ``copyright``."
      )
  
      date: fhirtypes.DateTime = Field(
          None,
          alias="date",
          title="Date last changed",
          description=(
              "The date (and optionally time) when the value set was created or "
              "revised (e.g. the 'content logical definition')."
          ),
          # 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 value set",
          description=(
              "A free text natural language description of the value set from a "
              "consumer's perspective. The textual description specifies the span of "
              "meanings for concepts to be included within the Value Set Expansion, "
              "and also may specify the intended use and limitations of the Value "
              "Set."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      description__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_description", title="Extension field for ``description``."
      )
  
      expansion: fhirtypes.ValueSetExpansionType = Field(
          None,
          alias="expansion",
          title='Used when the value set is "expanded"',
          description=(
              'A value set can also be "expanded", where the value set is turned into'
              " a simple collection of enumerated codes. This element holds the "
              "expansion, if it has been performed."
          ),
          # 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 value set 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 value set (business identifier)",
          description=(
              "A formal identifier that is used to identify this value set when it is"
              " represented in other formats, or referenced in a specification, "
              "model, design or an instance."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      immutable: bool = Field(
          None,
          alias="immutable",
          title=(
              "Indicates whether or not any change to the content logical definition "
              "may occur"
          ),
          description=(
              "If this is set to 'true', then no new versions of the content logical "
              "definition can be created.  Note: Other metadata might still change."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      immutable__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_immutable", title="Extension field for ``immutable``."
      )
  
      jurisdiction: typing.List[fhirtypes.CodeableConceptType] = Field(
          None,
          alias="jurisdiction",
          title="Intended jurisdiction for value set (if applicable)",
          description=(
              "A legal or geographic region in which the value set is intended to be "
              "used."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      name: fhirtypes.String = Field(
          None,
          alias="name",
          title="Name for this value set (computer friendly)",
          description=(
              "A natural language name identifying the value set. 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``."
      )
  
      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 value "
              "set."
          ),
          # 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 value set is defined",
          description=(
              "Explanation of why this value set 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``."
      )
  
      scope: fhirtypes.ValueSetScopeType = Field(
          None,
          alias="scope",
          title=(
              "Description of the semantic space the Value Set Expansion is intended "
              "to cover"
          ),
          description=None,
          # 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 value set. Enables tracking the life-cycle of the "
              "content. The status of the value set applies to the value set "
              "definition (ValueSet.compose) and the associated ValueSet metadata. "
              "Expansions do not have a state."
          ),
          # 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``."
      )
  
      title: fhirtypes.String = Field(
          None,
          alias="title",
          title="Name for this value set (human friendly)",
          description="A short, descriptive, user-friendly title for the value set.",
          # if property is element of this resource.
          element_property=True,
      )
      title__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_title", title="Extension field for ``title``."
      )
  
      url: fhirtypes.Uri = Field(
          None,
          alias="url",
          title=(
              "Canonical identifier for this value set, represented as a URI "
              "(globally unique)"
          ),
          description=(
              "An absolute URI that is used to identify this value set 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 an authoritative instance of this"
              " value set is (or will be) published. This URL can be the target of a "
              "canonical reference. It SHALL remain the same when the value set 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``."
      )
  
      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 value set instances."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      version: fhirtypes.String = Field(
          None,
          alias="version",
          title="Business version of the value set",
          description=(
              "The identifier that is used to identify this version of the value set "
              "when it is referenced in a specification, model, design or instance. "
              "This is an arbitrary value managed by the value set 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."
          ),
          # 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 ``ValueSet`` 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",
              "url",
              "identifier",
              "version",
              "name",
              "title",
              "status",
              "experimental",
              "date",
              "publisher",
              "contact",
              "description",
              "useContext",
              "jurisdiction",
              "immutable",
              "purpose",
              "copyright",
              "compose",
              "expansion",
              "scope",
          ]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_1011(
          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
  
  
  from . import backboneelement
  
  
  class ValueSetCompose(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Content logical definition of the value set (CLD).
      A set of criteria that define the contents of the value set by including or
      excluding codes selected from the specified code system(s) that the value
      set draws from. This is also known as the Content Logical Definition (CLD).
      """
  
      resource_type = Field("ValueSetCompose", const=True)
  
      exclude: typing.List[fhirtypes.ValueSetComposeIncludeType] = Field(
          None,
          alias="exclude",
          title="Explicitly exclude codes from a code system or other value sets",
          description=(
              "Exclude one or more codes from the value set based on code system "
              "filters and/or other value sets."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      inactive: bool = Field(
          None,
          alias="inactive",
          title="Whether inactive codes are in the value set",
          description=(
              "Whether inactive codes - codes that are not approved for current use -"
              " are in the value set. If inactive = true, inactive codes are to be "
              "included in the expansion, if inactive = false, the inactive codes "
              "will not be included in the expansion. If absent, the behavior is "
              "determined by the implementation, or by the applicable $expand "
              "parameters (but generally, inactive codes would be expected to be "
              "included)."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      inactive__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_inactive", title="Extension field for ``inactive``."
      )
  
      include: typing.List[fhirtypes.ValueSetComposeIncludeType] = Field(
          ...,
          alias="include",
          title="Include one or more codes from a code system or other value set(s)",
          description=None,
          # if property is element of this resource.
          element_property=True,
      )
  
      lockedDate: fhirtypes.Date = Field(
          None,
          alias="lockedDate",
          title="Fixed date for references with no specified version (transitive)",
          description=(
              "The Locked Date is  the effective date that is used to determine the "
              "version of all referenced Code Systems and Value Set Definitions "
              "included in the compose that are not already tied to a specific "
              "version."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      lockedDate__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_lockedDate", title="Extension field for ``lockedDate``."
      )
  
      property: typing.List[fhirtypes.String] = Field(
          None,
          alias="property",
          title="Property to return if client doesn't override",
          description=(
              "A property to return in the expansion, if the client doesn't ask for "
              "any particular properties. May be either a code from the code system "
              "definition (convenient) or a the formal URI that refers to the "
              "property. The special value '*' means all properties known to the "
              "server."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      property__ext: typing.List[
          typing.Union[fhirtypes.FHIRPrimitiveExtensionType, None]
      ] = Field(None, alias="_property", title="Extension field for ``property``.")
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetCompose`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "lockedDate",
              "inactive",
              "include",
              "exclude",
              "property",
          ]
  
  
  class ValueSetComposeInclude(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Include one or more codes from a code system or other value set(s).
      """
  
      resource_type = Field("ValueSetComposeInclude", const=True)
  
      concept: typing.List[fhirtypes.ValueSetComposeIncludeConceptType] = Field(
          None,
          alias="concept",
          title="A concept defined in the system",
          description="Specifies a concept to be included or excluded.",
          # if property is element of this resource.
          element_property=True,
      )
  
      copyright: fhirtypes.String = Field(
          None,
          alias="copyright",
          title=(
              "A copyright statement for the specific code system included in the "
              "value set"
          ),
          description=(
              "A copyright statement for the specific code system asserted by the "
              "containing ValueSet.compose.include element's system value (if the "
              "associated ValueSet.compose.include.version element is not present); "
              "or the code system and version combination (if the associated "
              "ValueSet.compose.include.version element is present)."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      copyright__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_copyright", title="Extension field for ``copyright``."
      )
  
      filter: typing.List[fhirtypes.ValueSetComposeIncludeFilterType] = Field(
          None,
          alias="filter",
          title="Select codes/concepts by their properties (including relationships)",
          description=(
              "Select concepts by specify a matching criterion based on the "
              "properties (including relationships) defined by the system, or on "
              "filters defined by the system. If multiple filters are specified, they"
              " SHALL all be true."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      system: fhirtypes.Uri = Field(
          None,
          alias="system",
          title="The system the codes come from",
          description=(
              "An absolute URI which is the code system from which the selected codes"
              " come from."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      system__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_system", title="Extension field for ``system``."
      )
  
      valueSet: typing.List[fhirtypes.Canonical] = Field(
          None,
          alias="valueSet",
          title="Select the contents included in this value set",
          description=(
              "Selects the concepts found in this value set (based on its value set "
              "definition). This is an absolute URI that is a reference to "
              "ValueSet.url.  If multiple value sets are specified this includes the "
              "intersection of the contents of all of the referenced value sets."
          ),
          # if property is element of this resource.
          element_property=True,
          # note: Listed Resource Type(s) should be allowed as Reference.
          enum_reference_types=["ValueSet"],
      )
      valueSet__ext: typing.List[
          typing.Union[fhirtypes.FHIRPrimitiveExtensionType, None]
      ] = Field(None, alias="_valueSet", title="Extension field for ``valueSet``.")
  
      version: fhirtypes.String = Field(
          None,
          alias="version",
          title="Specific version of the code system referred to",
          description=(
              "The version of the code system that the codes are selected from, or "
              "the special version '*' for all versions."
          ),
          # 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 ``ValueSetComposeInclude`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "system",
              "version",
              "concept",
              "filter",
              "valueSet",
              "copyright",
          ]
  
  
  class ValueSetComposeIncludeConcept(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      A concept defined in the system.
      Specifies a concept to be included or excluded.
      """
  
      resource_type = Field("ValueSetComposeIncludeConcept", const=True)
  
      code: fhirtypes.Code = Field(
          None,
          alias="code",
          title="Code or expression from system",
          description="Specifies a code for the concept to be included or excluded.",
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      code__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_code", title="Extension field for ``code``."
      )
  
      designation: typing.List[
          fhirtypes.ValueSetComposeIncludeConceptDesignationType
      ] = Field(
          None,
          alias="designation",
          title="Additional representations for this concept",
          description=(
              "Additional representations for this concept when used in this value "
              "set - other languages, aliases, specialized purposes, used for "
              "particular purposes, etc."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      display: fhirtypes.String = Field(
          None,
          alias="display",
          title="Text to display for this code for this value set in this valueset",
          description=(
              "The text to display to the user for this concept in the context of "
              "this valueset. If no display is provided, then applications using the "
              "value set use the display specified for the code by the system."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      display__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_display", title="Extension field for ``display``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetComposeIncludeConcept`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "code",
              "display",
              "designation",
          ]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_3161(
          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 = [("code", "code__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
  
  
  class ValueSetComposeIncludeConceptDesignation(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Additional representations for this concept.
      Additional representations for this concept when used in this value set -
      other languages, aliases, specialized purposes, used for particular
      purposes, etc.
      """
  
      resource_type = Field("ValueSetComposeIncludeConceptDesignation", const=True)
  
      language: fhirtypes.Code = Field(
          None,
          alias="language",
          title="Human language of the designation",
          description="The language this designation is defined for.",
          # if property is element of this resource.
          element_property=True,
      )
      language__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_language", title="Extension field for ``language``."
      )
  
      use: fhirtypes.CodingType = Field(
          None,
          alias="use",
          title="Types of uses of designations",
          description="A code that represents types of uses of designations.",
          # if property is element of this resource.
          element_property=True,
      )
  
      value: fhirtypes.String = Field(
          None,
          alias="value",
          title="The text value for this designation",
          description=None,
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      value__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_value", title="Extension field for ``value``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetComposeIncludeConceptDesignation`` according specification,
          with preserving original sequence order.
          """
          return ["id", "extension", "modifierExtension", "language", "use", "value"]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_4296(
          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 = [("value", "value__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
  
  
  class ValueSetComposeIncludeFilter(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Select codes/concepts by their properties (including relationships).
      Select concepts by specify a matching criterion based on the properties
      (including relationships) defined by the system, or on filters defined by
      the system. If multiple filters are specified, they SHALL all be true.
      """
  
      resource_type = Field("ValueSetComposeIncludeFilter", const=True)
  
      op: fhirtypes.Code = Field(
          None,
          alias="op",
          title=(
              "= | is-a | descendent-of | is-not-a | regex | in | not-in | "
              "generalizes | child-of | descendent-leaf | exists"
          ),
          description="The kind of operation to perform as a part of the filter criteria.",
          # 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=[
              "=",
              "is-a",
              "descendent-of",
              "is-not-a",
              "regex",
              "in",
              "not-in",
              "generalizes",
              "child-of",
              "descendent-leaf",
              "exists",
          ],
      )
      op__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_op", title="Extension field for ``op``."
      )
  
      property: fhirtypes.Code = Field(
          None,
          alias="property",
          title="A property/filter defined by the code system",
          description=(
              "A code that identifies a property or a filter defined in the code "
              "system."
          ),
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      property__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_property", title="Extension field for ``property``."
      )
  
      value: fhirtypes.String = Field(
          None,
          alias="value",
          title="Code from the system, or regex criteria, or boolean value for exists",
          description=(
              "The match value may be either a code defined by the system, or a "
              "string value, which is a regex match on the literal string of the "
              "property value  (if the filter represents a property defined in "
              "CodeSystem) or of the system filter value (if the filter represents a "
              "filter defined in CodeSystem) when the operation is 'regex', or one of"
              " the values (true and false), when the operation is 'exists'."
          ),
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      value__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_value", title="Extension field for ``value``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetComposeIncludeFilter`` according specification,
          with preserving original sequence order.
          """
          return ["id", "extension", "modifierExtension", "property", "op", "value"]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_3057(
          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 = [
              ("op", "op__ext"),
              ("property", "property__ext"),
              ("value", "value__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
  
  
  class ValueSetExpansion(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Used when the value set is "expanded".
      A value set can also be "expanded", where the value set is turned into a
      simple collection of enumerated codes. This element holds the expansion, if
      it has been performed.
      """
  
      resource_type = Field("ValueSetExpansion", const=True)
  
      contains: typing.List[fhirtypes.ValueSetExpansionContainsType] = Field(
          None,
          alias="contains",
          title="Codes in the value set",
          description="The codes that are contained in the value set expansion.",
          # if property is element of this resource.
          element_property=True,
      )
  
      identifier: fhirtypes.Uri = Field(
          None,
          alias="identifier",
          title="Identifies the value set expansion (business identifier)",
          description=(
              "An identifier that uniquely identifies this expansion of the valueset,"
              " based on a unique combination of the provided parameters, the system "
              "default parameters, and the underlying system code system versions "
              "etc. Systems may re-use the same identifier as long as those factors "
              "remain the same, and the expansion is the same, but are not required "
              "to do so. This is a business identifier."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      identifier__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_identifier", title="Extension field for ``identifier``."
      )
  
      offset: fhirtypes.Integer = Field(
          None,
          alias="offset",
          title="Offset at which this resource starts",
          description=(
              "If paging is being used, the offset at which this resource starts.  "
              "I.e. this resource is a partial view into the expansion. If paging is "
              "not being used, this element SHALL NOT be present."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      offset__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_offset", title="Extension field for ``offset``."
      )
  
      parameter: typing.List[fhirtypes.ValueSetExpansionParameterType] = Field(
          None,
          alias="parameter",
          title="Parameter that controlled the expansion process",
          description=(
              "A parameter that controlled the expansion process. These parameters "
              "may be used by users of expanded value sets to check whether the "
              "expansion is suitable for a particular purpose, or to pick the correct"
              " expansion."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      property: typing.List[fhirtypes.ValueSetExpansionPropertyType] = Field(
          None,
          alias="property",
          title="Additional information supplied about each concept",
          description=(
              "A property defines an additional slot through which additional "
              "information can be provided about a concept."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      timestamp: fhirtypes.DateTime = Field(
          None,
          alias="timestamp",
          title="Time ValueSet expansion happened",
          description="The time at which the expansion was produced by the expanding system.",
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      timestamp__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_timestamp", title="Extension field for ``timestamp``."
      )
  
      total: fhirtypes.Integer = Field(
          None,
          alias="total",
          title="Total number of codes in the expansion",
          description=(
              "The total number of concepts in the expansion. If the number of "
              "concept nodes in this resource is less than the stated number, then "
              "the server can return more using the offset parameter."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      total__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_total", title="Extension field for ``total``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetExpansion`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "identifier",
              "timestamp",
              "total",
              "offset",
              "parameter",
              "property",
              "contains",
          ]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_1954(
          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 = [("timestamp", "timestamp__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
  
  
  class ValueSetExpansionContains(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Codes in the value set.
      The codes that are contained in the value set expansion.
      """
  
      resource_type = Field("ValueSetExpansionContains", const=True)
  
      abstract: bool = Field(
          None,
          alias="abstract",
          title="If user cannot select this entry",
          description=(
              "If true, this entry is included in the expansion for navigational "
              "purposes, and the user cannot select the code directly as a proper "
              "value."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      abstract__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_abstract", title="Extension field for ``abstract``."
      )
  
      code: fhirtypes.Code = Field(
          None,
          alias="code",
          title="Code - if blank, this is not a selectable code",
          description=(
              "The code for this item in the expansion hierarchy. If this code is "
              "missing the entry in the hierarchy is a place holder (abstract) and "
              "does not represent a valid code in the value set."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      code__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_code", title="Extension field for ``code``."
      )
  
      contains: typing.List[fhirtypes.ValueSetExpansionContainsType] = Field(
          None,
          alias="contains",
          title="Codes contained under this entry",
          description="Other codes and entries contained under this entry in the hierarchy.",
          # if property is element of this resource.
          element_property=True,
      )
  
      designation: typing.List[
          fhirtypes.ValueSetComposeIncludeConceptDesignationType
      ] = Field(
          None,
          alias="designation",
          title="Additional representations for this item",
          description=(
              "Additional representations for this item - other languages, aliases, "
              "specialized purposes, used for particular purposes, etc. These are "
              "relevant when the conditions of the expansion do not fix to a single "
              "correct representation."
          ),
          # if property is element of this resource.
          element_property=True,
      )
  
      display: fhirtypes.String = Field(
          None,
          alias="display",
          title="User display for the concept",
          description="The recommended display for this item in the expansion.",
          # if property is element of this resource.
          element_property=True,
      )
      display__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_display", title="Extension field for ``display``."
      )
  
      inactive: bool = Field(
          None,
          alias="inactive",
          title="If concept is inactive in the code system",
          description=(
              "If the concept is inactive in the code system that defines it. "
              "Inactive codes are those that are no longer to be used, but are "
              "maintained by the code system for understanding legacy data. It might "
              "not be known or specified whether an concept is inactive (and it may "
              "depend on the context of use)."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      inactive__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_inactive", title="Extension field for ``inactive``."
      )
  
      property: typing.List[fhirtypes.ValueSetExpansionContainsPropertyType] = Field(
          None,
          alias="property",
          title="Property value for the concept",
          description="A property value for this concept.",
          # if property is element of this resource.
          element_property=True,
      )
  
      system: fhirtypes.Uri = Field(
          None,
          alias="system",
          title="System value for the code",
          description=(
              "An absolute URI which is the code system in which the code for this "
              "item in the expansion is defined."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      system__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_system", title="Extension field for ``system``."
      )
  
      version: fhirtypes.String = Field(
          None,
          alias="version",
          title="Version in which this code/display is defined",
          description=(
              "The version of the code system from this code was taken. 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."
          ),
          # 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 ``ValueSetExpansionContains`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "system",
              "abstract",
              "inactive",
              "version",
              "code",
              "display",
              "designation",
              "property",
              "contains",
          ]
  
  
  class ValueSetExpansionContainsProperty(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Property value for the concept.
      A property value for this concept.
      """
  
      resource_type = Field("ValueSetExpansionContainsProperty", const=True)
  
      code: fhirtypes.Code = Field(
          None,
          alias="code",
          title="Reference to ValueSet.expansion.property.code",
          description="A code that is a reference to ValueSet.expansion.property.code.",
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      code__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_code", title="Extension field for ``code``."
      )
  
      valueBoolean: bool = Field(
          None,
          alias="valueBoolean",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
      valueBoolean__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueBoolean", title="Extension field for ``valueBoolean``."
      )
  
      valueCode: fhirtypes.Code = Field(
          None,
          alias="valueCode",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
      valueCode__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueCode", title="Extension field for ``valueCode``."
      )
  
      valueCoding: fhirtypes.CodingType = Field(
          None,
          alias="valueCoding",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
  
      valueDateTime: fhirtypes.DateTime = Field(
          None,
          alias="valueDateTime",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
      valueDateTime__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueDateTime", title="Extension field for ``valueDateTime``."
      )
  
      valueDecimal: fhirtypes.Decimal = Field(
          None,
          alias="valueDecimal",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
      valueDecimal__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueDecimal", title="Extension field for ``valueDecimal``."
      )
  
      valueInteger: fhirtypes.Integer = Field(
          None,
          alias="valueInteger",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
      valueInteger__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueInteger", title="Extension field for ``valueInteger``."
      )
  
      valueString: fhirtypes.String = Field(
          None,
          alias="valueString",
          title="Value of the property for this concept",
          description="The value of this property.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=True,
      )
      valueString__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueString", title="Extension field for ``valueString``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetExpansionContainsProperty`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "code",
              "valueCode",
              "valueCoding",
              "valueString",
              "valueInteger",
              "valueBoolean",
              "valueDateTime",
              "valueDecimal",
          ]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_3665(
          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 = [("code", "code__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_3665(
          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 = {
              "value": [
                  "valueBoolean",
                  "valueCode",
                  "valueCoding",
                  "valueDateTime",
                  "valueDecimal",
                  "valueInteger",
                  "valueString",
              ]
          }
          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
  
  
  class ValueSetExpansionParameter(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Parameter that controlled the expansion process.
      A parameter that controlled the expansion process. These parameters may be
      used by users of expanded value sets to check whether the expansion is
      suitable for a particular purpose, or to pick the correct expansion.
      """
  
      resource_type = Field("ValueSetExpansionParameter", const=True)
  
      name: fhirtypes.String = Field(
          None,
          alias="name",
          title="Name as assigned by the client or server",
          description=(
              "Name of the input parameter to the $expand operation; may be a server-"
              "assigned name for additional default or other server-supplied "
              "parameters used to control the expansion process."
          ),
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      name__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_name", title="Extension field for ``name``."
      )
  
      valueBoolean: bool = Field(
          None,
          alias="valueBoolean",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueBoolean__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueBoolean", title="Extension field for ``valueBoolean``."
      )
  
      valueCode: fhirtypes.Code = Field(
          None,
          alias="valueCode",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueCode__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueCode", title="Extension field for ``valueCode``."
      )
  
      valueDateTime: fhirtypes.DateTime = Field(
          None,
          alias="valueDateTime",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueDateTime__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueDateTime", title="Extension field for ``valueDateTime``."
      )
  
      valueDecimal: fhirtypes.Decimal = Field(
          None,
          alias="valueDecimal",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueDecimal__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueDecimal", title="Extension field for ``valueDecimal``."
      )
  
      valueInteger: fhirtypes.Integer = Field(
          None,
          alias="valueInteger",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueInteger__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueInteger", title="Extension field for ``valueInteger``."
      )
  
      valueString: fhirtypes.String = Field(
          None,
          alias="valueString",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueString__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueString", title="Extension field for ``valueString``."
      )
  
      valueUri: fhirtypes.Uri = Field(
          None,
          alias="valueUri",
          title="Value of the named parameter",
          description="The value of the parameter.",
          # if property is element of this resource.
          element_property=True,
          # Choice of Data Types. i.e value[x]
          one_of_many="value",
          one_of_many_required=False,
      )
      valueUri__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_valueUri", title="Extension field for ``valueUri``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetExpansionParameter`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "name",
              "valueString",
              "valueBoolean",
              "valueInteger",
              "valueDecimal",
              "valueUri",
              "valueCode",
              "valueDateTime",
          ]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_2887(
          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 = [("name", "name__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_2887(
          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 = {
              "value": [
                  "valueBoolean",
                  "valueCode",
                  "valueDateTime",
                  "valueDecimal",
                  "valueInteger",
                  "valueString",
                  "valueUri",
              ]
          }
          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
  
  
  class ValueSetExpansionProperty(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Additional information supplied about each concept.
      A property defines an additional slot through which additional information
      can be provided about a concept.
      """
  
      resource_type = Field("ValueSetExpansionProperty", const=True)
  
      code: fhirtypes.Code = Field(
          None,
          alias="code",
          title=(
              "Identifies the property on the concepts, and when referred to in "
              "operations"
          ),
          description=(
              "A code that is used to identify the property. The code is used in "
              "ValueSet.expansion.contains.property.code."
          ),
          # if property is element of this resource.
          element_property=True,
          element_required=True,
      )
      code__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_code", title="Extension field for ``code``."
      )
  
      uri: fhirtypes.Uri = Field(
          None,
          alias="uri",
          title="Formal identifier for the property",
          description=(
              "Reference to the formal meaning of the property. One possible source "
              "of meaning is the [Concept Properties](codesystem-concept-"
              "properties.html) code system."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      uri__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_uri", title="Extension field for ``uri``."
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetExpansionProperty`` according specification,
          with preserving original sequence order.
          """
          return ["id", "extension", "modifierExtension", "code", "uri"]
  
      @root_validator(pre=True, allow_reuse=True)
      def validate_required_primitive_elements_2834(
          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 = [("code", "code__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
  
  
  class ValueSetScope(backboneelement.BackboneElement):
      """Disclaimer: Any field name ends with ``__ext`` doesn't part of
      Resource StructureDefinition, instead used to enable Extensibility feature
      for FHIR Primitive Data Types.
  
      Description of the semantic space the Value Set Expansion is intended to
      cover.
      """
  
      resource_type = Field("ValueSetScope", const=True)
  
      exclusionCriteria: fhirtypes.String = Field(
          None,
          alias="exclusionCriteria",
          title="Criteria describing which concepts or codes should be excluded and why",
          description=None,
          # if property is element of this resource.
          element_property=True,
      )
      exclusionCriteria__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None,
          alias="_exclusionCriteria",
          title="Extension field for ``exclusionCriteria``.",
      )
  
      focus: fhirtypes.String = Field(
          None,
          alias="focus",
          title=(
              "General focus of the Value Set as it relates to the intended semantic "
              "space"
          ),
          description=(
              "The general focus of the Value Set as it relates to the intended "
              "semantic space. This can be the information about clinical relevancy "
              "or the statement about the general focus of the Value Set, such as a "
              "description of types of messages, payment options, geographic "
              "locations, etc."
          ),
          # if property is element of this resource.
          element_property=True,
      )
      focus__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None, alias="_focus", title="Extension field for ``focus``."
      )
  
      inclusionCriteria: fhirtypes.String = Field(
          None,
          alias="inclusionCriteria",
          title="Criteria describing which concepts or codes should be included and why",
          description=None,
          # if property is element of this resource.
          element_property=True,
      )
      inclusionCriteria__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
          None,
          alias="_inclusionCriteria",
          title="Extension field for ``inclusionCriteria``.",
      )
  
      @classmethod
      def elements_sequence(cls):
          """returning all elements names from ``ValueSetScope`` according specification,
          with preserving original sequence order.
          """
          return [
              "id",
              "extension",
              "modifierExtension",
              "focus",
              "inclusionCriteria",
              "exclusionCriteria",
          ]
  