R4 Ballot #1 (Mixed Normative/Trial use) Current Build
This page was published as part of FHIR v3.3.0: R4 Ballot #1 : Mixed Normative/Trial use (First Normative ballot). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .
Vocabulary Work Group Maturity Level : 5 N   Normative (from v4.1.0) Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the ValueSet resource.

Invariants Affect this element vsd-11 : Status must = 'active' if expansion is present and compose is absent ( expression : status='active' or compose.exists() or expansion.empty(), xpath: f:status/@value='active' or exists(f:compose) or not(exists(f:expansion)) Standards Status This element has a standards status of "Trial Use" which is different to the status of the whole resource Invariants Affect this element vsd-5 : Value set SHALL contain at least one of a compose or an expansion element ( expression : compose.exists() or expansion.exists(), xpath: exists(f:compose) or exists(f:expansion)) vsd-11 : Status must = 'active' if expansion is present and compose is absent ( expression : status='active' or compose.exists() or expansion.empty(), xpath: f:status/@value='active' or exists(f:compose) or not(exists(f:expansion))
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 .

Control Cardinality 1..1 0..*
Type DomainResource
Invariants : status='active' or compose.exists() or expansion.empty(), xpath: f:status/@value='active' or exists(f:compose) or not(exists(f:expansion))
Defined on this element vsd-11 : Status must = 'active' if expansion is present and compose is absent ( expression
vsd-5 : Value set SHALL contain at least one of a compose or vsd-0 Warning Name should be usable as an expansion element ( expression identifier for the module by machine processing applications such as code generation : compose.exists() or expansion.exists(), xpath: exists(f:compose) or exists(f:expansion)) name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
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.

Control 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 URL SHOULD include the major determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the value set. For more information see 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 identifer, identifier, not a resource identifier (see discussion )
Control 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 )
Control 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.

Control 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 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
Affect this element
inv-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ValueSet.title
Element Id ValueSet.title
Definition

A short, descriptive, user-friendly title for the value set.

Control 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

The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.

Control Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: null) 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. 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.

Control Cardinality 0..1
Type boolean
Is Modifier true (Reason: null) 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 published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. created or revised (e.g. the 'content logical definition').

Control 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.

Control 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.

Control 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.

Control Cardinality 0..1
Type markdown
Alternate Names Scope; Purpose
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 value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile value set is presumed to be the predominant language in the place the profile value set was created). The created).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.

ValueSet.useContext
Element Id ValueSet.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms 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.

Control 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

A legal or geographic region in which the value set is intended to be used.

Control Cardinality 0..*
Terminology Binding Jurisdiction ValueSet ( Extensible )
Type CodeableConcept
Summary true
Comments

It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.

ValueSet.immutable
Element Id ValueSet.immutable
Definition

If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

Control Cardinality 0..1
Type boolean
Summary true
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.

ValueSet.purpose
Element Id ValueSet.purpose
Definition

Explanation of why this value set is needed and why it has been designed as it has.

Control Cardinality 0..1
Type markdown
Comments

This element does not describe the usage of the value set. Instead, it provides 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.

ValueSet.copyright
Element Id ValueSet.copyright
Definition

A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.

Control Cardinality 0..1
Type markdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.

Alternate Names License; Restrictions
Comments

null Frequently, nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.

ValueSet.extensible Element Id ValueSet.extensible Definition Whether this is intended to be used with an extensible binding or not. Control 0..1 Type boolean Requirements It is not required to say whether this intent applies. Summary true ValueSet.compose
Element Id ValueSet.compose
Definition

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

Control Cardinality 0..1
Alternate Names Content Logical Definition; CLD
ValueSet.compose.lockedDate
Element Id ValueSet.compose.lockedDate
Definition

If a locked date The Locked Date is defined, then the Content Logical Definition must be evaluated using effective date that is used to determine the current version as of the locked date for all referenced code system(s) Code Systems and value set instances where ValueSet.compose.include.version is Value Set Definitions included in the compose that are not defined. already tied to a specific version.

Control Cardinality 0..1
Type date
Summary true
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.

ValueSet.compose.inactive
Element Id ValueSet.compose.inactive
Definition

Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable ExpansionProfile $expand parameters (but generally, inactive codes would be expected to be included).

Control Cardinality 0..1
Type boolean
Summary true
Comments

Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems (e.g. systems, e.g. LOINC, deprecated means inactive). "deprecated" does mean 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.

The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).

ValueSet.compose.include
Element Id ValueSet.compose.include
Definition

Include one or more codes from a code system or other value set(s).

Control Cardinality 1..*
Summary true
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'.

Invariants
Defined on this element
vsd-1 : Rule A value set include/exclude SHALL have a value set or a system ( expression : valueSet.exists() or system.exists(), xpath: exists(f:valueSet) or exists(f:system)) system.exists()
vsd-2 : Rule A value set with concepts or filters SHALL include a system ( expression : (concept.exists() or filter.exists()) implies system.exists(), xpath: not(exists(f:concept) or exists(f:filter)) or exists(f:system)) system.exists()
vsd-3 : Rule Cannot have both concept and filter ( expression : concept.empty() or filter.empty(), xpath: not(exists(f:concept)) or not(exists(f:filter))) filter.empty()
ValueSet.compose.include.system
Element Id ValueSet.compose.include.system
Definition

An absolute URI which is the code system from which the selected codes come from.

Control Cardinality 0..1
Type uri
Summary true
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.

Invariants
Affect this element
vsd-1 : Rule A value set include/exclude SHALL have a value set or a system ( expression : valueSet.exists() or system.exists(), xpath: exists(f:valueSet) or exists(f:system)) system.exists()
vsd-2 : Rule A value set with concepts or filters SHALL include a system ( expression : (concept.exists() or filter.exists()) implies system.exists(), xpath: not(exists(f:concept) or exists(f:filter)) or exists(f:system)) system.exists()
ValueSet.compose.include.version
Element Id ValueSet.compose.include.version
Definition

The version of the code system that the codes are selected from. from, or the special version '*' for all versions.

Note This is a business versionId, not a resource version id (see discussion )
Control Cardinality 0..1
Type string
Summary true
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 might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.

ValueSet.compose.include.concept
Element Id ValueSet.compose.include.concept
Definition

Specifies a concept to be included or excluded.

Control Cardinality 0..*
Comments

The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.

Invariants
Affect this element
vsd-3 : Rule Cannot have both concept and filter ( expression : concept.empty() or filter.empty(), xpath: not(exists(f:concept)) or not(exists(f:filter))) filter.empty()
ValueSet.compose.include.concept.code
Element Id ValueSet.compose.include.concept.code
Definition

Specifies a code for the concept to be included or excluded.

Control Cardinality 1..1
Type code
Comments

Expressions are allowed if defined by the underlying code system.

ValueSet.compose.include.concept.display
Element Id ValueSet.compose.include.concept.display
Definition

The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.

Control 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.

Control Cardinality 0..*
Comments

Concepts have both a display and an array of designation . The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language .

ValueSet.compose.include.concept.designation.language
Element Id ValueSet.compose.include.concept.designation.language
Definition

The language this designation is defined for.

Control Cardinality 0..1
Terminology Binding Common Languages ( Extensible 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 details how this designation would be used. represents types of uses of designations.

Control 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.

Control Cardinality 1..1
Type string
ValueSet.compose.include.filter
Element Id ValueSet.compose.include.filter
Definition

Select concepts by specify a matching criteria criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.

Control Cardinality 0..*
Summary true
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.

Invariants
Affect this element
vsd-3 : Rule Cannot have both concept and filter ( expression : concept.empty() or filter.empty(), xpath: not(exists(f:concept)) or not(exists(f:filter))) filter.empty()
ValueSet.compose.include.filter.property
Element Id ValueSet.compose.include.filter.property
Definition

A code that identifies a property or a filter defined in the code system.

Control 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.

Control Cardinality 1..1
Terminology Binding FilterOperator ( Required )
Type code
Summary true
Comments

In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values.

ValueSet.compose.include.filter.value
Element Id ValueSet.compose.include.filter.value
Definition

The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.

Control 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.

Control 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
Affect this element
vsd-1 : Rule A value set include/exclude SHALL have a value set or a system ( expression : valueSet.exists() or system.exists(), xpath: exists(f:valueSet) or exists(f:system)) system.exists()
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.

Control 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
Affect this element
vsd-2 : Rule A value set with concepts or filters SHALL include a system ( expression : (concept.exists() or filter.exists()) implies system.exists(), xpath: not(exists(f:concept) or exists(f:filter)) or exists(f:system)) system.exists()
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.

Control Cardinality 0..1
Comments

Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Invariants Affect this element vsd-5 : Value set SHALL contain at least one expansions are always considered to be stateless - they are a record of the set of codes in the value set at a compose or an expansion element ( expression : compose.exists() or expansion.exists(), xpath: exists(f:compose) or exists(f:expansion)) vsd-11 : Status must = 'active' if expansion is present point in time under a given set of conditions, and compose are not subject to ongoing maintenance.

Expansion.parameter is absent ( expression : status='active' or compose.exists() or expansion.empty(), xpath: f:status/@value='active' or exists(f:compose) or not(exists(f:expansion)) 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. 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 expansion same, and the definition remain expansion is the same, but are not required to do so. This is a business identifier.

Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control 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.

Control 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.

Control 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 NOT be present.

Control 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.

Control Cardinality 0..*
Comments

The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the date, filter, and profile parameters passed to that affect the $expand operation (if any). 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

The name Name of the parameter. 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.

Control 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.

Control 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.

Control Cardinality 0..*
Invariants : code.empty() or system.exists(), xpath: exists(f:system) or not(exists(f:code)))
Defined on this element vsd-10 : Must have a system if a code is present ( expression
vsd-6 : Rule SHALL have a code or a display ( expression : code.exists() or display.exists(), xpath: exists(f:code) or exists(f:display)) display.exists()
vsd-9 : Rule Must have a code if not abstract ( expression : code.exists() or abstract = true, xpath: exists(f:code) true
vsd-10 Rule Must have a system if a code is present code.empty() or (f:abstract/@value = true())) system.exists()
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.

Control 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.

Control 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).

Control 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 this the code system that defined from this code and/or display. This should only be used with code systems was taken. Note that do a well-maintained code system does not enforce concept permanence. 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 )
Control 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.

Control Cardinality 0..1
Type code
Invariants
Affect this element
vsd-6 : Rule SHALL have a code or a display ( expression : code.exists() or display.exists(), xpath: exists(f:code) or exists(f:display)) display.exists()
ValueSet.expansion.contains.display
Element Id ValueSet.expansion.contains.display
Definition

The recommended display for this item in the expansion.

Control Cardinality 0..1
Type string
Invariants
Affect this element
vsd-6 : Rule SHALL have a code or a display ( expression : code.exists() or display.exists(), xpath: exists(f:code) or exists(f:display)) display.exists()
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.

Control 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.

Control 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.