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-expandedvalueset | Version: 1.1.0-cibuild | |||
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet |
C | 1..1 | 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 |
  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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   usageWarning |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |
 value[x] |
S | 1..1 | markdown | Value of extension ele-1: All FHIR elements must have a @value or children 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 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 |
  expansion |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) ele-1: All FHIR elements must have a @value or children |
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children |
| total |
S | 0..1 | integer | Total number of codes in the expansion ele-1: All FHIR elements must have a @value or children |
| offset |
S | 0..1 | integer | Offset at which this resource starts ele-1: All FHIR elements must have a @value or children |
| parameter |
S | 0..* | BackboneElement | Parameter that controlled the expansion process 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 |
 name |
1..1 | string | Name as assigned by the client or server ele-1: All FHIR elements must have a @value or children | |
| contains |
SC | 0..* | BackboneElement | Codes in the value set ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system |
S | 0..1 | uri | System value for the code ele-1: All FHIR elements must have a @value or children |
| abstract |
S | 0..1 | boolean | If user cannot select this entry ele-1: All FHIR elements must have a @value or children |
| inactive |
S | 0..1 | boolean | If concept is inactive in the code system ele-1: All FHIR elements must have a @value or children |
| version |
SC | 0..1 | string | Version in which this code/display is defined ele-1: All FHIR elements must have a @value or children |
| code |
SC | 1..1 | code | Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children |
| display |
SC | 0..1 | string | User display for the concept ele-1: All FHIR elements must have a @value or children |
 contains |
S | 0..* | See contains (ValueSet) | Codes contained under this entry 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 |
| 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() |
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
Slices for extension