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.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children |
  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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| expression |
SC | 0..1 | Expression | Machine instructions for constructing the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 supplement |
S | 0..1 | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| immutable |
SΣ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur ele-1: All FHIR elements must have a @value or children |
  compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) ele-1: All FHIR elements must have a @value or children |
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set ele-1: All FHIR elements must have a @value or children |
| include |
SΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system |
SΣC | 0..1 | uri | The system the codes come from ele-1: All FHIR elements must have a @value or children |
| version |
SΣ | 0..1 | string | Specific version of the code system referred to ele-1: All FHIR elements must have a @value or children |
| concept |
SC | 0..* | BackboneElement | A concept defined in the system ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 code |
1..1 | code | Code or expression from system ele-1: All FHIR elements must have a @value or children | |
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
SΣ | 1..1 | code | A property/filter defined by the code system ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| value |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists ele-1: All FHIR elements must have a @value or children |
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set ele-1: All FHIR elements must have a @value or children |
 exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets ele-1: All FHIR elements must have a @value or children |
| 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() |
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 2025-02-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
