description: Base StructureDefinition for ValueSet Resource package_name: hl7.fhir.core derivation: specialization name: ValueSet type: ValueSet elements: description: {short: Natural language description of the value set, comments: 'This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description 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 description.', type: markdown, index: 10} compose: short: Definition of the content of the value set (CLD) type: BackboneElement index: 17 elements: lockedDate: {short: Fixed date for version-less references (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.', type: date, isSummary: true, index: 18} inactive: {short: Whether 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 means 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.', type: boolean, isSummary: true, index: 19} 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: 20 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'. type: BackboneElement array: true elements: system: {short: The 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.', type: uri, isSummary: true, index: 21} version: {short: Specific 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 may not be known until a context of use binds it to a particular version.', type: string, isSummary: true, index: 22} concept: short: A concept defined in the system comments: The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element. type: BackboneElement array: true index: 23 elements: code: {short: Code or expression from system, comments: Expressions are allowed if defined by the underlying code system., type: code, index: 24} display: {short: Text to display for this code for this value set, 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., type: string, index: 25} designation: type: BackboneElement short: Additional representations for this concept array: true index: 26 elements: language: {short: Human language of the designation, comments: 'In the absence of a language, the resource language applies.', type: code, index: 27} use: {short: Details how this designation would be used, comments: 'If no use is provided, the designation can be assumed to be suitable for general display to a human user.', type: Coding, index: 28} value: {type: string, short: The text value for this designation, index: 29} required: [value] required: [code] filter: short: Select 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. type: BackboneElement array: true index: 30 elements: property: {type: code, short: A property defined by the code system, index: 31} op: {isModifier: true, short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists, type: code, index: 32} value: {short: 'Code from the system, or regex criteria', comments: 'Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.', type: code, index: 33} required: [value, property, op] valueSet: {short: Select only 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]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may 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.', type: uri, array: true, isSummary: true, index: 34} 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 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. array: true index: 35 required: [include] date: {short: Date this was last changed, comments: 'Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set. Additional specific dates may be added as extensions.', type: dateTime, isSummary: true, index: 9} publisher: {short: Name of the publisher (Organization or individual), comments: 'Usually an organization, but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. 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.', type: string, isSummary: true, index: 7} extensible: {short: Whether this is intended to be used with an extensible binding, type: boolean, isSummary: true, index: 16} jurisdiction: {short: Intended jurisdiction for value set (if applicable), type: CodeableConcept, array: true, isSummary: true, index: 12} purpose: {short: Why this value set is defined, comments: 'This element does not describe the usage of the value set (See, e.g, the comments element, or relatedArtifacts), rather it''s for 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.', type: markdown, index: 14} name: {short: Name for this value set (Computer friendly), comments: The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable 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., type: string, isSummary: true, index: 3} useContext: {short: Content intends to support these contexts, comments: 'When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.', type: UsageContext, array: true, isSummary: true, index: 11} copyright: {short: Use and/or publishing restrictions, comments: 'null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.', type: markdown, index: 15} experimental: {isModifier: true, short: 'If for testing purposes, not real usage', comments: Allows filtering of value set that are appropriate for use vs. not., type: boolean, isSummary: true, index: 6} expansion: short: Used 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. type: BackboneElement index: 36 elements: identifier: {type: uri, short: Uniquely identifies this expansion, comments: 'Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).', index: 37} timestamp: {type: dateTime, short: Time 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.', index: 38} total: {type: integer, short: Total number of codes in the expansion, comments: Paging only applies to flat expansions., index: 39} offset: {short: Offset 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.', type: integer, meaningWhenMissing: Paging is not being used, index: 40} parameter: type: BackboneElement short: Parameter that controlled the expansion process comments: The server decides which parameters to include here, but at a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any). array: true index: 41 elements: name: {type: string, short: Name as assigned by the server, comments: The names are assigned at the discretion of the server., index: 42} value: short: Value of the named parameter choices: [valueString, valueBoolean, valueInteger, valueDecimal, valueUri, valueCode] 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} valueInteger: {type: integer, short: Value of the named parameter, choiceOf: value, index: 47} valueDecimal: {type: decimal, short: Value of the named parameter, choiceOf: value, index: 48} valueUri: {type: uri, short: Value of the named parameter, choiceOf: value, index: 49} valueCode: {type: code, short: Value of the named parameter, choiceOf: value, index: 50} required: [name] 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: 51 elements: system: {type: uri, short: System value for the code, index: 52} abstract: {short: If 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., type: boolean, defaultValueBoolean: false, index: 53} inactive: {short: If concept is inactive in the code system, comments: This shoulld only have a value if the concept is inactive., type: boolean, defaultValueBoolean: false, index: 54} version: {type: string, short: Version 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., index: 55} code: {type: code, short: 'Code - if blank, this is not a selectable code', index: 56} display: {type: string, short: User display for the concept, index: 57} designation: short: Additional representations for this item comments: The designations provided must be based on the value set and code system definitions. elementReference: ['http://hl7.org/fhir/StructureDefinition/ValueSet', elements, compose, elements, include, elements, concept, elements, designation] array: true index: 58 contains: short: Codes 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. elementReference: ['http://hl7.org/fhir/StructureDefinition/ValueSet', elements, expansion, elements, contains] array: true index: 59 required: [timestamp, identifier] title: {type: string, short: Name for this value set (Human friendly), isSummary: true, index: 4} status: {isModifier: true, short: draft | active | retired, comments: Allows filtering of value set that are appropriate for use vs. not., type: code, isSummary: true, index: 5} url: {short: Logical uri to reference this value set (globally unique), comments: 'Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.', type: uri, isSummary: true, index: 0} identifier: {short: Additional identifier for the value set, comments: 'Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this value set outside of FHIR, where the logical URL is not possible to use.', type: Identifier, array: true, isSummary: true, index: 1} immutable: {short: Indicates 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.', type: boolean, isSummary: true, index: 13} version: {short: Business version of the value set, comments: There may be multiple different instances of a value set that have the same identifier but different versions., type: string, isSummary: true, index: 2} contact: {short: Contact details for the publisher, comments: 'May be a web site, an email address, a telephone number, etc.', type: ContactDetail, array: true, isSummary: true, index: 8} package_version: 1.8.0 class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/ValueSet base: http://hl7.org/fhir/StructureDefinition/DomainResource version: null required: [status]