Estonian Terminology Services Implementation Guide
1.0.0 - draft Estonia flag

Estonian Terminology Services Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/TerminologyServices/ and changes regularly. See the Directory of published versions

Resource Profile: TehikValueSet - Detailed Descriptions

Draft as of 2024-10-06

Definitions for the tehikvalueset resource profile.

Guidance on how to interpret the contents of this table can be found here

0. ValueSet
2. ValueSet.contained
ShortA value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
4. ValueSet.extension
ShortDescription of change management: periodicity, change request workflow, release dates, responsibilities, etc
6. ValueSet.extension:otherTitle
Slice NameotherTitle
Control0..*
TypeExtension(ValueSet Other Title) (Complex Extension)
8. ValueSet.extension:changeManagementDescription
Slice NamechangeManagementDescription
Control0..1
TypeExtension(GuidanceMaterial) (Extension Type: markdown)
10. ValueSet.url
Definition

Follows the pattern 'https://fhir.ee/ValueSet/[Resource Id]'

Shortthis is the default formula for uri
12. ValueSet.identifier
ShortA non-FHIR identifier for the value set (e.g ISO OID)
NoteThis is a business identifier, not a resource identifier (see discussion)
SlicingThis element introduces a set of slices on ValueSet.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • pattern @ system
  • 14. ValueSet.identifier:oid
    Slice Nameoid
    Definition

    Follows the pattern: urn:oid:1.2.3.

    ShortISO OID identifier represented as URN
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    16. ValueSet.identifier:oid.system
    Control1..?
    Pattern Valueurn:ietf:rfc:3986
    18. ValueSet.name
    Definition

    Follows the pattern: ...

    ShortComputer-friendly name/identifier to be used for machine-processing
    Control1..?
    20. ValueSet.title
    Definition

    Follows the pattern: ...

    ShortName of the value set, a human-readable well understood name. English name can be provided in the translation element.
    22. ValueSet.experimental
    Comments

    In production terminology server, experimental value sets should not exist, and therefore the default value should be 'false'

    24. ValueSet.publisher
    ShortThe original maintainer/publisher of the value set.
    Control1..?
    26. ValueSet.contact
    Control1..?
    28. ValueSet.description
    ShortShort description of the value set
    30. ValueSet.useContext
    ShortUsage context: health, social care, work
    32. ValueSet.useContext.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on ValueSet.useContext.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 34. ValueSet.useContext.value[x]:valueCodeableConcept
      Slice NamevalueCodeableConcept
      Control1..1
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      36. ValueSet.jurisdiction
      Control0..0
      38. ValueSet.purpose
      ShortOverview of the purpose, content, and usage of the value set
      40. ValueSet.topic
      Control0..0
      42. ValueSet.author
      ShortOwner of the value set. Organisation/group who is responsible for the content of the value set.
      Control0..1
      44. ValueSet.author.name
      ShortName of the organisation/group.
      Control1..?
      46. ValueSet.compose
      48. ValueSet.compose.property
      Comments

      For locally defined code systems, all properties should be in default expansion. This means '*' in the definition.

      Guidance on how to interpret the contents of this table can be found here

      0. ValueSet
      Definition

      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 definitions and their use in coded elements.

      ShortA set of codes drawn from one or more code systems
      Control10..1*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
      2. ValueSet.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      4. ValueSet.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

      ShortA value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.Contained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

      Control0..*
      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
      TypeResource
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      6. ValueSet.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortDescription of change management: periodicity, change request workflow, release dates, responsibilities, etcAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on ValueSet.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 8. ValueSet.extension:knowledgeRepresentationLevel
        Slice NameknowledgeRepresentationLevel
        Definition

        Defines a knowledge representation level provided by this knowledge artifact.

        Shortnarrative | semi-structured | structured | executable
        Control0..*
        TypeExtension(CQF knowledge representation level) (Extension Type: code)
        Is Modifierfalse
        Must Supporttrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        10. ValueSet.extension:authoritativeSource
        Slice NameauthoritativeSource
        Definition

        A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions.

        ShortReference to the current trusted source of the ValueSet resource (metadata and definition)
        Comments

        If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.

        Control0..1
        TypeExtension(ValueSet Authoritative Source) (Extension Type: uri)
        Is Modifierfalse
        Must Supporttrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        12. ValueSet.extension:otherTitle
        Slice NameotherTitle
        Definition

        Human readable titles for the valueset.

        ShortAlternative titles
        Control0..*
        TypeExtension(ValueSet Other Title) (Complex Extension)
        Is Modifierfalse
        Must Supportfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        14. ValueSet.extension:changeManagementDescription
        Slice NamechangeManagementDescription
        Definition

        Additional guidance material, providing textual guidance and links to other sources

        ShortExtension
        Control0..1
        TypeExtension(GuidanceMaterial) (Extension Type: markdown)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        16. ValueSet.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Must Supportfalse
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. ValueSet.url
        Definition

        Follows the pattern 'https://fhir.ee/ValueSet/[Resource Id]'


        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.

        Shortthis is the default formula for uriCanonical identifier for this value set, represented as a URI (globally unique)
        Comments

        Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

        The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

        In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

        Control10..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Allows the value set to be referenced by a single globally unique identifier.

        Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. ValueSet.identifier
        Definition

        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.

        ShortA non-FHIR identifier for the value set (e.g ISO OID)Additional identifier for the value set (business identifier)
        Comments

        Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Allows externally provided and/or usable business identifiers to be easily associated with the module.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on ValueSet.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • pattern @ system
        • 22. ValueSet.identifier:oid
          Slice Nameoid
          Definition

          Follows the pattern: urn:oid:1.2.3.


          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.

          ShortISO OID identifier represented as URNAdditional identifier for the value set (business identifier)
          Comments

          Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Allows externally provided and/or usable business identifiers to be easily associated with the module.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          24. ValueSet.identifier:oid.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control0..1
          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
          (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          26. ValueSet.identifier:oid.system
          Definition

          Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

          ShortThe namespace for the identifier value
          Comments

          Identifier.system is always case sensitive.

          Control10..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

          Pattern Valueurn:ietf:rfc:3986
          Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          28. ValueSet.version
          Definition

          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.

          ShortBusiness version of the value set
          Comments

          There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          30. ValueSet.versionAlgorithm[x]
          Definition

          Indicates the mechanism used to compare versions to determine which ValueSet is more current.

          ShortHow to compare versions
          Comments

          If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm
          (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
          TypeChoice of: string, Coding
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          32. ValueSet.name
          Definition

          Follows the pattern: ...


          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.

          ShortComputer-friendly name/identifier to be used for machine-processingName for this value set (computer friendly)
          Comments

          The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.

          Control10..1
          This element is affected by the following invariants: cnl-0
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Support human navigation and code generation.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          34. ValueSet.title
          Definition

          Follows the pattern: ...


          A short, descriptive, user-friendly title for the value set.

          ShortName of the value set, a human-readable well understood name. English name can be provided in the translation element.Name for this value set (human friendly)
          Comments

          This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. ValueSet.status
          Definition

          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.

          Shortdraft | active | retired | unknown
          Comments

          Allows filtering of value sets that are appropriate for use versus not.See also the http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription extension for additional status information related to the editorial process.

          See guidance around (not) making local changes to elements here.


          Allows filtering of value sets that are appropriate for use versus not.See also the http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription extension for additional status information related to the editorial process.

          See guidance around (not) making local changes to elements here.

          Control1..1
          BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0
          (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

          The lifecycle status of an artifact.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. ValueSet.experimental
          Definition

          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.

          ShortFor testing purposes, not real usage
          Comments

          In production terminology server, experimental value sets should not exist, and therefore the default value should be 'false'


          Allows filtering of value sets that are appropriate for use versus not.

          Control10..1
          Typeboolean
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.

          Meaning if MissingIf absent, this resource is treated as though it is not experimental.
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. ValueSet.publisher
          Definition

          The name of the organization or individual responsible for the release and ongoing maintenance of the value set.

          ShortThe original maintainer/publisher of the value set.Name of the publisher/steward (organization or individual)
          Comments

          Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.

          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Helps establish the "authority/credibility" of the value set. May also allow for contact.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. ValueSet.contact
          Definition

          Contact details to assist a user in finding and communicating with the publisher.

          ShortContact details for the publisher
          Comments

          May be a web site, an email address, a telephone number, etc.

          See guidance around (not) making local changes to elements here.


          May be a web site, an email address, a telephone number, etc.

          See guidance around (not) making local changes to elements here.

          Control10..*
          TypeContactDetail
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. ValueSet.description
          Definition

          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.

          ShortShort description of the value setNatural language description of the value set
          Comments

          Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).

          Control10..1
          Typemarkdown
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. ValueSet.useContext
          Definition

          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.

          ShortUsage context: health, social care, workThe context that the content is intended to support
          Comments

          When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

          Control0..*
          TypeUsageContext
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Assist in searching for appropriate content.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. ValueSet.useContext.code
          Definition

          A code that identifies the type of context being specified by this usage context.

          ShortType of context being specified
          Control1..1
          BindingUnless not suitable, these codes SHALL be taken from UsageContextTypehttp://terminology.hl7.org/ValueSet/usage-context-type
          (extensible to http://terminology.hl7.org/ValueSet/usage-context-type)

          A code that specifies a type of context being specified by a usage context.

          TypeCoding
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. ValueSet.useContext.value[x]
          Definition

          A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

          ShortValue that defines the context
          Control1..1
          BindingFor example codes, see ContextOfUseValueSethttp://hl7.org/fhir/ValueSet/use-context
          (example to http://hl7.org/fhir/ValueSet/use-context)

          A code that defines the specific value for the context being specified.

          TypeCodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on ValueSet.useContext.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • type @ $this
          • 52. ValueSet.useContext.value[x]:valueCodeableConcept
            Slice NamevalueCodeableConcept
            Definition

            A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

            ShortValue that defines the context
            Control1..1
            BindingFor example codes, see ContextOfUseValueSethttp://hl7.org/fhir/ValueSet/use-context
            (example to http://hl7.org/fhir/ValueSet/use-context)

            A code that defines the specific value for the context being specified.

            TypeCodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. ValueSet.jurisdiction
            Definition

            A legal or geographic region in which the value set is intended to be used.

            ShortIntended jurisdiction for value set (if applicable)
            Comments

            It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.

            DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

            Control0..0*
            BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction
            (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

            Countries and regions within which this artifact is targeted for use.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. ValueSet.purpose
            Definition

            Explanation of why this value set is needed and why it has been designed as it has.

            ShortOverview of the purpose, content, and usage of the value setWhy this value set is defined
            Comments

            This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.

            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. ValueSet.topic
            Definition

            Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching.

            ShortE.g. Education, Treatment, Assessment, etc
            Comments

            DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

            Control0..0*
            BindingFor example codes, see DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic
            (example to http://hl7.org/fhir/ValueSet/definition-topic)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Requirements

            Repositories must be able to determine how to categorize the ValueSet so that it can be found by topical and keyword searches.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. ValueSet.author
            Definition

            An individiual or organization primarily involved in the creation and maintenance of the ValueSet.

            ShortOwner of the value set. Organisation/group who is responsible for the content of the value set.Who authored the ValueSet
            Control0..1*
            TypeContactDetail
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. ValueSet.author.name
            Definition

            The name of an individual to contact.

            ShortName of the organisation/group.Name of an individual to contact
            Comments

            If there is no named individual, the telecom information is for the organization as a whole.

            Control10..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

            Guidance on how to interpret the contents of this table can be found here

            0. ValueSet
            Definition

            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 definitions and their use in coded elements.

            ShortA set of codes drawn from one or more code systems
            Control1..1
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
            2. ValueSet.id
            Definition

            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

            ShortLogical id of this artifact
            Comments

            Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

            Control0..1
            Typeid
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            4. ValueSet.meta
            Definition

            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            6. ValueSet.implicitRules
            Definition

            A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

            ShortA set of rules under which this content was created
            Comments

            Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

            Control0..1
            Typeuri
            Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            8. ValueSet.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

            Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

            Control0..1
            BindingThe codes SHALL be taken from AllLanguages
            (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

            IETF language tag for a human language

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            10. ValueSet.text
            Definition

            A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

            ShortText summary of the resource, for human interpretation
            Comments

            Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

            Control0..1
            This element is affected by the following invariants: dom-6
            TypeNarrative
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Alternate Namesnarrative, html, xhtml, display
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            12. ValueSet.contained
            Definition

            These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

            ShortA value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
            Comments

            This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

            Control0..*
            This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
            TypeResource
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Alternate Namesinline resources, anonymous resources, contained resources
            14. ValueSet.extension
            Definition

            An Extension

            ShortDescription of change management: periodicity, change request workflow, release dates, responsibilities, etc
            Control0..*
            TypeExtension
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on ValueSet.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 16. ValueSet.extension:knowledgeRepresentationLevel
              Slice NameknowledgeRepresentationLevel
              Definition

              Defines a knowledge representation level provided by this knowledge artifact.

              Shortnarrative | semi-structured | structured | executable
              Control0..*
              TypeExtension(CQF knowledge representation level) (Extension Type: code)
              Is Modifierfalse
              Must Supporttrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              18. ValueSet.extension:authoritativeSource
              Slice NameauthoritativeSource
              Definition

              A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions.

              ShortReference to the current trusted source of the ValueSet resource (metadata and definition)
              Comments

              If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.

              Control0..1
              TypeExtension(ValueSet Authoritative Source) (Extension Type: uri)
              Is Modifierfalse
              Must Supporttrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              20. ValueSet.extension:otherTitle
              Slice NameotherTitle
              Definition

              Human readable titles for the valueset.

              ShortAlternative titles
              Control0..*
              TypeExtension(ValueSet Other Title) (Complex Extension)
              Is Modifierfalse
              Must Supportfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              22. ValueSet.extension:changeManagementDescription
              Slice NamechangeManagementDescription
              Definition

              Additional guidance material, providing textual guidance and links to other sources

              ShortExtension
              Control0..1
              TypeExtension(GuidanceMaterial) (Extension Type: markdown)
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              24. ValueSet.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
              Must Supportfalse
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              26. ValueSet.url
              Definition

              Follows the pattern 'https://fhir.ee/ValueSet/[Resource Id]'

              Shortthis is the default formula for uri
              Comments

              Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

              The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

              In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

              Control1..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              Allows the value set to be referenced by a single globally unique identifier.

              Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. ValueSet.identifier
              Definition

              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.

              ShortA non-FHIR identifier for the value set (e.g ISO OID)
              Comments

              Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

              Allows externally provided and/or usable business identifiers to be easily associated with the module.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on ValueSet.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • pattern @ system
              • 30. ValueSet.identifier:oid
                Slice Nameoid
                Definition

                Follows the pattern: urn:oid:1.2.3.

                ShortISO OID identifier represented as URN
                Comments

                Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

                Allows externally provided and/or usable business identifiers to be easily associated with the module.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. ValueSet.identifier:oid.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                This element is affected by the following invariants: ele-1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                34. ValueSet.identifier:oid.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on ValueSet.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 36. ValueSet.identifier:oid.use
                  Definition

                  The purpose of this identifier.

                  Shortusual | official | temp | secondary | old (If known)
                  Comments

                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                  Control0..1
                  BindingThe codes SHALL be taken from IdentifierUse
                  (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                  Identifies the purpose for this identifier, if known .

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  38. ValueSet.identifier:oid.type
                  Definition

                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                  ShortDescription of identifier
                  Comments

                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows users to make use of identifiers when the identifier system is not known.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  40. ValueSet.identifier:oid.system
                  Definition

                  Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                  Pattern Valueurn:ietf:rfc:3986
                  Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  42. ValueSet.identifier:oid.value
                  Definition

                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                  ShortThe value that is unique
                  Comments

                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                  Control0..1
                  This element is affected by the following invariants: ident-1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Example<br/><b>General</b>:123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  44. ValueSet.identifier:oid.period
                  Definition

                  Time period during which identifier is/was valid for use.

                  ShortTime period when id is/was valid for use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  46. ValueSet.identifier:oid.assigner
                  Definition

                  Organization that issued/manages the identifier.

                  ShortOrganization that issued id (may be just text)
                  Comments

                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                  Control0..1
                  TypeReference(Organization)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  48. ValueSet.version
                  Definition

                  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.

                  ShortBusiness version of the value set
                  Comments

                  There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

                  NoteThis is a business version Id, not a resource version Id (see discussion)
                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. ValueSet.versionAlgorithm[x]
                  Definition

                  Indicates the mechanism used to compare versions to determine which ValueSet is more current.

                  ShortHow to compare versions
                  Comments

                  If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
                  (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
                  TypeChoice of: string, Coding
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. ValueSet.name
                  Definition

                  Follows the pattern: ...

                  ShortComputer-friendly name/identifier to be used for machine-processing
                  Comments

                  The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.

                  Control1..1
                  This element is affected by the following invariants: cnl-0
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Support human navigation and code generation.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. ValueSet.title
                  Definition

                  Follows the pattern: ...

                  ShortName of the value set, a human-readable well understood name. English name can be provided in the translation element.
                  Comments

                  This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. ValueSet.status
                  Definition

                  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.

                  Shortdraft | active | retired | unknown
                  Comments

                  Allows filtering of value sets that are appropriate for use versus not.See also the http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription extension for additional status information related to the editorial process.

                  See guidance around (not) making local changes to elements here.

                  Control1..1
                  BindingThe codes SHALL be taken from PublicationStatus
                  (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

                  The lifecycle status of an artifact.

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. ValueSet.experimental
                  Definition

                  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.

                  ShortFor testing purposes, not real usage
                  Comments

                  In production terminology server, experimental value sets should not exist, and therefore the default value should be 'false'

                  Control1..1
                  Typeboolean
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.

                  Meaning if MissingIf absent, this resource is treated as though it is not experimental.
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. ValueSet.date
                  Definition

                  The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised.

                  ShortDate last changed
                  Comments

                  Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

                  See guidance around (not) making local changes to elements here.

                  Control0..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Alternate NamesRevision Date
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. ValueSet.publisher
                  Definition

                  The name of the organization or individual responsible for the release and ongoing maintenance of the value set.

                  ShortThe original maintainer/publisher of the value set.
                  Comments

                  Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.

                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Helps establish the "authority/credibility" of the value set. May also allow for contact.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. ValueSet.contact
                  Definition

                  Contact details to assist a user in finding and communicating with the publisher.

                  ShortContact details for the publisher
                  Comments

                  May be a web site, an email address, a telephone number, etc.

                  See guidance around (not) making local changes to elements here.

                  Control1..*
                  TypeContactDetail
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. ValueSet.description
                  Definition

                  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.

                  ShortShort description of the value set
                  Comments

                  Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).

                  Control1..1
                  Typemarkdown
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. ValueSet.useContext
                  Definition

                  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.

                  ShortUsage context: health, social care, work
                  Comments

                  When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                  Control0..*
                  TypeUsageContext
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Assist in searching for appropriate content.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. ValueSet.useContext.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  72. ValueSet.useContext.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on ValueSet.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 74. ValueSet.useContext.code
                    Definition

                    A code that identifies the type of context being specified by this usage context.

                    ShortType of context being specified
                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                    (extensible to http://terminology.hl7.org/ValueSet/usage-context-type)

                    A code that specifies a type of context being specified by a usage context.

                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. ValueSet.useContext.value[x]
                    Definition

                    A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                    ShortValue that defines the context
                    Control1..1
                    BindingFor example codes, see ContextOfUseValueSet
                    (example to http://hl7.org/fhir/ValueSet/use-context)

                    A code that defines the specific value for the context being specified.

                    TypeCodeableConcept
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on ValueSet.useContext.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 78. ValueSet.useContext.value[x]:valueCodeableConcept
                      Slice NamevalueCodeableConcept
                      Definition

                      A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                      ShortValue that defines the context
                      Control1..1
                      BindingFor example codes, see ContextOfUseValueSet
                      (example to http://hl7.org/fhir/ValueSet/use-context)

                      A code that defines the specific value for the context being specified.

                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      80. ValueSet.jurisdiction
                      Definition

                      A legal or geographic region in which the value set is intended to be used.

                      ShortIntended jurisdiction for value set (if applicable)
                      Comments

                      It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.

                      DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

                      Control0..0
                      BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSet
                      (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

                      Countries and regions within which this artifact is targeted for use.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      82. ValueSet.immutable
                      Definition

                      If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

                      ShortIndicates whether or not any change to the content logical definition may occur
                      Comments

                      Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. ValueSet.purpose
                      Definition

                      Explanation of why this value set is needed and why it has been designed as it has.

                      ShortOverview of the purpose, content, and usage of the value set
                      Comments

                      This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.

                      Control0..1
                      Typemarkdown
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      86. ValueSet.copyright
                      Definition

                      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.

                      ShortUse and/or publishing restrictions
                      Comments

                      Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.

                      Control0..1
                      Typemarkdown
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Requirements

                      Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.

                      Alternate NamesLicense, Restrictions
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. ValueSet.copyrightLabel
                      Definition

                      A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

                      ShortCopyright holder and year(s)
                      Comments

                      The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Requirements

                      Defines the content expected to be rendered in all representations of the artifact.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. ValueSet.approvalDate
                      Definition

                      The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

                      ShortWhen the ValueSet was approved by publisher
                      Comments

                      The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

                      See guidance around (not) making local changes to elements here.

                      Control0..1
                      Typedate
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. ValueSet.lastReviewDate
                      Definition

                      The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

                      ShortWhen the ValueSet was last reviewed by the publisher
                      Comments

                      If specified, this date follows the original approval date.

                      See guidance around (not) making local changes to elements here.

                      Control0..1
                      Typedate
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Requirements

                      Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. ValueSet.effectivePeriod
                      Definition

                      The period during which the ValueSet content was or is planned to be in active use.

                      ShortWhen the ValueSet is expected to be used
                      Comments

                      The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.

                      See guidance around (not) making local changes to elements here.

                      Control0..1
                      TypePeriod
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ValueSet are or are expected to be used instead.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      96. ValueSet.topic
                      Definition

                      Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching.

                      ShortE.g. Education, Treatment, Assessment, etc
                      Comments

                      DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

                      Control0..0
                      BindingFor example codes, see DefinitionTopic
                      (example to http://hl7.org/fhir/ValueSet/definition-topic)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Requirements

                      Repositories must be able to determine how to categorize the ValueSet so that it can be found by topical and keyword searches.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. ValueSet.author
                      Definition

                      An individiual or organization primarily involved in the creation and maintenance of the ValueSet.

                      ShortOwner of the value set. Organisation/group who is responsible for the content of the value set.
                      Control0..1
                      TypeContactDetail
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. ValueSet.author.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      102. ValueSet.author.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on ValueSet.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 104. ValueSet.author.name
                        Definition

                        The name of an individual to contact.

                        ShortName of the organisation/group.
                        Comments

                        If there is no named individual, the telecom information is for the organization as a whole.

                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        106. ValueSet.author.telecom
                        Definition

                        The contact details for the individual (if a name was provided) or the organization.

                        ShortContact details for individual or organization
                        Control0..*
                        TypeContactPoint
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        108. ValueSet.editor
                        Definition

                        An individual or organization primarily responsible for internal coherence of the ValueSet.

                        ShortWho edited the ValueSet
                        Control0..*
                        TypeContactDetail
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        110. ValueSet.reviewer
                        Definition

                        An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet.

                        ShortWho reviewed the ValueSet
                        Comments

                        See guidance around (not) making local changes to elements here.

                        Control0..*
                        TypeContactDetail
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        112. ValueSet.endorser
                        Definition

                        An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting.

                        ShortWho endorsed the ValueSet
                        Comments

                        See guidance around (not) making local changes to elements here.

                        Control0..*
                        TypeContactDetail
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        114. ValueSet.relatedArtifact
                        Definition

                        Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

                        ShortAdditional documentation, citations, etc
                        Comments

                        Each related artifact is either an attachment, or a reference to another resource, but not both.

                        Control0..*
                        TypeRelatedArtifact
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Requirements

                        A ValueSet must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        116. ValueSet.compose
                        Definition

                        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).

                        ShortContent logical definition of the value set (CLD)
                        Control0..1
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Alternate NamesContent Logical Definition, CLD
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        118. ValueSet.compose.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        120. ValueSet.compose.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        122. ValueSet.compose.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        124. ValueSet.compose.lockedDate
                        Definition

                        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.

                        ShortFixed date for references with no specified version (transitive)
                        Comments

                        With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.

                        Control0..1
                        Typedate
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. ValueSet.compose.inactive
                        Definition

                        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).

                        ShortWhether inactive codes are in the value set
                        Comments

                        Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.

                        The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. ValueSet.compose.include
                        Definition

                        Include one or more codes from a code system or other value set(s).

                        ShortInclude one or more codes from a code system or other value set(s)
                        Comments

                        All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.

                        Control1..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        vsd-1: A value set include/exclude SHALL have a value set or a system (valueSet.exists() or system.exists())
                        vsd-2: A value set with concepts or filters SHALL include a system ((concept.exists() or filter.exists()) implies system.exists())
                        vsd-3: Cannot have both concept and filter (concept.empty() or filter.empty())
                        130. ValueSet.compose.include.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        132. ValueSet.compose.include.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        134. ValueSet.compose.include.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        136. ValueSet.compose.include.system
                        Definition

                        An absolute URI which is the code system from which the selected codes come from.

                        ShortThe system the codes come from
                        Comments

                        If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.

                        Control0..1
                        This element is affected by the following invariants: vsd-2, vsd-1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        138. ValueSet.compose.include.version
                        Definition

                        The version of the code system that the codes are selected from, or the special version '*' for all versions.

                        ShortSpecific version of the code system referred to
                        Comments

                        This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        140. ValueSet.compose.include.concept
                        Definition

                        Specifies a concept to be included or excluded.

                        ShortA concept defined in the system
                        Comments

                        The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.

                        Control0..*
                        This element is affected by the following invariants: vsd-2, vsd-3
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        142. ValueSet.compose.include.concept.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        144. ValueSet.compose.include.concept.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        146. ValueSet.compose.include.concept.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        148. ValueSet.compose.include.concept.code
                        Definition

                        Specifies a code for the concept to be included or excluded.

                        ShortCode or expression from system
                        Comments

                        Expressions are allowed if defined by the underlying code system.

                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        150. ValueSet.compose.include.concept.display
                        Definition

                        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.

                        ShortText to display for this code for this value set in this valueset
                        Comments

                        The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        152. ValueSet.compose.include.concept.designation
                        Definition

                        Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.

                        ShortAdditional representations for this concept
                        Comments

                        Concepts have both a display and an array of designation. The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language.

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present (additionalUse.exists() implies use.exists())
                        154. ValueSet.compose.include.concept.designation.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        156. ValueSet.compose.include.concept.designation.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        158. ValueSet.compose.include.concept.designation.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        160. ValueSet.compose.include.concept.designation.language
                        Definition

                        The language this designation is defined for.

                        ShortHuman language of the designation
                        Comments

                        In the absence of a language, the resource language applies.

                        Control0..1
                        BindingThe codes SHALL be taken from AllLanguages
                        (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                        IETF language tag for a human language

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        162. ValueSet.compose.include.concept.designation.use
                        Definition

                        A code that represents types of uses of designations.

                        ShortTypes of uses of designations
                        Comments

                        If no use is provided, the designation can be assumed to be suitable for general display to a human user.

                        Control0..1
                        This element is affected by the following invariants: vsd-11
                        BindingUnless not suitable, these codes SHALL be taken from DesignationUse
                        (extensible to http://hl7.org/fhir/ValueSet/designation-use)

                        Details of how a designation would be used.

                        TypeCoding
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        164. ValueSet.compose.include.concept.designation.additionalUse
                        Definition

                        Additional codes that detail how this designation would be used, if there is more than one use.

                        ShortAdditional ways how this designation would be used
                        Comments

                        This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility.

                        Control0..*
                        This element is affected by the following invariants: vsd-11
                        BindingUnless not suitable, these codes SHALL be taken from DesignationUse
                        (extensible to http://hl7.org/fhir/ValueSet/designation-use)

                        Details of how a designation would be used.

                        TypeCoding
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        166. ValueSet.compose.include.concept.designation.value
                        Definition

                        The text value for this designation.

                        ShortThe text value for this designation
                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        168. ValueSet.compose.include.filter
                        Definition

                        Select concepts by specifying 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 within the include, they SHALL all be true.

                        ShortSelect codes/concepts by their properties (including relationships)
                        Comments

                        Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.

                        Control0..*
                        This element is affected by the following invariants: vsd-2, vsd-3
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        170. ValueSet.compose.include.filter.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        172. ValueSet.compose.include.filter.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        174. ValueSet.compose.include.filter.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        176. ValueSet.compose.include.filter.property
                        Definition

                        A code that identifies a property or a filter defined in the code system.

                        ShortA property/filter defined by the code system
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        178. ValueSet.compose.include.filter.op
                        Definition

                        The kind of operation to perform as a part of the filter criteria.

                        Short= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
                        Comments

                        In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values.

                        Control1..1
                        BindingThe codes SHALL be taken from FilterOperator
                        (required to http://hl7.org/fhir/ValueSet/filter-operator|5.0.0)

                        The kind of operation to perform as a part of a property based filter.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        180. ValueSet.compose.include.filter.value
                        Definition

                        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'.

                        ShortCode from the system, or regex criteria, or boolean value for exists
                        Comments

                        Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.

                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        182. ValueSet.compose.include.valueSet
                        Definition

                        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.

                        ShortSelect the contents included in this value set
                        Comments

                        The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.

                        Control0..*
                        This element is affected by the following invariants: vsd-1
                        Typecanonical(ValueSet)
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        184. ValueSet.compose.include.copyright
                        Definition

                        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).

                        ShortA copyright statement for the specific code system included in the value set
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        186. ValueSet.compose.exclude
                        Definition

                        Exclude one or more codes from the value set based on code system filters and/or other value sets.

                        ShortExplicitly exclude codes from a code system or other value sets
                        Comments

                        Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.

                        Control0..*
                        TypeSeettp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        188. ValueSet.compose.property
                        Definition

                        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.

                        ShortProperty to return if client doesn't override
                        Comments

                        For locally defined code systems, all properties should be in default expansion. This means '*' in the definition.

                        Control0..*
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        190. ValueSet.expansion
                        Definition

                        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.

                        ShortUsed when the value set is "expanded"
                        Comments

                        Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.

                        Expansion.parameter is a simplified list of parameters - a subset of the features of the Parameters resource.

                        Control0..1
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        192. ValueSet.expansion.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        194. ValueSet.expansion.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        196. ValueSet.expansion.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        198. ValueSet.expansion.identifier
                        Definition

                        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.

                        ShortIdentifies the value set expansion (business identifier)
                        Comments

                        Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).

                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        200. ValueSet.expansion.next
                        Definition

                        As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.

                        ShortOpaque urls for paging through expansion results
                        Comments

                        Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        202. ValueSet.expansion.timestamp
                        Definition

                        The time at which the expansion was produced by the expanding system.

                        ShortTime ValueSet expansion happened
                        Comments

                        This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.

                        Control1..1
                        TypedateTime
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        204. ValueSet.expansion.total
                        Definition

                        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.

                        ShortTotal number of codes in the expansion
                        Comments

                        Paging only applies to flat expansions.

                        Control0..1
                        Typeinteger
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        206. ValueSet.expansion.offset
                        Definition

                        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.

                        ShortOffset at which this resource starts
                        Comments

                        Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.

                        Control0..1
                        Typeinteger
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Meaning if MissingPaging is not being used
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        208. ValueSet.expansion.parameter
                        Definition

                        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.

                        ShortParameter that controlled the expansion process
                        Comments

                        The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        210. ValueSet.expansion.parameter.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        212. ValueSet.expansion.parameter.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        214. ValueSet.expansion.parameter.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        216. ValueSet.expansion.parameter.name
                        Definition

                        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.

                        ShortName as assigned by the client or server
                        Comments

                        The names are assigned at the discretion of the server.

                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        218. ValueSet.expansion.parameter.value[x]
                        Definition

                        The value of the parameter.

                        ShortValue of the named parameter
                        Control0..1
                        TypeChoice of: string, boolean, integer, decimal, uri, code, dateTime
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        220. ValueSet.expansion.property
                        Definition

                        A property defines an additional slot through which additional information can be provided about a concept.

                        ShortAdditional information supplied about each concept
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        222. ValueSet.expansion.property.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        224. ValueSet.expansion.property.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        226. ValueSet.expansion.property.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        228. ValueSet.expansion.property.code
                        Definition

                        A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.

                        ShortIdentifies the property on the concepts, and when referred to in operations
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        230. ValueSet.expansion.property.uri
                        Definition

                        Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.

                        ShortFormal identifier for the property
                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        232. ValueSet.expansion.contains
                        Definition

                        The codes that are contained in the value set expansion.

                        ShortCodes in the value set
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        vsd-6: SHALL have a code or a display (code.exists() or display.exists())
                        vsd-9: SHALL have a code if not abstract (code.exists() or abstract = true)
                        vsd-10: SHALL have a system if a code is present (code.empty() or system.exists())
                        234. ValueSet.expansion.contains.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        236. ValueSet.expansion.contains.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        238. ValueSet.expansion.contains.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        240. ValueSet.expansion.contains.system
                        Definition

                        An absolute URI which is the code system in which the code for this item in the expansion is defined.

                        ShortSystem value for the code
                        Control0..1
                        This element is affected by the following invariants: vsd-10
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        242. ValueSet.expansion.contains.abstract
                        Definition

                        If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

                        ShortIf user cannot select this entry
                        Comments

                        This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.

                        Control0..1
                        This element is affected by the following invariants: vsd-9
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Meaning if MissingIf this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        244. ValueSet.expansion.contains.inactive
                        Definition

                        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 a concept is inactive (and it may depend on the context of use).

                        ShortIf concept is inactive in the code system
                        Comments

                        This should only have a value if the concept is inactive.

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        246. ValueSet.expansion.contains.version
                        Definition

                        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.

                        ShortVersion in which this code/display is defined
                        Comments

                        The exact value of the version string is specified by the system from which the code is derived.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        248. ValueSet.expansion.contains.code
                        Definition

                        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.

                        ShortCode - if blank, this is not a selectable code
                        Control0..1
                        This element is affected by the following invariants: vsd-6, vsd-9, vsd-10
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        250. ValueSet.expansion.contains.display
                        Definition

                        The recommended display for this item in the expansion.

                        ShortUser display for the concept
                        Control0..1
                        This element is affected by the following invariants: vsd-6
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        252. ValueSet.expansion.contains.designation
                        Definition

                        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.

                        ShortAdditional representations for this item
                        Comments

                        The designations provided must be based on the value set and code system definitions.

                        Control0..*
                        TypeSeettp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        254. ValueSet.expansion.contains.property
                        Definition

                        A property value for this concept.

                        ShortProperty value for the concept
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        256. ValueSet.expansion.contains.property.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        258. ValueSet.expansion.contains.property.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        260. ValueSet.expansion.contains.property.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        262. ValueSet.expansion.contains.property.code
                        Definition

                        A code that is a reference to ValueSet.expansion.property.code.

                        ShortReference to ValueSet.expansion.property.code
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        264. ValueSet.expansion.contains.property.value[x]
                        Definition

                        The value of this property.

                        ShortValue of the property for this concept
                        Control1..1
                        TypeChoice of: code, Coding, string, integer, boolean, dateTime, decimal
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        266. ValueSet.expansion.contains.property.subProperty
                        Definition

                        A subproperty value for this concept.

                        ShortSubProperty value for the concept
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        268. ValueSet.expansion.contains.property.subProperty.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        270. ValueSet.expansion.contains.property.subProperty.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        272. ValueSet.expansion.contains.property.subProperty.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        274. ValueSet.expansion.contains.property.subProperty.code
                        Definition

                        A code that is a reference to ValueSet.expansion.property.code.

                        ShortReference to ValueSet.expansion.property.code
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        276. ValueSet.expansion.contains.property.subProperty.value[x]
                        Definition

                        The value of this subproperty.

                        ShortValue of the subproperty for this concept
                        Control1..1
                        TypeChoice of: code, Coding, string, integer, boolean, dateTime, decimal
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        278. ValueSet.expansion.contains.contains
                        Definition

                        Other codes and entries contained under this entry in the hierarchy.

                        ShortCodes contained under this entry
                        Comments

                        If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.

                        Control0..*
                        TypeSeettp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        280. ValueSet.scope
                        Definition

                        Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

                        ShortDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
                        Control0..1
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        282. ValueSet.scope.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        284. ValueSet.scope.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        286. ValueSet.scope.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        288. ValueSet.scope.inclusionCriteria
                        Definition

                        Criteria describing which concepts or codes should be included and why.

                        ShortCriteria describing which concepts or codes should be included and why
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        290. ValueSet.scope.exclusionCriteria
                        Definition

                        Criteria describing which concepts or codes should be excluded and why.

                        ShortCriteria describing which concepts or codes should be excluded and why
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))