description: Base StructureDefinition for ValueSet Resource package_name: hl7.fhir.r2.core name: ValueSet type: null elements: description: {short: Human language description of the value set, comments: '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: string, isSummary: true, index: 12} compose: type: BackboneElement short: When value set includes codes from elsewhere constraint: vsd-1: {human: A value set composition SHALL have an include or an import, severity: error} index: 32 elements: import: {short: Import the contents of another 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 also not reference an actual FHIR ValueSet resource; in this case, whatever is referenced 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: 33} include: constraint: vsd-11: {human: Cannot have both concept and filter, severity: error} short: Include one or more codes from a code system index: 34 name: include 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. type: BackboneElement array: true elements: system: {short: The system the codes come from, comments: See ''Coding.system'' for further documentation., type: uri, isSummary: true, index: 35} 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: 36} 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: 37 elements: code: {type: code, short: Code or expression from system, comments: Expressions are allowed if defined by the underlying code system., index: 38} display: {type: string, short: Test 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., index: 39} designation: {short: Additional representations for this valueset, nameReference: designation, array: true, index: 40} 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: 41 elements: property: {type: code, short: A property defined by the code system, index: 42} op: {type: code, short: = | is-a | is-not-a | regex | in | not-in, index: 43} value: {type: code, 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.', index: 44} required: [value, property, op] required: [system] isSummary: true exclude: {short: Explicitly exclude codes, nameReference: include, 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: 45} requirements: {type: string, short: Why needed, comments: 'This element does not describe the usage of the value set (that is done in comments), rather it''s for traceability of ''''why'''' the element is either needed or ''''why'''' the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.', index: 15} date: {short: Date for given status, 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: 10} publisher: {short: Name of the publisher (organization or individual), comments: 'Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.', type: string, isSummary: true, index: 6} extensible: {type: boolean, short: Whether this is intended to be used with an extensible binding, isSummary: true, index: 17} name: {short: Informal name for this value set, comments: The name is not expected to be unique. 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, type: CodeableConcept, array: true, isSummary: true, index: 13} copyright: {type: string, short: Use and/or publishing restrictions, comments: 'Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.', index: 16} experimental: {short: 'If for testing purposes, not real usage', comments: Allows filtering of value sets that are appropriate for use vs. not., type: boolean, isSummary: true, index: 5} expansion: type: BackboneElement 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. index: 46 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: 47} 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: 48} total: {type: integer, short: Total number of codes in the expansion, comments: Paging only applies to flat expansions., index: 49} offset: {type: integer, 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.', meaningWhenMissing: Paging is not being used, index: 50} 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: 51 elements: name: {type: string, short: Name as assigned by the server, comments: The names are assigned at the discretion of the server., index: 52} value: short: Value of the named parameter choices: [valueString, valueBoolean, valueInteger, valueDecimal, valueUri, valueCode] index: 54 valueString: {type: string, short: Value of the named parameter, choiceOf: value, index: 55} valueBoolean: {type: boolean, short: Value of the named parameter, choiceOf: value, index: 56} valueInteger: {type: integer, short: Value of the named parameter, choiceOf: value, index: 57} valueDecimal: {type: decimal, short: Value of the named parameter, choiceOf: value, index: 58} valueUri: {type: uri, short: Value of the named parameter, choiceOf: value, index: 59} valueCode: {type: code, short: Value of the named parameter, choiceOf: value, index: 60} required: [name] contains: name: contains type: BackboneElement short: Codes in the value set constraint: vsd-9: {human: Must have a code if not abstract, severity: error} vsd-6: {human: SHALL have a code or a display, severity: error} vsd-10: {human: Must have a system if a code is present, severity: error} array: true index: 61 elements: system: {type: uri, short: System value for the code, index: 62} abstract: {type: boolean, 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., index: 63} 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: 64} code: {type: code, short: 'Code - if blank, this is not a selectable code', index: 65} display: {type: string, short: User display for the concept, index: 66} 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.', nameReference: contains, array: true, index: 67} required: [timestamp, identifier] status: {isModifier: true, short: draft | active | retired, comments: Allows filtering of value set instances that are appropriate (or not) for use., type: code, isSummary: true, index: 4} url: {type: uri, short: Globally unique logical identifier for value set, isSummary: true, index: 0} identifier: {short: Additional identifier for the value set (e.g. HL7 v2 / CDA), comments: 'Typically, this is used for values that can go in an HL7 v3 II data type.', type: Identifier, isSummary: true, index: 1} immutable: {type: boolean, 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.', isSummary: true, index: 14} codeSystem: constraint: vsd-8: {human: Codes must be unique, severity: error} vsd-3: {human: 'Within a code system definition, all the codes SHALL be unique', severity: error} short: An inline code system, which is part of this value set comments: All code systems defined as part of a FHIR value set have an implicit valueset that includes all of the codes in the code system - the value set in which they are defined. type: BackboneElement isSummary: true index: 18 elements: system: {type: uri, short: URI to identify the code system (e.g. in Coding.system), comments: 'The reference is not required to point to any specific kind of definition, but the more information that can be provided, the more useful it is for implementers. Best practice is to resolve to a computable definition of the code system (either a value set, or some other format). Terminology servers MAY validate this reference (e.g. when accepting PUT/POST), and MAY make additional rules about what kind of content it refers to.', isSummary: true, index: 19} version: {type: string, short: Version (for use in Coding.version), isSummary: true, index: 20} caseSensitive: {type: boolean, short: If code comparison is case sensitive, comments: 'If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel''s law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.', isSummary: true, index: 21} concept: min: 1 short: Concepts in the code system index: 22 name: concept type: BackboneElement array: true elements: code: {type: code, short: Code that identifies concept, index: 23} abstract: {type: boolean, short: If this code is not for use as a real concept, defaultValueBoolean: false, index: 24} display: {type: string, short: Text to display to the user, index: 25} definition: {type: string, short: Formal definition, index: 26} designation: name: designation type: BackboneElement short: Additional representations for the concept array: true index: 27 elements: language: {type: code, short: Human language of the designation, comments: 'In the absence of a language, the resource language applies.', index: 28} use: {type: Coding, 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.', index: 29} value: {type: string, short: The text value for this designation, index: 30} required: [value] concept: {short: Child Concepts (is-a/contains/categorizes), nameReference: concept, array: true, index: 31} required: [code] required: [concept, system] version: {short: Logical identifier for this version of the value set, comments: There may be multiple resource versions of the value set that have the same identifier., type: string, isSummary: true, index: 2} contact: type: BackboneElement short: Contact details of the publisher comments: May be a web site, an email address, a telephone number, etc. isSummary: true array: true index: 7 elements: name: {type: string, short: Name of an individual to contact, comments: 'If there is no named individual, the telecom is for the organization as a whole.', isSummary: true, index: 8} telecom: {type: ContactPoint, short: Contact details for individual or publisher, isSummary: true, array: true, index: 9} lockedDate: {short: Fixed date for all referenced code systems and value sets, 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: 11} package_version: 1.0.2 class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/ValueSet version: null required: [status]