Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1

Publication Build: This will be filled in by the publication tooling

## Resource Profile: CRMI Expanded ValueSet

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-expandedvalueset | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIExpandedValueSet
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.26

Defines an expanded value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an expanded value set, a computable definition of the value set must be obtained to compute the updated expansion.

Usage:

- Examples for this Resource Profile: DangersignsCodesGrouperExpanded

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from ValueSet

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet |  | 1..1 | ValueSet | A set of codes drawn from one or more code systems
Slices for extension |  |  |  | Content/Rules for all slices
usageWarning | S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
value[x] | S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
expansion | S C | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
identifier | S | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp | S | 1..1 | dateTime | Time ValueSet expansion happened
total | S | 0..1 | integer | Total number of codes in the expansion
offset | S | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
contains | S | 0..* | BackboneElement | Codes in the value set
system | S | 0..1 | uri | System value for the code
abstract | S | 0..1 | boolean | If user cannot select this entry
inactive | S | 0..1 | boolean | If concept is inactive in the code system
version | S C | 0..1 | string | Version in which this code/display is defined
code | S | 1..1 | code | Code - if blank, this is not a selectable code
display | S | 0..1 | string | User display for the concept
contains | S | 0..* |  | Codes contained under this entry
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | ValueSet | A set of codes drawn from one or more code systems vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
usageWarning | S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning"
value[x] | S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
expansion | S C | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | S | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp | S | 1..1 | dateTime | Time ValueSet expansion happened
total | S | 0..1 | integer | Total number of codes in the expansion
offset | S | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
contains | S C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | S | 0..1 | uri | System value for the code
abstract | S | 0..1 | boolean | If user cannot select this entry
inactive | S | 0..1 | boolean | If concept is inactive in the code system
version | S C | 0..1 | string | Version in which this code/display is defined
code | S C | 1..1 | code | Code - if blank, this is not a selectable code
display | S C | 0..1 | string | User display for the concept
contains | S | 0..* | See contains (ValueSet) | Codes contained under this entry
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ValueSet.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | ValueSet | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vsd-0 | warning | ValueSet | 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}') |
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() |
vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true |
vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | ValueSet | A set of codes drawn from one or more code systems vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
usageWarning | S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning"
value[x] | S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique)
identifier | Σ | 0..* | Identifier | Additional identifier for the value set (business identifier)
version | Σ | 0..1 | string | Business version of the value set
name | Σ C | 0..1 | string | Name for this value set (computer friendly)
title | Σ | 0..1 | string | Name for this value set (human friendly)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description |  | 0..1 | markdown | Natural language description of the value set
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur
purpose |  | 0..1 | markdown | Why this value set is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
compose |  | 0..1 | BackboneElement | Content logical definition of the value set (CLD)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive)
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | Σ C | 0..1 | uri | The system the codes come from
version | Σ | 0..1 | string | Specific version of the code system referred to
concept | C | 0..* | BackboneElement | A concept defined in the system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Code or expression from system
display |  | 0..1 | string | Text to display for this code for this value set in this valueset
designation |  | 0..* | BackboneElement | Additional representations for this concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
use |  | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
filter | Σ C | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
property | Σ | 1..1 | code | A property/filter defined by the code system
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists
valueSet | Σ C | 0..* | canonical(ValueSet) | Select the contents included in this value set
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets
expansion | S C | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | S | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp | S | 1..1 | dateTime | Time ValueSet expansion happened
total | S | 0..1 | integer | Total number of codes in the expansion
offset | S | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
value[x] |  | 0..1 |  | Value of the named parameter
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueDecimal |  |  | decimal |
valueUri |  |  | uri |
valueCode |  |  | code |
valueDateTime |  |  | dateTime |
contains | S C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | S | 0..1 | uri | System value for the code
abstract | S | 0..1 | boolean | If user cannot select this entry
inactive | S | 0..1 | boolean | If concept is inactive in the code system
version | S C | 0..1 | string | Version in which this code/display is defined
code | S C | 1..1 | code | Code - if blank, this is not a selectable code
display | S C | 0..1 | string | User display for the concept
designation |  | 0..* | See designation (ValueSet) | Additional representations for this item
contains | S | 0..* | See contains (ValueSet) | Codes contained under this entry
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ValueSet.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
ValueSet.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` from the FHIR Standard
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet `http://hl7.org/fhir/ValueSet/jurisdiction` from the FHIR Standard
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse `http://hl7.org/fhir/ValueSet/designation-use` from the FHIR Standard
ValueSet.compose.include.filter.op | required | FilterOperator `http://hl7.org/fhir/ValueSet/filter-operator|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | ValueSet | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vsd-0 | warning | ValueSet | 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}') |
vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() |
vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() |
vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() |
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() |
vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true |
vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |

This structure is derived from ValueSet

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 16 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/valueset-warning

Maturity: 3

Differential View

This structure is derived from ValueSet

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet |  | 1..1 | ValueSet | A set of codes drawn from one or more code systems
Slices for extension |  |  |  | Content/Rules for all slices
usageWarning | S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
value[x] | S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
expansion | S C | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
identifier | S | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp | S | 1..1 | dateTime | Time ValueSet expansion happened
total | S | 0..1 | integer | Total number of codes in the expansion
offset | S | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
contains | S | 0..* | BackboneElement | Codes in the value set
system | S | 0..1 | uri | System value for the code
abstract | S | 0..1 | boolean | If user cannot select this entry
inactive | S | 0..1 | boolean | If concept is inactive in the code system
version | S C | 0..1 | string | Version in which this code/display is defined
code | S | 1..1 | code | Code - if blank, this is not a selectable code
display | S | 0..1 | string | User display for the concept
contains | S | 0..* |  | Codes contained under this entry
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | ValueSet | A set of codes drawn from one or more code systems vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
usageWarning | S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning"
value[x] | S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
expansion | S C | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | S | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp | S | 1..1 | dateTime | Time ValueSet expansion happened
total | S | 0..1 | integer | Total number of codes in the expansion
offset | S | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
contains | S C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | S | 0..1 | uri | System value for the code
abstract | S | 0..1 | boolean | If user cannot select this entry
inactive | S | 0..1 | boolean | If concept is inactive in the code system
version | S C | 0..1 | string | Version in which this code/display is defined
code | S C | 1..1 | code | Code - if blank, this is not a selectable code
display | S C | 0..1 | string | User display for the concept
contains | S | 0..* | See contains (ValueSet) | Codes contained under this entry
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ValueSet.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | ValueSet | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vsd-0 | warning | ValueSet | 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}') |
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() |
vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true |
vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ValueSet | C | 1..1 | ValueSet | A set of codes drawn from one or more code systems vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
usageWarning | S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning"
value[x] | S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique)
identifier | Σ | 0..* | Identifier | Additional identifier for the value set (business identifier)
version | Σ | 0..1 | string | Business version of the value set
name | Σ C | 0..1 | string | Name for this value set (computer friendly)
title | Σ | 0..1 | string | Name for this value set (human friendly)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description |  | 0..1 | markdown | Natural language description of the value set
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur
purpose |  | 0..1 | markdown | Why this value set is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
compose |  | 0..1 | BackboneElement | Content logical definition of the value set (CLD)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive)
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | Σ C | 0..1 | uri | The system the codes come from
version | Σ | 0..1 | string | Specific version of the code system referred to
concept | C | 0..* | BackboneElement | A concept defined in the system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Code or expression from system
display |  | 0..1 | string | Text to display for this code for this value set in this valueset
designation |  | 0..* | BackboneElement | Additional representations for this concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
use |  | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
filter | Σ C | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
property | Σ | 1..1 | code | A property/filter defined by the code system
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists
valueSet | Σ C | 0..* | canonical(ValueSet) | Select the contents included in this value set
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets
expansion | S C | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | S | 0..1 | uri | Identifies the value set expansion (business identifier)
timestamp | S | 1..1 | dateTime | Time ValueSet expansion happened
total | S | 0..1 | integer | Total number of codes in the expansion
offset | S | 0..1 | integer | Offset at which this resource starts
parameter | S | 0..* | BackboneElement | Parameter that controlled the expansion process
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name |  | 1..1 | string | Name as assigned by the client or server
value[x] |  | 0..1 |  | Value of the named parameter
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueDecimal |  |  | decimal |
valueUri |  |  | uri |
valueCode |  |  | code |
valueDateTime |  |  | dateTime |
contains | S C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
system | S | 0..1 | uri | System value for the code
abstract | S | 0..1 | boolean | If user cannot select this entry
inactive | S | 0..1 | boolean | If concept is inactive in the code system
version | S C | 0..1 | string | Version in which this code/display is defined
code | S C | 1..1 | code | Code - if blank, this is not a selectable code
display | S C | 0..1 | string | User display for the concept
designation |  | 0..* | See designation (ValueSet) | Additional representations for this item
contains | S | 0..* | See contains (ValueSet) | Codes contained under this entry
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ValueSet.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
ValueSet.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` from the FHIR Standard
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet `http://hl7.org/fhir/ValueSet/jurisdiction` from the FHIR Standard
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse `http://hl7.org/fhir/ValueSet/designation-use` from the FHIR Standard
ValueSet.compose.include.filter.op | required | FilterOperator `http://hl7.org/fhir/ValueSet/filter-operator|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | ValueSet | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vsd-0 | warning | ValueSet | 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}') |
vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() |
vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() |
vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() |
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() |
vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true |
vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |

This structure is derived from ValueSet

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 16 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/valueset-warning

Maturity: 3

Other representations of profile: CSV, Excel, Schematron