2022 CDC Clinical Practice Guideline for Prescribing Opioids Implementation Guide
2022.1.0 - CI Build

2022 CDC Clinical Practice Guideline for Prescribing Opioids Implementation Guide, published by Centers for Disease Control and Prevention (CDC). This guide is not an authorized publication; it is the continuous build for version 2022.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cqframework/opioid-cds-r4/ and changes regularly. See the Directory of published versions

Resource Profile: CDC_ValueSet

Official URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset Version: 0.1
Draft as of 2018-11-20 Computable Name: CDC_ValueSet

Profile of ValueSet for use with 2022 CDC Clinical Practice Guideline

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... cdc-valueset-clinical-focus S 0..1 string CDC 2022 Opioid Guidance Clinical Focus Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-clinical-focus
.... cdc-valueset-dataelement-scope S 0..1 string CDC 2022 Opioid Guidance Data Element Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-dataelement-scope
.... cdc-valueset-inclusion-criteria S 0..1 string CDC 2022 Opioid Guidance Inclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-inclusion-criteria
.... cdc-valueset-exclusion-criteria S 0..1 string CDC 2022 Opioid Guidance exclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-exclusion-criteria
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... 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
.... cdc-valueset-clinical-focus S 0..1 string CDC 2022 Opioid Guidance Clinical Focus Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-clinical-focus
.... cdc-valueset-dataelement-scope S 0..1 string CDC 2022 Opioid Guidance Data Element Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-dataelement-scope
.... cdc-valueset-inclusion-criteria S 0..1 string CDC 2022 Opioid Guidance Inclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-inclusion-criteria
.... cdc-valueset-exclusion-criteria S 0..1 string CDC 2022 Opioid Guidance exclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-exclusion-criteria
... 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 BindingsPurpose
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 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

Cannot invoke "Object.hashCode()" because "key" is null

Differential View

This structure is derived from ValueSet

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... cdc-valueset-clinical-focus S 0..1 string CDC 2022 Opioid Guidance Clinical Focus Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-clinical-focus
.... cdc-valueset-dataelement-scope S 0..1 string CDC 2022 Opioid Guidance Data Element Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-dataelement-scope
.... cdc-valueset-inclusion-criteria S 0..1 string CDC 2022 Opioid Guidance Inclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-inclusion-criteria
.... cdc-valueset-exclusion-criteria S 0..1 string CDC 2022 Opioid Guidance exclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-exclusion-criteria
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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}')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... 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
.... cdc-valueset-clinical-focus S 0..1 string CDC 2022 Opioid Guidance Clinical Focus Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-clinical-focus
.... cdc-valueset-dataelement-scope S 0..1 string CDC 2022 Opioid Guidance Data Element Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-dataelement-scope
.... cdc-valueset-inclusion-criteria S 0..1 string CDC 2022 Opioid Guidance Inclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-inclusion-criteria
.... cdc-valueset-exclusion-criteria S 0..1 string CDC 2022 Opioid Guidance exclusion Criteria Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-exclusion-criteria
... 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 BindingsPurpose
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 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

Cannot invoke "Object.hashCode()" because "key" is null

 

Other representations of profile: CSV, Excel, Schematron