Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild
Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild
Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-computablevalueset | Version: 1.1.0-cibuild | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIComputableValueSet | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.23 | ||||
Defines a computable value set as one that SHALL have an expression-based definition (i.e. a value set defined intensionally using expressions of the code systems involved) and MAY have an expansion included. The expression-based definition SHALL be represented in only one of three ways; using the compose element, using the expression extension, or using the rules-text extension to provide a step-by-step process for expanding the value set definition
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems cvs-1: Only one of rulesText, expression, or a compose definition SHALL be provided |
  Slices for extension |
Content/Rules for all slices | |||
   rulesText |
SC | 0..1 | markdown | Human instructions for constructing the valueset URL: http://hl7.org/fhir/StructureDefinition/valueset-rules-text |
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
 supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
  immutable |
S | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
 compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
 lockedDate |
S | 0..1 | date | Fixed date for references with no specified version (transitive) |
| inactive |
S | 0..1 | boolean | Whether inactive codes are in the value set |
| include |
S | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
| system |
S | 0..1 | uri | The system the codes come from |
| version |
S | 0..1 | string | Specific version of the code system referred to |
| concept |
S | 0..* | BackboneElement | A concept defined in the system |
| filter |
S | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| property |
S | 1..1 | code | A property/filter defined by the code system |
| op |
S | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists |
 value |
S | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| valueSet |
S | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude |
S | 0..* | Explicitly exclude codes from a code system or other value sets | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| cvs-1 | error | ValueSet | Only one of rulesText, expression, or a compose definition SHALL be provided : extension('http://hl7.org/fhir/StructureDefinition/valueset-rules-text').exists() xor extension('http://hl7.org/fhir/StructureDefinition/valueset-expression').exists() xor compose.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet |
C | 0..* | 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 cvs-1: Only one of rulesText, expression, or a compose definition SHALL be provided |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| rulesText |
SC | 0..1 | markdown | Human instructions for constructing the valueset URL: http://hl7.org/fhir/StructureDefinition/valueset-rules-text |
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
| supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
 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. |
| immutable |
SΣ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
 compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) |
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set |
| include |
SΣ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 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| system |
SΣC | 0..1 | uri | The system the codes come from |
| version |
SΣ | 0..1 | string | Specific version of the code system referred to |
| concept |
SC | 0..* | BackboneElement | A concept defined in the system |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | code | Code or expression from system | |
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| property |
SΣ | 1..1 | code | A property/filter defined by the code system |
| op |
SΣ | 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 |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cvs-1 | error | ValueSet | Only one of rulesText, expression, or a compose definition SHALL be provided : extension('http://hl7.org/fhir/StructureDefinition/valueset-rules-text').exists() xor extension('http://hl7.org/fhir/StructureDefinition/valueset-expression').exists() xor compose.exists() | |
| 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()) | |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet |
C | 0..* | 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 cvs-1: Only one of rulesText, expression, or a compose definition SHALL be provided | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rulesText |
SC | 0..1 | markdown | Human instructions for constructing the valueset URL: http://hl7.org/fhir/StructureDefinition/valueset-rules-text | ||||
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression | ||||
| supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement | ||||
| 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 |
SΣ | 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 |
S | 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 |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
| include |
SΣ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 |
SΣC | 0..1 | uri | The system the codes come from | ||||
| version |
SΣ | 0..1 | string | Specific version of the code system referred to | ||||
| concept |
SC | 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.
| |||||
| 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 |
SΣ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 |
SΣ | 1..1 | code | A property/filter defined by the code system | ||||
| op |
SΣ | 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 |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
| expansion |
0..1 | BackboneElement | Used when the value set is "expanded" | |||||
| 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 |
0..1 | uri | Identifies the value set expansion (business identifier) | |||||
| timestamp |
1..1 | dateTime | Time ValueSet expansion happened | |||||
| total |
0..1 | integer | Total number of codes in the expansion | |||||
| offset |
0..1 | integer | Offset at which this resource starts | |||||
| parameter |
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 |
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 |
0..1 | uri | System value for the code | |||||
| abstract |
0..1 | boolean | If user cannot select this entry | |||||
| inactive |
0..1 | boolean | If concept is inactive in the code system | |||||
| version |
0..1 | string | Version in which this code/display is defined | |||||
| code |
C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
| display |
C | 0..1 | string | User display for the concept | ||||
| designation |
0..* | See designation (ValueSet) | Additional representations for this item | |||||
| contains |
0..* | See contains (ValueSet) | Codes contained under this entry | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ValueSet.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard | ||||
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cvs-1 | error | ValueSet | Only one of rulesText, expression, or a compose definition SHALL be provided : extension('http://hl7.org/fhir/StructureDefinition/valueset-rules-text').exists() xor extension('http://hl7.org/fhir/StructureDefinition/valueset-expression').exists() xor compose.exists() | |
| 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()) | |
| 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: 0 element(3 nested mandatory elements)
Must-Support: 17 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems cvs-1: Only one of rulesText, expression, or a compose definition SHALL be provided |
| Slices for extension |
Content/Rules for all slices | |||
| rulesText |
SC | 0..1 | markdown | Human instructions for constructing the valueset URL: http://hl7.org/fhir/StructureDefinition/valueset-rules-text |
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
| supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
| immutable |
S | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
| lockedDate |
S | 0..1 | date | Fixed date for references with no specified version (transitive) |
| inactive |
S | 0..1 | boolean | Whether inactive codes are in the value set |
| include |
S | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
| system |
S | 0..1 | uri | The system the codes come from |
| version |
S | 0..1 | string | Specific version of the code system referred to |
| concept |
S | 0..* | BackboneElement | A concept defined in the system |
| filter |
S | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| property |
S | 1..1 | code | A property/filter defined by the code system |
| op |
S | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists |
| value |
S | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| valueSet |
S | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude |
S | 0..* | Explicitly exclude codes from a code system or other value sets | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| cvs-1 | error | ValueSet | Only one of rulesText, expression, or a compose definition SHALL be provided : extension('http://hl7.org/fhir/StructureDefinition/valueset-rules-text').exists() xor extension('http://hl7.org/fhir/StructureDefinition/valueset-expression').exists() xor compose.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet |
C | 0..* | 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 cvs-1: Only one of rulesText, expression, or a compose definition SHALL be provided |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| rulesText |
SC | 0..1 | markdown | Human instructions for constructing the valueset URL: http://hl7.org/fhir/StructureDefinition/valueset-rules-text |
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
| supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
| 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. |
| immutable |
SΣ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) |
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set |
| include |
SΣ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 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| system |
SΣC | 0..1 | uri | The system the codes come from |
| version |
SΣ | 0..1 | string | Specific version of the code system referred to |
| concept |
SC | 0..* | BackboneElement | A concept defined in the system |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | code | Code or expression from system | |
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| property |
SΣ | 1..1 | code | A property/filter defined by the code system |
| op |
SΣ | 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 |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cvs-1 | error | ValueSet | Only one of rulesText, expression, or a compose definition SHALL be provided : extension('http://hl7.org/fhir/StructureDefinition/valueset-rules-text').exists() xor extension('http://hl7.org/fhir/StructureDefinition/valueset-expression').exists() xor compose.exists() | |
| 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()) | |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet |
C | 0..* | 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 cvs-1: Only one of rulesText, expression, or a compose definition SHALL be provided | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rulesText |
SC | 0..1 | markdown | Human instructions for constructing the valueset URL: http://hl7.org/fhir/StructureDefinition/valueset-rules-text | ||||
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression | ||||
| supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement | ||||
| 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 |
SΣ | 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 |
S | 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 |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
| include |
SΣ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 |
SΣC | 0..1 | uri | The system the codes come from | ||||
| version |
SΣ | 0..1 | string | Specific version of the code system referred to | ||||
| concept |
SC | 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.
| |||||
| 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 |
SΣ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 |
SΣ | 1..1 | code | A property/filter defined by the code system | ||||
| op |
SΣ | 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 |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
| expansion |
0..1 | BackboneElement | Used when the value set is "expanded" | |||||
| 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 |
0..1 | uri | Identifies the value set expansion (business identifier) | |||||
| timestamp |
1..1 | dateTime | Time ValueSet expansion happened | |||||
| total |
0..1 | integer | Total number of codes in the expansion | |||||
| offset |
0..1 | integer | Offset at which this resource starts | |||||
| parameter |
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 |
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 |
0..1 | uri | System value for the code | |||||
| abstract |
0..1 | boolean | If user cannot select this entry | |||||
| inactive |
0..1 | boolean | If concept is inactive in the code system | |||||
| version |
0..1 | string | Version in which this code/display is defined | |||||
| code |
C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
| display |
C | 0..1 | string | User display for the concept | ||||
| designation |
0..* | See designation (ValueSet) | Additional representations for this item | |||||
| contains |
0..* | See contains (ValueSet) | Codes contained under this entry | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ValueSet.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard | ||||
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cvs-1 | error | ValueSet | Only one of rulesText, expression, or a compose definition SHALL be provided : extension('http://hl7.org/fhir/StructureDefinition/valueset-rules-text').exists() xor extension('http://hl7.org/fhir/StructureDefinition/valueset-expression').exists() xor compose.exists() | |
| 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()) | |
| 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: 0 element(3 nested mandatory elements)
Must-Support: 17 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.1.0-cibuild based on FHIR 4.0.1. Generated 2024-08-29
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change