description: 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](terminologies.html).
package_name: hl7.fhir.r5.examples
derivation: specialization
name: ValueSet
type: ValueSet
elements:
  description: {isModifier: false, short: Natural language description of the value set, type: markdown, mustSupport: false, isSummary: false, index: 10}
  compose:
    isModifier: false
    short: Content logical definition of the value set (CLD)
    type: BackboneElement
    mustSupport: false
    isSummary: false
    index: 16
    elements:
      lockedDate: {isModifier: false, short: Fixed date for references with no specified version (transitive), type: date, mustSupport: false, isSummary: true, index: 17}
      inactive: {isModifier: false, short: Whether inactive codes are in the value set, type: boolean, mustSupport: false, isSummary: true, index: 18}
      include:
        constraint:
          vsd-2: {human: A value set with concepts or filters SHALL include a system, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: (concept.exists() or filter.exists()) implies system.exists()}
          vsd-3: {human: Cannot have both concept and filter, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: concept.empty() or filter.empty()}
          vsd-1: {human: A value set include/exclude SHALL have a value set or a system, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: valueSet.exists() or system.exists()}
        min: 1
        isModifier: false
        short: Include one or more codes from a code system or other value set(s)
        index: 19
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          system: {isModifier: false, short: The system the codes come from, type: uri, mustSupport: false, isSummary: true, index: 20}
          version: {isModifier: false, short: Specific version of the code system referred to, type: string, mustSupport: false, isSummary: true, index: 21}
          concept:
            isModifier: false
            short: A concept defined in the system
            index: 22
            type: BackboneElement
            mustSupport: false
            array: true
            elements:
              code: {isModifier: false, short: Code or expression from system, type: code, mustSupport: false, isSummary: false, index: 23}
              display: {isModifier: false, short: Text to display for this code for this value set in this valueset, type: string, mustSupport: false, isSummary: false, index: 24}
              designation:
                isModifier: false
                short: Additional representations for this concept
                index: 25
                type: BackboneElement
                mustSupport: false
                array: true
                elements:
                  language:
                    isModifier: false
                    short: Human language of the designation
                    type: code
                    mustSupport: false
                    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/languages'}
                    isSummary: false
                    index: 26
                  use:
                    isModifier: false
                    short: Types of uses of designations
                    type: Coding
                    mustSupport: false
                    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'}
                    isSummary: false
                    index: 27
                  value: {isModifier: false, short: The text value for this designation, type: string, mustSupport: false, isSummary: false, index: 28}
                required: [value]
                isSummary: false
            required: [code]
            isSummary: false
          filter:
            isModifier: false
            short: Select codes/concepts by their properties (including relationships)
            index: 29
            type: BackboneElement
            mustSupport: false
            array: true
            elements:
              property: {isModifier: false, short: A property/filter defined by the code system, type: code, mustSupport: false, isSummary: true, index: 30}
              op:
                isModifier: false
                short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
                type: code
                mustSupport: false
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/filter-operator|5.0.0-snapshot1'}
                isSummary: true
                index: 31
              value: {isModifier: false, short: 'Code from the system, or regex criteria, or boolean value for exists', type: string, mustSupport: false, isSummary: true, index: 32}
            required: [value, property, op]
            isSummary: true
          valueSet: {isModifier: false, short: Select the contents included in this value set, type: canonical, mustSupport: false, array: true, isSummary: true, index: 33}
          copyright: {isModifier: false, short: A copyright statement for the specific code system included in the value set, type: string, mustSupport: false, isSummary: false, index: 34}
        isSummary: true
      exclude:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/ValueSet', elements, compose, elements, include]
        isModifier: false
        short: Explicitly exclude codes from a code system or other value sets
        mustSupport: false
        array: true
        isSummary: false
        index: 35
      property: {isModifier: false, short: Property to return if client doesn't override, type: string, mustSupport: false, array: true, isSummary: false, index: 36}
    required: [include]
  date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 7}
  publisher: {isModifier: false, short: Name of the publisher (organization or individual), type: string, mustSupport: false, isSummary: true, index: 8}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for value set (if applicable)
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 12
  purpose: {isModifier: false, short: Why this value set is defined, type: markdown, mustSupport: false, isSummary: false, index: 14}
  name: {isModifier: false, short: Name for this value set (computer friendly), type: string, mustSupport: false, isSummary: true, index: 3}
  useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 11}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 15}
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', type: boolean, mustSupport: false, isSummary: true, index: 6}
  scope:
    isModifier: false
    short: Description of the semantic space the Value Set Expansion is intended to cover
    type: BackboneElement
    mustSupport: false
    isSummary: false
    index: 76
    elements:
      focus: {isModifier: false, short: General focus of the Value Set as it relates to the intended semantic space, type: string, mustSupport: false, isSummary: false, index: 77}
      inclusionCriteria: {isModifier: false, short: Criteria describing which concepts or codes should be included and why, type: string, mustSupport: false, isSummary: false, index: 78}
      exclusionCriteria: {isModifier: false, short: Criteria describing which concepts or codes should be excluded and why, type: string, mustSupport: false, isSummary: false, index: 79}
  expansion:
    isModifier: false
    short: Used when the value set is "expanded"
    type: BackboneElement
    mustSupport: false
    isSummary: false
    index: 37
    elements:
      identifier: {isModifier: false, short: Identifies the value set expansion (business identifier), type: uri, mustSupport: false, isSummary: false, index: 38}
      timestamp: {isModifier: false, short: Time ValueSet expansion happened, type: dateTime, mustSupport: false, isSummary: false, index: 39}
      total: {isModifier: false, short: Total number of codes in the expansion, type: integer, mustSupport: false, isSummary: false, index: 40}
      offset: {isModifier: false, short: Offset at which this resource starts, type: integer, mustSupport: false, meaningWhenMissing: Paging is not being used, isSummary: false, index: 41}
      parameter:
        isModifier: false
        short: Parameter that controlled the expansion process
        index: 42
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          valueCode: {isModifier: false, short: Value of the named parameter, type: code, mustSupport: false, choiceOf: value, isSummary: false, index: 51}
          valueUri: {isModifier: false, short: Value of the named parameter, type: uri, mustSupport: false, choiceOf: value, isSummary: false, index: 50}
          valueDecimal: {isModifier: false, short: Value of the named parameter, type: decimal, mustSupport: false, choiceOf: value, isSummary: false, index: 49}
          name: {isModifier: false, short: Name as assigned by the client or server, type: string, mustSupport: false, isSummary: false, index: 43}
          value:
            isModifier: false
            short: Value of the named parameter
            mustSupport: false
            choices: [valueString, valueBoolean, valueInteger, valueDecimal, valueUri, valueCode, valueDateTime]
            isSummary: false
            index: 45
          valueString: {isModifier: false, short: Value of the named parameter, type: string, mustSupport: false, choiceOf: value, isSummary: false, index: 46}
          valueBoolean: {isModifier: false, short: Value of the named parameter, type: boolean, mustSupport: false, choiceOf: value, isSummary: false, index: 47}
          valueDateTime: {isModifier: false, short: Value of the named parameter, type: dateTime, mustSupport: false, choiceOf: value, isSummary: false, index: 52}
          valueInteger: {isModifier: false, short: Value of the named parameter, type: integer, mustSupport: false, choiceOf: value, isSummary: false, index: 48}
        required: [name]
        isSummary: false
      property:
        isModifier: false
        short: Additional information supplied about each concept
        index: 53
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          code: {isModifier: false, short: 'Identifies the property on the concepts, and when referred to in operations', type: code, mustSupport: false, isSummary: false, index: 54}
          uri: {isModifier: false, short: Formal identifier for the property, type: uri, mustSupport: false, isSummary: false, index: 55}
        required: [code]
        isSummary: false
      contains:
        constraint:
          vsd-6: {human: SHALL have a code or a display, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: code.exists() or display.exists()}
          vsd-9: {human: Must have a code if not abstract, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: code.exists() or abstract = true}
          vsd-10: {human: Must have a system if a code is present, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: code.empty() or system.exists()}
        isModifier: false
        short: Codes in the value set
        index: 56
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          inactive: {isModifier: false, short: If concept is inactive in the code system, type: boolean, mustSupport: false, isSummary: false, index: 59}
          system: {isModifier: false, short: System value for the code, type: uri, mustSupport: false, isSummary: false, index: 57}
          contains:
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ValueSet', elements, expansion, elements, contains]
            isModifier: false
            short: Codes contained under this entry
            mustSupport: false
            array: true
            isSummary: false
            index: 75
          property:
            isModifier: false
            short: Property value for the concept
            index: 64
            type: BackboneElement
            mustSupport: false
            array: true
            elements:
              valueCode: {isModifier: false, short: Value of the property for this concept, type: code, mustSupport: false, choiceOf: value, isSummary: false, index: 68}
              valueDecimal: {isModifier: false, short: Value of the property for this concept, type: decimal, mustSupport: false, choiceOf: value, isSummary: false, index: 74}
              value:
                isModifier: false
                short: Value of the property for this concept
                mustSupport: false
                choices: [valueCode, valueCoding, valueString, valueInteger, valueBoolean, valueDateTime, valueDecimal]
                isSummary: false
                index: 67
              valueString: {isModifier: false, short: Value of the property for this concept, type: string, mustSupport: false, choiceOf: value, isSummary: false, index: 70}
              valueBoolean: {isModifier: false, short: Value of the property for this concept, type: boolean, mustSupport: false, choiceOf: value, isSummary: false, index: 72}
              valueDateTime: {isModifier: false, short: Value of the property for this concept, type: dateTime, mustSupport: false, choiceOf: value, isSummary: false, index: 73}
              valueCoding: {isModifier: false, short: Value of the property for this concept, type: Coding, mustSupport: false, choiceOf: value, isSummary: false, index: 69}
              code: {isModifier: false, short: Reference to ValueSet.expansion.property.code, type: code, mustSupport: false, isSummary: false, index: 65}
              valueInteger: {isModifier: false, short: Value of the property for this concept, type: integer, mustSupport: false, choiceOf: value, isSummary: false, index: 71}
            required: [valueCoding, valueString, valueCode, valueDecimal, valueDateTime, value, valueBoolean, code, valueInteger]
            isSummary: false
          abstract: {isModifier: false, short: If user cannot select this entry, type: boolean, mustSupport: false, meaningWhenMissing: 'If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts', isSummary: false, index: 58}
          code: {isModifier: false, short: 'Code - if blank, this is not a selectable code', type: code, mustSupport: false, isSummary: false, index: 61}
          display: {isModifier: false, short: User display for the concept, type: string, mustSupport: false, isSummary: false, index: 62}
          designation:
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ValueSet', elements, compose, elements, include, elements, concept, elements, designation]
            isModifier: false
            short: Additional representations for this item
            mustSupport: false
            array: true
            isSummary: false
            index: 63
          version: {isModifier: false, short: Version in which this code/display is defined, type: string, mustSupport: false, isSummary: false, index: 60}
        isSummary: false
    required: [timestamp]
  title: {isModifier: false, short: Name for this value set (human friendly), type: string, mustSupport: false, isSummary: true, index: 4}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    index: 5
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0-snapshot1'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
  url: {isModifier: false, short: 'Canonical identifier for this value set, represented as a URI (globally unique)', type: uri, mustSupport: false, isSummary: true, index: 0}
  identifier: {isModifier: false, short: Additional identifier for the value set (business identifier), type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  immutable: {isModifier: false, short: Indicates whether or not any change to the content logical definition may occur, type: boolean, mustSupport: false, isSummary: true, index: 13}
  version: {isModifier: false, short: Business version of the value set, type: string, mustSupport: false, isSummary: true, index: 2}
  contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 9}
package_version: 5.0.0-snapshot1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ValueSet
base: http://hl7.org/fhir/StructureDefinition/CanonicalResource
version: 5.0.0-snapshot1
required: [status]