The formal definitions for the elements in the valueset resource. Also available as an XML file.
| ValueSet |
| Definition | Value Set - a set of defined codes from one or more code systems that may be bound to a context |
| Control | 1..1 |
| RIM Mapping | N/A |
| ValueSet.name |
| Definition | A free text natural language name describing the value set |
| Control | 1..1 |
| Type | string |
| Requirements | Support human navigation |
| Comments | Not expected to be unique |
| RIM Mapping | N/A |
| ValueSet.author |
| Definition | Details of the author who accepts responsibility for publishing the value set |
| Control | 1..1 |
| Requirements | Identifies responsibility |
| Comments | Usually an organisation, but may be an individual |
| RIM Mapping | N/A |
| ValueSet.author.name |
| Definition | The name of the author |
| Control | 1..1 |
| Type | string |
| RIM Mapping | N/A |
| ValueSet.author.reference |
| Definition | Some way of reaching or finding the author. |
| Control | 0..1 |
| Type | uri |
| Requirements | Allow a user to find and communicate with the author |
| Comments | May be a web site, an email address, a telephone number |
| RIM Mapping | N/A |
| ValueSet.description |
| Definition | A free text natural language description of the value set - contents, reason for definition, conditions of use, etc. |
| Control | 1..1 |
| Type | string |
| Requirements | Human understandibility |
| RIM Mapping | N/A |
| ValueSet.status |
| Definition | The status of the value set |
| Control | 1..1 |
| Type | code from ValueSetStatus |
| Must Understand | true |
| Requirements | Identify when/if the value set should be used. |
| RIM Mapping | N/A |
| ValueSet.date |
| Definition | The date that the value set status was last changed |
| Control | 1..1 |
| Type | dateTime |
| Requirements | Need to know when a value set was first legal for use or became withdrawn or replaced. |
| 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 |
| RIM Mapping | N/A |
| ValueSet.identifier |
| Definition | The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance |
| Control | 1..1 |
| Type | id |
| Comments | There may be multiple versions of the value set that have this same identifier |
| RIM Mapping | N/A |
| 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 |
| Control | 1..1 |
| Type | id |
| RIM Mapping | N/A |
| ValueSet.restricts |
| Definition | An assertion that this value set is a restriction on another value set - that it only includes codes that are part of the other value set. The value set itself must ensure that this is true - the contents of the value set are not automatically bounded by the contents of any value set identified here. This allows profile tooling to reason about the relationships between value sets without having to determine the value set contents |
| Control | 0..* |
| Type | uri |
| Comments | In most cases, the claim of restriction could be validated in a particular context of use, but it is not necessary to do so |
| RIM Mapping | N/A |
| ValueSet.import |
| Definition | Includes the contents of the referenced value set as part of the contents of this value set |
| Control | 0..* |
| Type | uri |
| RIM Mapping | N/A |
| ValueSet.include |
| Definition | Include one or more codes from a code system |
| Control | 0..* |
| RIM Mapping | N/A |
| ValueSet.include.system |
| Definition | The code system from which the selected codes come from |
| Control | 1..1 |
| Type | uri |
| Comments | See [[Coding.system]] for further documentation |
| RIM Mapping | N/A |
| ValueSet.include.version |
| Definition | The version of the code system that the codes are selected from |
| Control | 0..1 |
| Type | string |
| Comments | This is used when selecting the descendents 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 |
| RIM Mapping | N/A |
| ValueSet.include.mode |
| Definition | The mode of selection - whether the code itself, and/or its descendants are being selected |
| Control | 1..1 |
| Type | code from CodeSelectionMode |
| Comments | It is an error to include codes that are marked "abstract" in a value set that is used directly in a specification, but not an error to include an abstract code in a value set not destined for this use |
| RIM Mapping | N/A |
| ValueSet.include.code |
| Definition | Specifies a code or concept to be included or excluded as specified by the mode from the value set |
| Control | 0..* |
| Type | code from ! |
| Comments | expressions are allowed if defined by the underlying code system |
| RIM Mapping | N/A |
| ValueSet.include.filter |
| Definition | Select concepts by specify a matching criteria based on the properties defined by the system. If multiple filters are specified, they must all be true |
| Control | 0..* |
| 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 |
| RIM Mapping | N/A |
| ValueSet.include.filter.property |
| Definition | A code that identifies a property defined in the code system |
| Control | 1..1 |
| Type | code from ! |
| RIM Mapping | N/A |
| ValueSet.include.filter.op |
| Definition | The kind of operation to perform as part of the filter criteria |
| Control | 1..1 |
| Type | code from FilterOperator |
| RIM Mapping | N/A |
| ValueSet.include.filter.value |
| Definition | The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value |
| Control | 1..1 |
| Type | code from ! |
| Comments | Use regex matching with care - full regex matching on every SNOMED-CT term is prohibitive, for example |
| RIM Mapping | N/A |
| ValueSet.exclude |
| Definition | Exclude one or more codes from the value set |
| Control | 0..* |
| Type | @ValueSet.include |
| Comments | usually this is used to selectively exclude codes that were included by subsumption in the inclusions |
| RIM Mapping | N/A |
| ValueSet.extension |
| Definition | See Extensions |
| Control | 0..* |
| Type | Extension |
| RIM Mapping | N/A |
| ValueSet.text |
| Definition | Text summary of resource (for human interpretation) |
| Control | 1..1 |
| Type | Narrative |
| RIM Mapping | N/A |
. Page versions: R5 R4B R4 R3 R2
This is an old version of FHIR retained for archive purposes. Do not use for anything else