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