Resources
ValueSet
Resources
ValueSet
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.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| url | No | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
| identifier | No | Identifier[] | Additional identifier for the value set (business identifier) |
| version | No | string | Business version of the value set |
| name | No | string | Name for this value set (computer friendly) |
| title | No | string | Name for this value set (human friendly) |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the value set |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for value set (if applicable) |
| immutable | No | boolean | Indicates whether or not any change to the content logical definition may occur |
| purpose | No | markdown | Why this value set is defined |
| copyright | No | markdown | Use and/or publishing restrictions |
| compose | No | ValueSetCompose | Content logical definition of the value set (CLD) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - lockedDate | No | date | Fixed date for references with no specified version (transitive) |
| - inactive | No | boolean | Whether inactive codes are in the value set |
| - include | Yes | ValueSetComposeInclude | Include one or more codes from a code system or other value set(s) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - system | No | uri | The system the codes come from |
| - version | No | string | Specific version of the code system referred to |
| - concept | No | ValueSetComposeIncludeConcept | A concept defined in the system |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - code | Yes | code | Code or expression from system |
| - display | No | string | Text to display for this code for this value set in this valueset |
| - designation | No | ValueSetComposeIncludeConceptDesignation | Additional representations for this concept |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - language | No | code | Human language of the designation |
| - use | No | Coding | Types of uses of designations |
| - value | Yes | string | The text value for this designation |
| - filter | No | ValueSetComposeIncludeFilter | Select codes/concepts by their properties (including relationships) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - property | Yes | code | A property/filter defined by the code system |
| - op | Yes | code | = / is-a / descendent-of / is-not-a / regex / in / not-in / generalizes / exists |
| - value | Yes | string | Code from the system, or regex criteria, or boolean value for exists |
| - valueSet | No | canonical[] | Select the contents included in this value set |
| - exclude | No | [] | Explicitly exclude codes from a code system or other value sets |
| expansion | No | ValueSetExpansion | Used when the value set is “expanded” |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - identifier | No | uri | Identifies the value set expansion (business identifier) |
| - timestamp | Yes | dateTime | Time ValueSet expansion happened |
| - total | No | integer | Total number of codes in the expansion |
| - offset | No | integer | Offset at which this resource starts |
| - parameter | No | ValueSetExpansionParameter | Parameter that controlled the expansion process |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | string | Name as assigned by the client or server |
| - value[x] | No | string, boolean, integer, decimal, uri, code, dateTime | Value of the named parameter |
| - contains | No | ValueSetExpansionContains | Codes in the value set |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - system | No | uri | System value for the code |
| - abstract | No | boolean | If user cannot select this entry |
| - inactive | No | boolean | If concept is inactive in the code system |
| - version | No | string | Version in which this code/display is defined |
| - code | No | code | Code - if blank, this is not a selectable code |
| - display | No | string | User display for the concept |
| - designation | No | [] | Additional representations for this item |
| - contains | No | [] | Codes contained under this entry |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| context | token | A use context assigned to the value set | ValueSet.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the value set | ValueSet.useContext.value |
| context-type | token | A type of use context assigned to the value set | ValueSet.useContext.code |
| date | date | The value set publication date | ValueSet.date |
| description | string | The description of the value set | ValueSet.description |
| jurisdiction | token | Intended jurisdiction for the value set | ValueSet.jurisdiction |
| name | string | Computationally friendly name of the value set | ValueSet.name |
| publisher | string | Name of the publisher of the value set | ValueSet.publisher |
| status | token | The current status of the value set | ValueSet.status |
| title | string | The human-friendly name of the value set | ValueSet.title |
| url | uri | The uri that identifies the value set | ValueSet.url |
| version | token | The business version of the value set | ValueSet.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the value set | ValueSet.useContext |
| context-type-value | composite | A use context type and value assigned to the value set | ValueSet.useContext |
| identifier | token | External identifier for the value set | ValueSet.identifier |
| code | token | This special parameter searches for codes in the value set. See additional notes on the ValueSet resource | ValueSet.expansion.contains.code |
| expansion | uri | Identifies the value set expansion (business identifier) | ValueSet.expansion.identifier |
| reference | uri | A code system included or excluded in the value set or an imported value set | ValueSet.compose.include.system |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see ValueSet.