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: 14} compose: isModifier: false short: Content logical definition of the value set (CLD) type: BackboneElement mustSupport: false isSummary: false index: 30 elements: lockedDate: {isModifier: false, short: Fixed date for references with no specified version (transitive), type: date, mustSupport: false, isSummary: true, index: 31} inactive: {isModifier: false, short: Whether inactive codes are in the value set, type: boolean, mustSupport: false, isSummary: true, index: 32} 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: 33 type: BackboneElement mustSupport: false array: true elements: system: {isModifier: false, short: The system the codes come from, type: uri, mustSupport: false, isSummary: true, index: 34} version: {isModifier: false, short: Specific version of the code system referred to, type: string, mustSupport: false, isSummary: true, index: 35} concept: isModifier: false short: A concept defined in the system index: 36 type: BackboneElement mustSupport: false array: true elements: code: {isModifier: false, short: Code or expression from system, type: code, mustSupport: false, isSummary: false, index: 37} display: {isModifier: false, short: Text to display for this code for this value set in this valueset, type: string, mustSupport: false, isSummary: false, index: 38} 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: 39 type: BackboneElement mustSupport: false array: true elements: language: isModifier: false short: Human language of the designation type: code mustSupport: false binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-languages|5.0.0'} isSummary: false index: 40 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: 41 additionalUse: isModifier: false short: Additional ways how this designation would be used type: Coding mustSupport: false array: true binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'} isSummary: false index: 42 value: {isModifier: false, short: The text value for this designation, type: string, mustSupport: false, isSummary: false, index: 43} required: [value] isSummary: false required: [code] isSummary: false filter: isModifier: false short: Select codes/concepts by their properties (including relationships) index: 44 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: 45} 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'} isSummary: true index: 46 value: {isModifier: false, short: 'Code from the system, or regex criteria, or boolean value for exists', type: string, mustSupport: false, isSummary: true, index: 47} 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: 48} copyright: {isModifier: false, short: A copyright statement for the specific code system included in the value set, type: string, mustSupport: false, isSummary: false, index: 49} 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: 50 property: {isModifier: false, short: Property to return if client doesn't override, type: string, mustSupport: false, array: true, isSummary: false, index: 51} required: [include] date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 11} endorser: {isModifier: false, short: Who endorsed the ValueSet, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 28} publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 12} approvalDate: {isModifier: false, short: When the ValueSet was approved by publisher, type: date, mustSupport: false, isSummary: false, index: 21} 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: 16 purpose: {isModifier: false, short: Why this value set is defined, type: markdown, mustSupport: false, isSummary: false, index: 18} name: {isModifier: false, short: Name for this value set (computer friendly), type: string, mustSupport: false, isSummary: true, index: 7} copyrightLabel: {isModifier: false, short: Copyright holder and year(s), type: string, mustSupport: false, isSummary: false, index: 20} useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 15} copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 19} versionAlgorithm: isModifier: false short: How to compare versions mustSupport: false choices: [versionAlgorithmString, versionAlgorithmCoding] isSummary: true index: 4 experimental: {isModifier: false, short: 'For testing purposes, not real usage', type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 10} topic: isModifier: false short: E.g. Education, Treatment, Assessment, etc type: CodeableConcept mustSupport: false array: true binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'} isSummary: false index: 24 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 type: BackboneElement mustSupport: false isSummary: false index: 103 elements: inclusionCriteria: {isModifier: false, short: Criteria describing which concepts or codes should be included and why, type: string, mustSupport: false, isSummary: false, index: 104} exclusionCriteria: {isModifier: false, short: Criteria describing which concepts or codes should be excluded and why, type: string, mustSupport: false, isSummary: false, index: 105} expansion: isModifier: false short: Used when the value set is "expanded" type: BackboneElement mustSupport: false isSummary: false index: 52 elements: identifier: {isModifier: false, short: Identifies the value set expansion (business identifier), type: uri, mustSupport: false, isSummary: false, index: 53} next: {isModifier: false, short: Opaque urls for paging through expansion results, type: uri, mustSupport: false, isSummary: false, index: 54} timestamp: {isModifier: false, short: Time ValueSet expansion happened, type: dateTime, mustSupport: false, isSummary: false, index: 55} total: {isModifier: false, short: Total number of codes in the expansion, type: integer, mustSupport: false, isSummary: false, index: 56} offset: {isModifier: false, short: Offset at which this resource starts, type: integer, mustSupport: false, meaningWhenMissing: Paging is not being used, isSummary: false, index: 57} parameter: isModifier: false short: Parameter that controlled the expansion process index: 58 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: 67} valueUri: {isModifier: false, short: Value of the named parameter, type: uri, mustSupport: false, choiceOf: value, isSummary: false, index: 66} valueDecimal: {isModifier: false, short: Value of the named parameter, type: decimal, mustSupport: false, choiceOf: value, isSummary: false, index: 65} name: {isModifier: false, short: Name as assigned by the client or server, type: string, mustSupport: false, isSummary: false, index: 59} value: isModifier: false short: Value of the named parameter mustSupport: false choices: [valueString, valueBoolean, valueInteger, valueDecimal, valueUri, valueCode, valueDateTime] isSummary: false index: 61 valueString: {isModifier: false, short: Value of the named parameter, type: string, mustSupport: false, choiceOf: value, isSummary: false, index: 62} valueBoolean: {isModifier: false, short: Value of the named parameter, type: boolean, mustSupport: false, choiceOf: value, isSummary: false, index: 63} valueDateTime: {isModifier: false, short: Value of the named parameter, type: dateTime, mustSupport: false, choiceOf: value, isSummary: false, index: 68} valueInteger: {isModifier: false, short: Value of the named parameter, type: integer, mustSupport: false, choiceOf: value, isSummary: false, index: 64} required: [name] isSummary: false property: isModifier: false short: Additional information supplied about each concept index: 69 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: 70} uri: {isModifier: false, short: Formal identifier for the property, type: uri, mustSupport: false, isSummary: false, index: 71} 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: 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 index: 72 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: 75} system: {isModifier: false, short: System value for the code, type: uri, mustSupport: false, isSummary: false, index: 73} 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: 102 property: isModifier: false short: Property value for the concept index: 80 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: 84} valueDecimal: {isModifier: false, short: Value of the property for this concept, type: decimal, mustSupport: false, choiceOf: value, isSummary: false, index: 90} value: isModifier: false short: Value of the property for this concept mustSupport: false choices: [valueCode, valueCoding, valueString, valueInteger, valueBoolean, valueDateTime, valueDecimal] isSummary: false index: 83 valueString: {isModifier: false, short: Value of the property for this concept, type: string, mustSupport: false, choiceOf: value, isSummary: false, index: 86} valueBoolean: {isModifier: false, short: Value of the property for this concept, type: boolean, mustSupport: false, choiceOf: value, isSummary: false, index: 88} valueDateTime: {isModifier: false, short: Value of the property for this concept, type: dateTime, mustSupport: false, choiceOf: value, isSummary: false, index: 89} subProperty: isModifier: false short: SubProperty value for the concept index: 91 type: BackboneElement mustSupport: false array: true elements: valueCode: {isModifier: false, short: Value of the subproperty for this concept, type: code, mustSupport: false, choiceOf: value, isSummary: false, index: 95} valueDecimal: {isModifier: false, short: Value of the subproperty for this concept, type: decimal, mustSupport: false, choiceOf: value, isSummary: false, index: 101} value: isModifier: false short: Value of the subproperty for this concept mustSupport: false choices: [valueCode, valueCoding, valueString, valueInteger, valueBoolean, valueDateTime, valueDecimal] isSummary: false index: 94 valueString: {isModifier: false, short: Value of the subproperty for this concept, type: string, mustSupport: false, choiceOf: value, isSummary: false, index: 97} valueBoolean: {isModifier: false, short: Value of the subproperty for this concept, type: boolean, mustSupport: false, choiceOf: value, isSummary: false, index: 99} valueDateTime: {isModifier: false, short: Value of the subproperty for this concept, type: dateTime, mustSupport: false, choiceOf: value, isSummary: false, index: 100} valueCoding: {isModifier: false, short: Value of the subproperty for this concept, type: Coding, mustSupport: false, choiceOf: value, isSummary: false, index: 96} code: {isModifier: false, short: Reference to ValueSet.expansion.property.code, type: code, mustSupport: false, isSummary: false, index: 92} valueInteger: {isModifier: false, short: Value of the subproperty for this concept, type: integer, mustSupport: false, choiceOf: value, isSummary: false, index: 98} required: [valueCoding, valueString, valueCode, valueDecimal, valueDateTime, value, valueBoolean, code, valueInteger] isSummary: false valueCoding: {isModifier: false, short: Value of the property for this concept, type: Coding, mustSupport: false, choiceOf: value, isSummary: false, index: 85} code: {isModifier: false, short: Reference to ValueSet.expansion.property.code, type: code, mustSupport: false, isSummary: false, index: 81} valueInteger: {isModifier: false, short: Value of the property for this concept, type: integer, mustSupport: false, choiceOf: value, isSummary: false, index: 87} 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: 74} code: {isModifier: false, short: 'Code - if blank, this is not a selectable code', type: code, mustSupport: false, isSummary: false, index: 77} display: {isModifier: false, short: User display for the concept, type: string, mustSupport: false, isSummary: false, index: 78} 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: 79 version: {isModifier: false, short: Version in which this code/display is defined, type: string, mustSupport: false, isSummary: false, index: 76} isSummary: false required: [timestamp] title: {isModifier: false, short: Name for this value set (human friendly), type: string, mustSupport: false, isSummary: true, index: 8} author: {isModifier: false, short: Who authored the ValueSet, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 25} versionAlgorithmCoding: {isModifier: false, short: How to compare versions, type: Coding, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 6} status: isModifier: true short: draft | active | retired | unknown index: 9 type: code 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 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) 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} lastReviewDate: {isModifier: false, short: When the ValueSet was last reviewed by the publisher, type: date, mustSupport: false, isSummary: false, index: 22} editor: {isModifier: false, short: Who edited the ValueSet, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 26} immutable: {isModifier: false, short: Indicates whether or not any change to the content logical definition may occur, type: boolean, mustSupport: false, isSummary: true, index: 17} versionAlgorithmString: {isModifier: false, short: How to compare versions, type: string, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 5} reviewer: {isModifier: false, short: Who reviewed the ValueSet, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 27} version: {isModifier: false, short: Business version of the value set, type: string, mustSupport: false, isSummary: true, index: 2} relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc', type: RelatedArtifact, mustSupport: false, array: true, isSummary: false, index: 29} contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 13} effectivePeriod: {isModifier: false, short: When the ValueSet is expected to be used, type: Period, mustSupport: false, isSummary: true, index: 23} package_version: 5.0.0 class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/ValueSet base: http://hl7.org/fhir/StructureDefinition/DomainResource version: 5.0.0 required: [status]