| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
| I | DomainResource | A set of codes drawn from one or more code systems A defined code system (if present) SHALL have a different identifier to the value set itself Value set SHALL contain at least one of a codeSystem, a compose, or an expansion element A value set with only one import SHALL also have an include and/or an exclude unless the value set includes and inline code system | ||
| Σ | 0..1 | uri | Globally unique logical id for value set | |
| Σ | 0..1 | Identifier | Additional identifier for the value set (v2 / CDA) | |
| Σ | 0..1 | string | Logical id for this version of the value set | |
| Σ | 0..1 | string | Informal name for this value set | |
| ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) | |
| Σ | 0..1 | boolean | If for testing purposes, not real usage | |
| Σ | 0..1 | string | Name of the publisher (Organization or individual) | |
| Σ | 0..* | BackboneElement | Contact details of the publisher | |
| Σ | 0..1 | string | Name of a individual to contact | |
| Σ | 0..* | ContactPoint | Contact details for individual or publisher | |
| Σ | 0..1 | dateTime | Date for given status | |
| Σ | 0..1 | date | Fixed date for all referenced code systems and value sets | |
| Σ | 0..1 | string | Human language description of the value set | |
| Σ | 0..* | CodeableConcept | Content intends to support these contexts Context of Use ValueSet (Extensible) | |
| Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | |
| 0..1 | string | Why is this needed? | ||
| 0..1 | string | Use and/or Publishing restrictions | ||
| Σ | 0..1 | boolean | Whether this is intended to be used with an extensible binding | |
| Σ I | 0..1 | BackboneElement | An inline code system - part of this value set Codes must be unique Within a code system definition, all the codes SHALL be unique | |
| Σ | 1..1 | uri | URI to identify the code system (e.g. in Coding.system) | |
| Σ | 0..1 | string | Version (for use in Coding.version) | |
| Σ | 0..1 | boolean | If code comparison is case sensitive | |
| 1..* | BackboneElement | Concepts in the code system | ||
| 1..1 | code | Code that identifies concept | ||
| 0..1 | boolean | If this code is not for use as a real concept | ||
| 0..1 | string | Text to Display to the user | ||
| 0..1 | string | Formal Definition | ||
| 0..* | BackboneElement | Additional representations for the concept | ||
| 0..1 | code | Human language of the designation Language (Required) | ||
| 0..1 | Coding | Details how this designation would be used Designation Use (Extensible) | ||
| 1..1 | string | The text value for this designation | ||
| 0..* | see concept | Child Concepts (is-a / contains / categorises) | ||
| I | 0..1 | BackboneElement | When value set includes codes from elsewhere A value set composition SHALL have an include or an import | |
| Σ I | 0..* | uri | Import the contents of another value set | |
| Σ I | 0..* | BackboneElement | Include one or more codes from a code system Cannot have both concept and filter | |
| Σ | 1..1 | uri | The system the codes come from | |
| Σ | 0..1 | string | Specific version of the code system referred to | |
| I | 0..* | BackboneElement | A concept defined in the system | |
| 1..1 | code | Code or expression from system | ||
| 0..1 | string | Test to display for this code for this value set | ||
| 0..* | see designation | Additional representations for this valueset | ||
| I | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | |
| 1..1 | code | A property defined by the code system | ||
| 1..1 | code | = | is-a | is-not-a | regex | in | not-in FilterOperator (Required) | ||
| 1..1 | code | Code from the system, or regex criteria | ||
| I | 0..* | see include | Explicitly exclude codes | |
| I | 0..1 | BackboneElement | Used when the value set is "expanded" | |
| 1..1 | uri | Uniquely identifies this expansion | ||
| 1..1 | dateTime | Time valueset expansion happened | ||
| 0..1 | integer | Total number of codes in the expansion | ||
| 0..1 | integer | Offset at which this resource starts | ||
| 0..* | BackboneElement | Parameter that controlled the expansion process | ||
| 1..1 | string | Name as assigned by server | ||
| 0..1 | Value of the named parameter | |||
| string | ||||
| boolean | ||||
| integer | ||||
| decimal | ||||
| uri | ||||
| code | ||||
| I | 0..* | BackboneElement | Codes in the value set Must have a code if not abstract SHALL have a code or a display Must have a system if a code is present | |
| 0..1 | uri | System value for the code | ||
| 0..1 | boolean | If user cannot select this entry | ||
| 0..1 | string | Version in which this code / display is defined | ||
| I | 0..1 | code | Code - if blank, this is not a choosable code | |
| I | 0..1 | string | User display for the concept | |
| 0..* | see contains | Codes contained under this entry | ||
Documentation for this format | ||||