http://hl7.org/fhir/StructureDefinition/ValueSet|5.0.0

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).
derivation: specialization
name: ValueSet
type: ValueSet
elements:
  description: {isModifier: false, short: Natural language description of the value set, mustSupport: false, isSummary: false, index: 12}
  compose:
    isModifier: false
    short: Content logical definition of the value set (CLD)
    mustSupport: false
    isSummary: false
    index: 28
    elements:
      lockedDate: {isModifier: false, short: Fixed date for references with no specified version (transitive), mustSupport: false, isSummary: true, index: 29}
      inactive: {isModifier: false, short: Whether inactive codes are in the value set, mustSupport: false, isSummary: true, index: 30}
      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: 31
        mustSupport: false
        array: true
        elements:
          system: {isModifier: false, short: The system the codes come from, mustSupport: false, isSummary: true, index: 32}
          version: {isModifier: false, short: Specific version of the code system referred to, mustSupport: false, isSummary: true, index: 33}
          concept:
            isModifier: false
            short: A concept defined in the system
            mustSupport: false
            array: true
            isSummary: false
            index: 34
            elements:
              code: {isModifier: false, short: Code or expression from system, mustSupport: false, isSummary: false, index: 35}
              display: {isModifier: false, short: Text to display for this code for this value set in this valueset, mustSupport: false, isSummary: false, index: 36}
              designation:
                constraint:
                  vsd-11: {human: Must have a value for concept.designation.use if concept.designation.additionalUse is present, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: additionalUse.exists() implies use.exists()}
                isModifier: false
                short: Additional representations for this concept
                index: 37
                mustSupport: false
                array: true
                elements:
                  language:
                    isModifier: false
                    short: Human language of the designation
                    mustSupport: false
                    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-languages|5.0.0'}
                    isSummary: false
                    index: 38
                  use:
                    isModifier: false
                    short: Types of uses of designations
                    mustSupport: false
                    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'}
                    isSummary: false
                    index: 39
                  additionalUse:
                    isModifier: false
                    short: Additional ways how this designation would be used
                    mustSupport: false
                    array: true
                    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'}
                    isSummary: false
                    index: 40
                  value: {isModifier: false, short: The text value for this designation, mustSupport: false, isSummary: false, index: 41}
                required: [value]
                isSummary: false
            required: [code]
          filter:
            isModifier: false
            short: Select codes/concepts by their properties (including relationships)
            mustSupport: false
            array: true
            isSummary: true
            index: 42
            elements:
              property: {isModifier: false, short: A property/filter defined by the code system, mustSupport: false, isSummary: true, index: 43}
              op:
                isModifier: false
                short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
                mustSupport: false
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/filter-operator|5.0.0'}
                isSummary: true
                index: 44
              value: {isModifier: false, short: 'Code from the system, or regex criteria, or boolean value for exists', mustSupport: false, isSummary: true, index: 45}
            required: [value, property, op]
          valueSet: {isModifier: false, short: Select the contents included in this value set, mustSupport: false, array: true, isSummary: true, index: 46}
          copyright: {isModifier: false, short: A copyright statement for the specific code system included in the value set, mustSupport: false, isSummary: false, index: 47}
        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: 48
      property: {isModifier: false, short: Property to return if client doesn't override, mustSupport: false, array: true, isSummary: false, index: 49}
    required: [include]
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 9}
  endorser: {isModifier: false, short: Who endorsed the ValueSet, mustSupport: false, array: true, isSummary: false, index: 26}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), mustSupport: false, isSummary: true, index: 10}
  approvalDate: {isModifier: false, short: When the ValueSet was approved by publisher, mustSupport: false, isSummary: false, index: 19}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for value set (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 14
  purpose: {isModifier: false, short: Why this value set is defined, mustSupport: false, isSummary: false, index: 16}
  name: {isModifier: false, short: Name for this value set (computer friendly), mustSupport: false, isSummary: true, index: 5}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), mustSupport: false, isSummary: false, index: 18}
  useContext: {isModifier: false, short: The context that the content is intended to support, mustSupport: false, array: true, isSummary: true, index: 13}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, mustSupport: false, isSummary: false, index: 17}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 8}
  topic:
    isModifier: false
    short: E.g. Education, Treatment, Assessment, etc
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    isSummary: false
    index: 22
  scope:
    isModifier: false
    short: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
    mustSupport: false
    isSummary: false
    index: 80
    elements:
      inclusionCriteria: {isModifier: false, short: Criteria describing which concepts or codes should be included and why, mustSupport: false, isSummary: false, index: 81}
      exclusionCriteria: {isModifier: false, short: Criteria describing which concepts or codes should be excluded and why, mustSupport: false, isSummary: false, index: 82}
  expansion:
    isModifier: false
    short: Used when the value set is \"expanded\"
    mustSupport: false
    isSummary: false
    index: 50
    elements:
      identifier: {isModifier: false, short: Identifies the value set expansion (business identifier), mustSupport: false, isSummary: false, index: 51}
      next: {isModifier: false, short: Opaque urls for paging through expansion results, mustSupport: false, isSummary: false, index: 52}
      timestamp: {isModifier: false, short: Time ValueSet expansion happened, mustSupport: false, isSummary: false, index: 53}
      total: {isModifier: false, short: Total number of codes in the expansion, mustSupport: false, isSummary: false, index: 54}
      offset: {isModifier: false, short: Offset at which this resource starts, mustSupport: false, meaningWhenMissing: Paging is not being used, isSummary: false, index: 55}
      parameter:
        isModifier: false
        short: Parameter that controlled the expansion process
        mustSupport: false
        array: true
        isSummary: false
        index: 56
        elements:
          name: {isModifier: false, short: Name as assigned by the client or server, mustSupport: false, isSummary: false, index: 57}
          value:
            isModifier: false
            short: Value of the named parameter
            mustSupport: false
            choices: []
            isSummary: false
            index: 59
        required: [name]
      property:
        isModifier: false
        short: Additional information supplied about each concept
        mustSupport: false
        array: true
        isSummary: false
        index: 60
        elements:
          code: {isModifier: false, short: 'Identifies the property on the concepts, and when referred to in operations', mustSupport: false, isSummary: false, index: 61}
          uri: {isModifier: false, short: Formal identifier for the property, mustSupport: false, isSummary: false, index: 62}
        required: [code]
      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: SHALL have a code if not abstract, source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: error, expression: code.exists() or abstract = true}
          vsd-10: {human: SHALL 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
        mustSupport: false
        array: true
        isSummary: false
        index: 63
        elements:
          inactive: {isModifier: false, short: If concept is inactive in the code system, mustSupport: false, isSummary: false, index: 66}
          system: {isModifier: false, short: System value for the code, mustSupport: false, isSummary: false, index: 64}
          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: 79
          property:
            isModifier: false
            short: Property value for the concept
            mustSupport: false
            array: true
            isSummary: false
            index: 71
            elements:
              code: {isModifier: false, short: Reference to ValueSet.expansion.property.code, mustSupport: false, isSummary: false, index: 72}
              value:
                isModifier: false
                short: Value of the property for this concept
                mustSupport: false
                choices: []
                isSummary: false
                index: 74
              subProperty:
                isModifier: false
                short: SubProperty value for the concept
                mustSupport: false
                array: true
                isSummary: false
                index: 75
                elements:
                  code: {isModifier: false, short: Reference to ValueSet.expansion.property.code, mustSupport: false, isSummary: false, index: 76}
                  value:
                    isModifier: false
                    short: Value of the subproperty for this concept
                    mustSupport: false
                    choices: []
                    isSummary: false
                    index: 78
                required: [value, code]
            required: [value, code]
          abstract: {isModifier: false, short: If user cannot select this entry, 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: 65}
          code: {isModifier: false, short: 'Code - if blank, this is not a selectable code', mustSupport: false, isSummary: false, index: 68}
          display: {isModifier: false, short: User display for the concept, mustSupport: false, isSummary: false, index: 69}
          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: 70
          version: {isModifier: false, short: Version in which this code/display is defined, mustSupport: false, isSummary: false, index: 67}
    required: [timestamp]
  title: {isModifier: false, short: Name for this value set (human friendly), mustSupport: false, isSummary: true, index: 6}
  author: {isModifier: false, short: Who authored the ValueSet, mustSupport: false, array: true, isSummary: false, index: 23}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 7
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/ValueSet', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this value set, represented as a URI (globally unique)
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the value set (business identifier), mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the ValueSet was last reviewed by the publisher, mustSupport: false, isSummary: false, index: 20}
  editor: {isModifier: false, short: Who edited the ValueSet, mustSupport: false, array: true, isSummary: false, index: 24}
  immutable: {isModifier: false, short: Indicates whether or not any change to the content logical definition may occur, mustSupport: false, isSummary: true, index: 15}
  reviewer: {isModifier: false, short: Who reviewed the ValueSet, mustSupport: false, array: true, isSummary: false, index: 25}
  version: {isModifier: false, short: Business version of the value set, mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc', mustSupport: false, array: true, isSummary: false, index: 27}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 11}
  effectivePeriod: {isModifier: false, short: When the ValueSet is expected to be used, mustSupport: false, isSummary: true, index: 21}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ValueSet
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [status]