Opioid Prescribing Support Implementation Guide, published by Centers for Disease Control and Prevention (CDC). This is not an authorized publication; it is the continuous build for version 1.2.3). This version is based on the current content of https://github.com/cqframework/opioid-cds/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition: cdc-valueset

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset

Profile of ValueSet for use with CDC Opioid Prescribing Guidelines

This profile builds on ValueSet.

This profile was published on 2017-04-21 as a draft by Centers for Disease Control and Prevention.

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

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cdc-valueset-inclusion S0..1stringCDC Opioid Guidance Inclusion Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-inclusion
... cdc-valueset-exclusion S0..1stringCDC Opioid Guidance Exclusion Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-exclusion
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this value set (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the value set
... version Σ0..1stringBusiness version of the value set
... name Σ0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.

... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... extensible Σ0..1booleanWhether this is intended to be used with an extensible binding
... compose SI0..1BackboneElementDefinition of the content of the value set (CLD)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... cdc-valueset-query S0..1(Complex)CDC Opioid Guidance Query Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-query
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... lockedDate Σ0..1dateFixed date for version-less references (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation 0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... language 0..1codeHuman language of the designation
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
....... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.

....... value 1..1stringThe text value for this designation
..... filter ?!ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... property Σ1..1codeA property defined by the code system
...... op Σ1..1code= | 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..1codeCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*uriSelect only contents included in this value set
.... exclude I0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName as assigned by the server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
.... contains I0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser 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

Differential View

This structure is derived from http://hl7.org/fhir/STU3/valueset.html.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cdc-valueset-inclusion S0..1stringCDC Opioid Guidance Inclusion Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-inclusion
... cdc-valueset-exclusion S0..1stringCDC Opioid Guidance Exclusion Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-exclusion
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this value set (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the value set
... version Σ0..1stringBusiness version of the value set
... name Σ0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.

... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... extensible Σ0..1booleanWhether this is intended to be used with an extensible binding
... compose SI0..1BackboneElementDefinition of the content of the value set (CLD)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... cdc-valueset-query S0..1(Complex)CDC Opioid Guidance Query Extension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-valueset-query
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... lockedDate Σ0..1dateFixed date for version-less references (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation 0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... language 0..1codeHuman language of the designation
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
....... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.

....... value 1..1stringThe text value for this designation
..... filter ?!ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... property Σ1..1codeA property defined by the code system
...... op Σ1..1code= | 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..1codeCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*uriSelect only contents included in this value set
.... exclude I0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName as assigned by the server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
.... contains I0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser 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

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ValueSet.languageextensibleCommon Languages
Max Binding: All Languages
ValueSet.statusrequiredPublicationStatus
ValueSet.jurisdictionextensibleJurisdiction ValueSet
ValueSet.compose.include.concept.designation.languageextensibleCommon Languages
Max Binding: All Languages
ValueSet.compose.include.concept.designation.useextensibleDesignation Use
ValueSet.compose.include.filter.oprequiredFilterOperator

D.4.1.3 Constraints

Constraints

IdGradePathDetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1errorValueSetIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.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-3errorValueSetIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
vsd-5errorValueSetValue set SHALL contain at least one of a compose or an expansion element
: compose.exists() or expansion.exists()
ele-1errorValueSet.extension:cdc-valueset-inclusionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorValueSet.extension:cdc-valueset-inclusionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.extension:cdc-valueset-exclusionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorValueSet.extension:cdc-valueset-exclusionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.composeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorValueSet.compose.extension:cdc-valueset-queryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorValueSet.compose.extension:cdc-valueset-queryMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorValueSet.compose.includeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
ele-1errorValueSet.compose.include.conceptAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorValueSet.compose.include.concept.designationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorValueSet.compose.include.filterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorValueSet.expansionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorValueSet.expansion.parameterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorValueSet.expansion.containsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
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()
.

s