Vocabulary Work Group | Maturity Level: N | Normative (from v4.0.0) | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ValueSet resource.
| ValueSet | |||||||||||||||||
| Element Id | ValueSet | ||||||||||||||||
| Definition | 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. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | DomainResource | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.url | |||||||||||||||||
| Element Id | ValueSet.url | ||||||||||||||||
| Definition | An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | uri | ||||||||||||||||
| Requirements | Allows the value set to be referenced by a single globally unique identifier. | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||||||||||
| ValueSet.identifier | |||||||||||||||||
| Element Id | ValueSet.identifier | ||||||||||||||||
| Definition | A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | Identifier | ||||||||||||||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||||||
| ValueSet.version | |||||||||||||||||
| Element Id | ValueSet.version | ||||||||||||||||
| Definition | The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | ||||||||||||||||
| Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. | ||||||||||||||||
| ValueSet.name | |||||||||||||||||
| Element Id | ValueSet.name | ||||||||||||||||
| Definition | A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Requirements | Support human navigation and code generation. | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing 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. | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.title | |||||||||||||||||
| Element Id | ValueSet.title | ||||||||||||||||
| Definition | A short, descriptive, user-friendly title for the value set. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||
| ValueSet.status | |||||||||||||||||
| Element Id | ValueSet.status | ||||||||||||||||
| Definition | 此值域集的发布状态。它支持对资源内容生命周期进行跟踪。值域包括:草稿、生效、退休、未知 值域集的状态作用范围包含值域集定义(ValueSet.compose)和其关联的元数据。值域集的展开内容(ValueSet.expansion)是没有状态的。 | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Terminology Binding | PublicationStatus (Required) | ||||||||||||||||
| Type | code | ||||||||||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | Allows filtering of value sets that are appropriate for use versus not.See also the valueset-workflowStatus extension for additional status information related to the editorial process. | ||||||||||||||||
| ValueSet.experimental | |||||||||||||||||
| Element Id | ValueSet.experimental | ||||||||||||||||
| Definition | A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | boolean | ||||||||||||||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set. | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | Allows filtering of value sets that are appropriate for use versus not. | ||||||||||||||||
| ValueSet.date | |||||||||||||||||
| Element Id | ValueSet.date | ||||||||||||||||
| Definition | The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition'). | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | dateTime | ||||||||||||||||
| Alternate Names | Revision Date | ||||||||||||||||
| Summary | true | ||||||||||||||||
| 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 or be found by consulting Provenances associated with past versions of the resource. | ||||||||||||||||
| ValueSet.publisher | |||||||||||||||||
| Element Id | ValueSet.publisher | ||||||||||||||||
| Definition | The name of the organization or individual that published the value set. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Requirements | Helps establish the "authority/credibility" of the value set. May also allow for contact. | ||||||||||||||||
| Summary | true | ||||||||||||||||
| 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. | ||||||||||||||||
| ValueSet.contact | |||||||||||||||||
| Element Id | ValueSet.contact | ||||||||||||||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | ContactDetail | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||||||
| ValueSet.description | |||||||||||||||||
| Element Id | ValueSet.description | ||||||||||||||||
| Definition | A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | markdown | ||||||||||||||||
| Alternate Names | Scope; Purpose | ||||||||||||||||
| Comments | 此元素与DomainResource.text中生成的叙述文字不同,它侧重于描述为什么创建此值域集、不适用场景、临床使用说明、文献参考、手工纸质使用的示例等详细信息。如果资源的上下文中不能获得以上信息,则应提供此元素。由于值域集中展开编码和值域集本身的语义是分离且会随着编码系统的语义变化,所以此元素不用于描述值域集的语义,而是用于描述其用途。这样,即使其模型在未来发生变更,此描述也可以确保其使用的完整性。大多数术语注册中心都要求值域集提供描述。 | ||||||||||||||||
| ValueSet.useContext | |||||||||||||||||
| Element Id | ValueSet.useContext | ||||||||||||||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | UsageContext | ||||||||||||||||
| Requirements | Assist in searching for appropriate content. | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||
| ValueSet.jurisdiction | |||||||||||||||||
| Element Id | ValueSet.jurisdiction | ||||||||||||||||
| Definition | 使用值域集的地理区域范围或法规约定的区域范围。 | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Terminology Binding | Jurisdiction (Extensible) | ||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 使用时可能会超出最初设计或打算使用的管辖范围。 | ||||||||||||||||
| ValueSet.immutable | |||||||||||||||||
| Element Id | ValueSet.immutable | ||||||||||||||||
| Definition | 如果设置为“true”,则无法创建内容逻辑定义的新版本,即不能更新其选择的值域内容或范围。但请注意,其他元数据是可以更新的。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | boolean | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 固定性的默认值设置为“false”。当其值设置为“true”时,此值域集可能只有一个版本。固定性在以下两种情况下通常设置为“true”:1)值域集的使用性质决定了不能对它进行变更。。2)由于安全原因,不方便使用ValueSet.purpose来描述其定义目的,就可以标记为固定,以免除发布者(或管理者)之外的其他人变更此值域集的内容。用于工作流控制的值域集必须保证同一URI的定义总是相同。 | ||||||||||||||||
| ValueSet.purpose | |||||||||||||||||
| Element Id | ValueSet.purpose | ||||||||||||||||
| Definition | 解释为什么需要此值域集,以及为什么它是如此设计的。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | markdown | ||||||||||||||||
| Comments | 此元素不是用于描述值域集的用法。相反,它强调“为什么”需要定义此资源和“为什么”这样定义。 它可用于追溯设计此资源结构的来源或规范。 | ||||||||||||||||
| ValueSet.copyright | |||||||||||||||||
| Element Id | ValueSet.copyright | ||||||||||||||||
| Definition | 此值域集及其相关内容的版权声明。版权声明通常是对此值域集的使用和发布的法律限制。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | markdown | ||||||||||||||||
| Requirements | 使用者必须能够确定值域集和其内容的使用符合其版权要求。 | ||||||||||||||||
| Alternate Names | License; Restrictions | ||||||||||||||||
| Comments | 值域集和其中包含的编码的版权通常是不同的。版权声明应在需要时明确区分这些内容。 | ||||||||||||||||
| ValueSet.compose | |||||||||||||||||
| Element Id | ValueSet.compose | ||||||||||||||||
| Definition | 通过从给定的编码系统中选择或排除编码到此该值域集中的一组用于定义值域集内容的条件。这也被称为内容逻辑定义(CLD)。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Alternate Names | Content Logical Definition; CLD | ||||||||||||||||
| ValueSet.compose.lockedDate | |||||||||||||||||
| Element Id | ValueSet.compose.lockedDate | ||||||||||||||||
| Definition | 此元素值填写内容逻辑定义(CLD)中所有引用的编码系统和值域集在尚未绑定到具体版本时的生效日期,用于将此值域集的展开结果固定在此日期不再改变。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | date | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 若定义了此元素,此值域集则被视为“已锁定”。否则,随着其依赖的编码系统或值域集的更新,此值域集的展开结果可能会跟随着变化。lockedDate的解释通常取决于上下文,例如,一个具有锁定日期的值域集内容选自SNOMED CT,它在美国和英国的展开结果是不同的。如果值域集在其include和exclude元素中指定了版本,同时又指定了锁定日期,则指定的版本需要在该日期可用,否则该值域集将不可用。 | ||||||||||||||||
| ValueSet.compose.inactive | |||||||||||||||||
| Element Id | ValueSet.compose.inactive | ||||||||||||||||
| Definition | 目前暂未批准使用的编码称为未激活编码。如果值域集中选取的编码是未激活的,那么是否将这些未激活编码包含在此值域中呢?此元素就是用来解决此问题的。如果inactive=true,则值域集展开结果中将包含未激活编码,反之则不包含。另外,也可通过$expand操作的activeOnly参数决定是否包含未激活编码。如果既不提供此元素又没指定activeOnly参数,则应视为要包含未激活编码。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | boolean | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments |
注意,在FHIR术语框架中,“deprecated”并不表示未激活,但是在一些编码系统中,例如LOINC,“deprecated”表示未激活。编码系统资源应通过CodeSystem.status定义其激活状态。如果没有明确定义,则假定所有编码都已激活。
值域集定义项目(VSD,Value Set Definition Project)的规范中定义了一个ActiveOnly元素,它与此元素正好相反,即(ValueSet.compose.inactive=FALSE)与(VSD.ActiveOnly=TRUE)意思相同。 | ||||||||||||||||
| ValueSet.compose.include | |||||||||||||||||
| Element Id | ValueSet.compose.include | ||||||||||||||||
| Definition | 定义包括在此值域集中的编码,它们都选自某些编码系统或其他值域集。 | ||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 包含编码的规则如下: 1、若声明了多个include元素,则意味着累加所有编码,即,值域集将选取所有include的并集。 2、在同一个include中定义的所有标准都需要同时满足,例如,选取多个筛选器结果的交集 3、在同一个include中,可以同时指定一个编码系统(可指定选择条件)和多个值域集。如果同时指定了System和ValueSet ,则选取编码系统中符合concept和filter标准的所有编码与所有值域集的所有编码的并集。 4、如果仅指定了ValueSet,则将所有指定的值域集中的所有编码都选取到此值域集中。 5、如果仅指定了System,则选取规则如下: 1)未指定concept或filter:包括编码系统中的所有编码 2)指定了concept::仅选取列举出来的具体编码 3)指定了filter: 选取所有符合筛选条件的编码 | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.compose.include.system | |||||||||||||||||
| Element Id | ValueSet.compose.include.system | ||||||||||||||||
| Definition | 所选取的编码来自哪个编码系统。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | uri | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 若未指定concept或filter,则包括编码系统中的所有编码。请注意,选取的编码集可能包含抽象编码。 | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.compose.include.version | |||||||||||||||||
| Element Id | ValueSet.compose.include.version | ||||||||||||||||
| Definition | 从编码系统的哪个版本中选择编码。若要同时选取所有版本的编码并集,可将此值设定为“*”。 | ||||||||||||||||
| Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 为避免不同版本的子级概念发生变更造成的影响,在选取子概念时可使用此元素。如果未指定版本,值域集的具体内容可以发生变更,除非能利用上下文语境判断值域集与编码系统特定版本的绑定关系。特殊值“*”表示所有版本;服务器可自行决定值域集的展开结果包含哪些版本的编码。 | ||||||||||||||||
| ValueSet.compose.include.concept | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept | ||||||||||||||||
| Definition | 此值域集包含编码系统中的哪些概念 | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Comments | 概念的列表按顺序落列,尽管顺序可能没有任何特殊意义。通常,展开结果的顺序遵循compose元素中定义的顺序。 | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.compose.include.concept.code | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept.code | ||||||||||||||||
| Definition | Specifies a code for the concept to be included or excluded. | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Type | code | ||||||||||||||||
| Comments | 如果底层编码系统定义了表达式,则允许在值域集中使用。 | ||||||||||||||||
| ValueSet.compose.include.concept.display | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept.display | ||||||||||||||||
| Definition | 在该值域集中为此概念向用户显示的文本。如果未提供值,则默认使用编码系统中的显示文本。 | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| 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. | ||||||||||||||||
| ValueSet.compose.include.concept.designation | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept.designation | ||||||||||||||||
| Definition | Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Comments | Concepts have both a | ||||||||||||||||
| ValueSet.compose.include.concept.designation.language | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept.designation.language | ||||||||||||||||
| Definition | The language this designation is defined for. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Terminology Binding | Common Languages (Preferred but limited to All Languages) | ||||||||||||||||
| Type | code | ||||||||||||||||
| Comments | In the absence of a language, the resource language applies. | ||||||||||||||||
| ValueSet.compose.include.concept.designation.use | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept.designation.use | ||||||||||||||||
| Definition | A code that represents types of uses of designations. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Terminology Binding | Designation Use (Extensible) | ||||||||||||||||
| Type | Coding | ||||||||||||||||
| Comments | If no use is provided, the designation can be assumed to be suitable for general display to a human user. | ||||||||||||||||
| ValueSet.compose.include.concept.designation.value | |||||||||||||||||
| Element Id | ValueSet.compose.include.concept.designation.value | ||||||||||||||||
| Definition | The text value for this designation. | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| ValueSet.compose.include.filter | |||||||||||||||||
| Element Id | ValueSet.compose.include.filter | ||||||||||||||||
| Definition | 通过指定匹配条件来选取概念。匹配条件是基于编码系统定义的属性(包括关系)或编码系统筛选器的。如果指定了多个值域集筛选器,则它们的匹配结果都必须为真。 | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 只有在底层编码系统定义了适当的属性时,才可以通过基于属性匹配的值域集筛选器来选取编码。注意,在某些情况下,底层编码系统定义的是逻辑抽你概念,而不是概念的文字编码。在这种情况下,其文字定义可以由第三方提供。 | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.compose.include.filter.property | |||||||||||||||||
| Element Id | ValueSet.compose.include.filter.property | ||||||||||||||||
| Definition | 用于标识编码系统中定义的属性或筛选器的编码。 | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Type | code | ||||||||||||||||
| Summary | true | ||||||||||||||||
| ValueSet.compose.include.filter.op | |||||||||||||||||
| Element Id | ValueSet.compose.include.filter.op | ||||||||||||||||
| Definition | The kind of operation to perform as a part of the filter criteria. | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Terminology Binding | FilterOperator (Required) | ||||||||||||||||
| Type | code | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | 如果filter.property代表的是编码系统的属性,则此运算类别将基于此属性而定。如果filter.property代表的是编码系统的筛选器,则此运算类别必须与CodeSystem.filter.operator元素值相同或其中之一(若有多个operator)。 | ||||||||||||||||
| ValueSet.compose.include.filter.value | |||||||||||||||||
| Element Id | ValueSet.compose.include.filter.value | ||||||||||||||||
| Definition | 此元素值是用于匹配的值,有以下几种情况: 1、此匹配值可以是由编码系统定义的编码。 2、如果filter.property代表的是编码系统的属性,则此匹配值可以是正则字符串值,用来匹配属性值。 3、如果filter.property代表的是编码系统的筛选器,当运算类别为“regex”时,此匹配值是编码系统筛选器的值。 4、当运算类别为“exists”时,则此匹配值为true或false。 | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example. | ||||||||||||||||
| ValueSet.compose.include.valueSet | |||||||||||||||||
| Element Id | ValueSet.compose.include.valueSet | ||||||||||||||||
| Definition | Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | canonical(ValueSet) | ||||||||||||||||
| Summary | true | ||||||||||||||||
| Comments | The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a direct reference to a value set definition using ValueSet.url. The reference might 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. | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.compose.exclude | |||||||||||||||||
| Element Id | ValueSet.compose.exclude | ||||||||||||||||
| Definition | Exclude one or more codes from the value set based on code system filters and/or other value sets. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | See ValueSet.compose.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. | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.expansion | |||||||||||||||||
| Element Id | ValueSet.expansion | ||||||||||||||||
| Definition | A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Comments | Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance. Expansion.parameter is a simplified list of parameters - a subset of the features of the Parameters resource. | ||||||||||||||||
| ValueSet.expansion.identifier | |||||||||||||||||
| Element Id | ValueSet.expansion.identifier | ||||||||||||||||
| Definition | An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier. | ||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | uri | ||||||||||||||||
| Comments | Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd). | ||||||||||||||||
| ValueSet.expansion.timestamp | |||||||||||||||||
| Element Id | ValueSet.expansion.timestamp | ||||||||||||||||
| Definition | The time at which the expansion was produced by the expanding system. | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Type | dateTime | ||||||||||||||||
| 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. | ||||||||||||||||
| ValueSet.expansion.total | |||||||||||||||||
| Element Id | ValueSet.expansion.total | ||||||||||||||||
| Definition | The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | integer | ||||||||||||||||
| Comments | Paging only applies to flat expansions. | ||||||||||||||||
| ValueSet.expansion.offset | |||||||||||||||||
| Element Id | ValueSet.expansion.offset | ||||||||||||||||
| Definition | If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | integer | ||||||||||||||||
| Meaning if Missing | Paging is not being used | ||||||||||||||||
| 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. | ||||||||||||||||
| ValueSet.expansion.parameter | |||||||||||||||||
| Element Id | ValueSet.expansion.parameter | ||||||||||||||||
| Definition | A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Comments | The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version). | ||||||||||||||||
| ValueSet.expansion.parameter.name | |||||||||||||||||
| Element Id | ValueSet.expansion.parameter.name | ||||||||||||||||
| Definition | Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process. | ||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Comments | The names are assigned at the discretion of the server. | ||||||||||||||||
| ValueSet.expansion.parameter.value[x] | |||||||||||||||||
| Element Id | ValueSet.expansion.parameter.value[x] | ||||||||||||||||
| Definition | The value of the parameter. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string|boolean|integer|decimal|uri|code|dateTime | ||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||
| ValueSet.expansion.contains | |||||||||||||||||
| Element Id | ValueSet.expansion.contains | ||||||||||||||||
| Definition | The codes that are contained in the value set expansion. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.expansion.contains.system | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.system | ||||||||||||||||
| Definition | An absolute URI which is the code system in which the code for this item in the expansion is defined. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | uri | ||||||||||||||||
| ValueSet.expansion.contains.abstract | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.abstract | ||||||||||||||||
| Definition | If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | boolean | ||||||||||||||||
| Meaning if Missing | If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts | ||||||||||||||||
| 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. | ||||||||||||||||
| ValueSet.expansion.contains.inactive | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.inactive | ||||||||||||||||
| Definition | If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use). | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | boolean | ||||||||||||||||
| Comments | This should only have a value if the concept is inactive. | ||||||||||||||||
| ValueSet.expansion.contains.version | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.version | ||||||||||||||||
| Definition | The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||||||||||||||
| Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Comments | The exact value of the version string is specified by the system from which the code is derived. | ||||||||||||||||
| ValueSet.expansion.contains.code | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.code | ||||||||||||||||
| Definition | The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | code | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.expansion.contains.display | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.display | ||||||||||||||||
| Definition | The recommended display for this item in the expansion. | ||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||
| Type | string | ||||||||||||||||
| Invariants |
| ||||||||||||||||
| ValueSet.expansion.contains.designation | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.designation | ||||||||||||||||
| Definition | Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | See ValueSet.compose.include.concept.designation | ||||||||||||||||
| Comments | The designations provided must be based on the value set and code system definitions. | ||||||||||||||||
| ValueSet.expansion.contains.contains | |||||||||||||||||
| Element Id | ValueSet.expansion.contains.contains | ||||||||||||||||
| Definition | Other codes and entries contained under this entry in the hierarchy. | ||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||
| Type | See ValueSet.expansion.contains | ||||||||||||||||
| 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. | ||||||||||||||||