Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3 R2

Vocabulary Terminology Infrastructure icon Work Group   Maturity Level : 0 Trial Use Use Context : Any

The official canonical URL for this profile is:

http://hl7.org/fhir/StructureDefinition/shareablevalueset

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management icon implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

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

This structure is derived from ValueSet .

Summary

mustSupport

When this profile has defined an element as mustSupport, the sender must provide the element value when available, and the receiver must accept the element value, persist the value and when appropriate, provide function as defined in the profile. When mustSupport is defined at a complex element level, all sub-elements inherit mustSupport.

Mandatory: 7 5 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

This structure is derived from indicates the differences between this profile and the base ValueSet . structure.

Name Flags Card. Type Description & Constraints doco
. . ValueSet 1..1 ValueSet A set of codes drawn from one or more code systems
. . . knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
. . . url S 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
. . . versionAlgorithm[x] S 0 .. 1 string , Coding How to compare versions
... name S 0 .. 1 string Name for this value set (computer friendly)
... title S 1..1 string Name for this value set (computer (human friendly)
. . . status S 1..1 1 .. 1 code draft | active | retired | unknown
. . . experimental S 1..1 boolean For testing purposes, not real usage
. . . publisher S 1..1 0 .. 1 string Name of the publisher publisher/steward (organization or individual)
. . . description S 1..1 markdown Natural language description of the value set

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ValueSet structure.

All Languages Max Binding 0..1 1..1 dateTime
Name Flags Card. Type Description & Constraints doco
. . ValueSet I C icon 1..1 ValueSet A set of codes drawn from one or more code systems
. . . 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: Common All Languages ( preferred required ): IETF language tag for a human language

Additional Bindings Purpose
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* Extension Additional content defined Extension
Slice: Unordered, Open by implementations value:url
. . . knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . url S Σ C icon 1..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 S Σ 1..1 string Business version of the value set
. . name . versionAlgorithm[x] S Σ 1..1 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
... name S Σ C icon 0..1 string Name for this value set (computer friendly)
. . . title S Σ 1..1 string Name for this value set (human friendly)
. . . status ?! S Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

. . . experimental S Σ 1..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher S Σ 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description S 1..1 markdown Natural language description of the value set
. . . useContext Σ TU 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ XD 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
. . . copyrightLabel TU 0..1 string Copyright holder and year(s)
... approvalDate TU 0..1 date When the ValueSet was approved by publisher
... lastReviewDate TU 0..1 date When the ValueSet was last reviewed by the publisher
.. . compose effectivePeriod Σ TU 0..1 BackboneElement Period When the ValueSet is expected to be used
... topic XD 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( example )
... author TU 0..* ContactDetail Who authored the ValueSet
... editor TU 0..* ContactDetail Who edited the ValueSet
... reviewer TU 0..* ContactDetail Who reviewed the ValueSet
... endorser TU 0..* ContactDetail Who endorsed the ValueSet
... relatedArtifact TU 0..* RelatedArtifact Additional documentation, citations, etc
... 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 Σ I C icon 1..* BackboneElement Include one or more codes from a code system or other value set(s)
. . . . . 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 Σ I C icon 0..1 uri The system the codes come from
. . . . . version Σ 0..1 string Specific version of the code system referred to
. . . . . concept I C icon 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 C icon 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: Common All Languages ( preferred required ): IETF language tag for a human language

Additional Bindings . . Purpose . . . . All Languages . use C icon Max Binding 0..1 Coding Types of uses of designations
Binding: Designation Use ( extensible ): Details of how a designation would be used.

. . . . . . . use additionalUse C icon TU 0..1 0..* Coding Types of uses of designations Additional ways how this designation would be used
Binding: Designation Use ( extensible ): Details of how a designation would be used.


. . . . . . . value 1..1 string The text value for this designation
. . . . . filter Σ I C icon 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 | child-of | descendent-leaf | exists
Binding: FilterOperator Filter Operator ( 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 Σ I C icon 0..* canonical ( ValueSet ) Select the contents included in this value set
. . . . exclude . copyright I TU 0..* 0..1 string A copyright statement for the specific code system included in the value set
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
. . . . property TU 0..* string Property to return if client doesn't override
.. . 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 next TU 1..1 0..1 uri Opaque urls for paging through expansion results
.... 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
. . . . . . valueUri valueCode code
...... valueDateTime dateTime
.... property uri TU 0..* BackboneElement Additional information supplied about each concept
. . . . . valueCode id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* code Extension Extensions that cannot be ignored even if unrecognized
. . . . . valueDateTime code 1..1 code Identifies the property on the concepts, and when referred to in operations
. . . . . uri 0..1 uri Formal identifier for the property
. . . . contains I C icon 0..* BackboneElement Codes in the value set
. . . . . 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 icon 0..1 uri System value for the code
. . . . . abstract C icon 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 I C icon 0..1 code Code - if blank, this is not a selectable code
. . . . . display I C icon 0..1 string User display for the concept
. . . . . designation 0..* See designation (ValueSet) Additional representations for this item
. . . . . property TU 0..* BackboneElement Property value for the 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
...... code 1..1 code Reference to ValueSet.expansion.property.code
...... value[x] 1..1 Value of the property for this concept
....... valueCode code
....... valueCoding Coding
....... valueString string
. . . . . . . valueInteger integer
.. . . . . . valueBoolean boolean
....... valueDateTime dateTime
..... . contains . valueDecimal decimal
. . . . . . subProperty 0..* BackboneElement SubProperty value for the 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
....... code 1..1 code Reference to ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
. . . scope TU 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... 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
.... inclusionCriteria 0..1 string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1 string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format icon
<!-- Shareable ValueSet -->

<!-- ShareableValueSet -->doco


<ValueSet xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <</meta>
 <
 <
 <

 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 

     Text summary of the resource, for human interpretation --></text>
 <</contained>
 <<a href="shareablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
 <
 <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this value set, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 

     Additional identifier for the value set (business identifier) --></identifier>
 <
 <
 <
 <
 <
 <
 <
 <</contact>
 <
 <

 <version value="[string]"/><!-- I 1..1 Business version of the value set -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this value set (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this value set (human friendly) -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the value set -->
 <useContext><!-- I 0..* UsageContext 

     The context that the content is intended to support --></useContext>
 <</jurisdiction>
 <
 <
 <
 <
  <<a href="shareablevalueset-definitions.html#ValueSet.compose.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for value set (if applicable)   --></jurisdiction>
 <immutable value="[boolean]"/><!-- I 0..1 Indicates whether or not any change to the content logical definition may occur -->
 <purpose value="[markdown]"/><!-- I 0..1 Why this value set is defined -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the ValueSet was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the ValueSet was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the ValueSet is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the ValueSet --></author>
 <editor><!-- I 0..* ContactDetail Who edited the ValueSet --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the ValueSet --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the ValueSet --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc --></relatedArtifact>
 <compose> I 0..1 BackboneElement  <!-- I 0..1 Content logical definition of the value set (CLD) -->
  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <
  <
  <
   <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <lockedDate value="[date]"/><!-- I 0..1 Fixed date for references with no specified version (transitive) -->
  <inactive value="[boolean]"/><!-- I 0..1 Whether inactive codes are in the value set -->
  <include> I 1..* BackboneElement  <!-- I 1..* Include one or more codes from a code system or other value set(s) -->
   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <
   <
    <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.concept.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- I 0..1 The system the codes come from -->
   <version value="[string]"/><!-- I 0..1 Specific version of the code system referred to -->
   <concept> I 0..* BackboneElement  <!-- I 0..* A concept defined in the system -->
    <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
    <
    <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- I 1..1 Code or expression from system -->
    <display value="[string]"/><!-- I 0..1 

        Text to display for this code for this value set in this valueset -->
    <
     <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.concept.designation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    <designation> I 0..* BackboneElement  <!-- I 0..* Additional representations for this concept -->
     <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* 

       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <
     <</use>
     <

     <language value="[code]"/><!-- I 0..1 Human language of the designation   -->
     <use><!-- I 0..1 Coding Types of uses of designations   --></use>
     <additionalUse><!-- I 0..* 
       Coding Additional ways how this designation would be used   --></additionalUse>

     <value value="[string]"/><!-- I 1..1 The text value for this designation -->

    </designation>
   </concept>
   <
    <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.filter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

   <filter> I 0..* BackboneElement  <!-- I 0..* Select codes/concepts by their properties (including relationships) -->
    <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
    <
    <
    <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <property value="[code]"/><!-- I 1..1 A property/filter defined by the code system -->
    <op value="[code]"/><!-- I 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists   -->
    <value value="[string]"/><!-- I 1..1 

        Code from the system, or regex criteria, or boolean value for exists -->
   </filter>
   <

   <valueSet value="[canonical]"/><!-- I 0..* Select the contents included in this value set -->
   <copyright value="[string]"/><!-- I 0..1 
       A copyright statement for the specific code system included in the value set -->

  </include>
  <exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include  Explicitly exclude codes from a code system or other value sets --></exclude>
  <property value="[string]"/><!-- I 0..* Property to return if client doesn't override -->

 </compose>
 <
  <<a href="shareablevalueset-definitions.html#ValueSet.expansion.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

 <expansion> I 0..1 BackboneElement  <!-- I 0..1 Used when the value set is "expanded" -->
  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <
  <
  <
  <
  <
   <<a href="shareablevalueset-definitions.html#ValueSet.expansion.parameter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <identifier value="[uri]"/><!-- I 0..1 Identifies the value set expansion (business identifier) -->
  <next value="[uri]"/><!-- I 0..1 Opaque urls for paging through expansion results -->
  <timestamp value="[dateTime]"/><!-- I 1..1 Time ValueSet expansion happened -->
  <total value="[integer]"/><!-- I 0..1 Total number of codes in the expansion -->
  <offset value="[integer]"/><!-- I 0..1 Offset at which this resource starts -->
  <parameter> I 0..* BackboneElement  <!-- I 0..* Parameter that controlled the expansion process -->
   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <|

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <name value="[string]"/><!-- I 1..1 Name as assigned by the client or server -->
   <value[x]><!-- I 0..1 string|boolean|integer|

     decimal|uri|code|dateTime Value of the named parameter --></value[x]>
  </parameter>
  <
   <<a href="shareablevalueset-definitions.html#ValueSet.expansion.contains.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

  <property> I 0..* BackboneElement  <!-- I 0..* Additional information supplied about each concept -->
   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <
   <
   <
   <
   <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- I 1..1 
       Identifies the property on the concepts, and when referred to in operations -->
   <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property -->
  </property>
  <contains> I 0..* BackboneElement  <!-- I 0..* Codes in the value set -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- I 0..1 System value for the code -->
   <abstract value="[boolean]"/><!-- I 0..1 If user cannot select this entry -->
   <inactive value="[boolean]"/><!-- I 0..1 If concept is inactive in the code system -->
   <version value="[string]"/><!-- I 0..1 Version in which this code/display is defined -->
   <code value="[code]"/><!-- I 0..1 Code - if blank, this is not a selectable code -->
   <display value="[string]"/><!-- I 0..1 User display for the concept -->

   <designation><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation  Additional representations for this item --></designation>
   <property> I 0..* BackboneElement  <!-- I 0..* Property value for the concept -->
    <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- I 1..1 Reference to ValueSet.expansion.property.code -->
    <value[x]><!-- I 1..1 code|Coding|string|
      integer|boolean|dateTime|decimal 

        Value of the property for this concept --></value[x]>
    <subProperty> I 0..* BackboneElement  <!-- I 0..* SubProperty value for the concept -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

     <code value="[code]"/><!-- I 1..1 
         Reference to ValueSet.expansion.property.code -->
     <value[x]><!-- I 1..1 code|
       Coding|string|integer|boolean|dateTime|decimal 

         Value of the subproperty for this concept --></value[x]>
    </subProperty>
   </property>

   <contains><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains  Codes contained under this entry --></contains>
  </contains>
 </expansion>
 <scope> I 0..1 BackboneElement  <!-- I 0..1 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <inclusionCriteria value="[string]"/><!-- I 0..1 
      Criteria describing which concepts or codes should be included and why -->
  <exclusionCriteria value="[string]"/><!-- I 0..1 
      Criteria describing which concepts or codes should be excluded and why -->
 </scope>

</ValueSet>
{ // 

{ // ShareableValueSet

  // from Element: extension
    "
    "
    "
    "
    "
    "<a href="shareablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Reference to the current trusted source of the ValueSet resource (metadata and definition) // I
        // from Element: extension
      }
    ],
    "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this value set, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the value set (business identifier)
    "version" : "<string>", // I R! Business version of the value set
  // value[x]: How to compare versions. One of these 2:

    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this value set (computer friendly)
    "title" : "<string>", // I R! Name for this value set (human friendly)
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the value set
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for value set (if applicable)
    "immutable" : <boolean>, // IIndicates whether or not any change to the content logical definition may occur
    "purpose" : "<markdown>", // IWhy this value set is defined
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the ValueSet was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the ValueSet was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the ValueSet is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the ValueSet
    "editor" : [{ ContactDetail }], // IWho edited the ValueSet
    "reviewer" : [{ ContactDetail }], // IWho reviewed the ValueSet
    "endorser" : [{ ContactDetail }], // IWho endorsed the ValueSet
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
    "compose" : { BackboneElement }, // IContent logical definition of the value set (CLD)
    "expansion" : { BackboneElement }, // IUsed when the value set is "expanded"
    "scope" : { BackboneElement }, // IDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description

  }

This structure is derived from ValueSet .

Summary

mustSupport

When this profile has defined an element as mustSupport, the sender must provide the element value when available, and the receiver must accept the element value, persist the value and when appropriate, provide function as defined in the profile. When mustSupport is defined at a complex element level, all sub-elements inherit mustSupport.

Mandatory: 7 5 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from indicates the differences between this profile and the base ValueSet . structure.

Name Flags Card. Type Description & Constraints doco
. . ValueSet 1..1 ValueSet A set of codes drawn from one or more code systems
. . . knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
. . . url S 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
. . . versionAlgorithm[x] S 0 .. 1 string , Coding How to compare versions
... name S 0 .. 1 string Name for this value set (computer friendly)
... title S 1..1 string Name for this value set (computer (human friendly)
. . . status S 1..1 1 .. 1 code draft | active | retired | unknown
. . . experimental S 1..1 boolean For testing purposes, not real usage
. . . publisher S 1..1 0 .. 1 string Name of the publisher publisher/steward (organization or individual)
. . . description S 1..1 markdown Natural language description of the value set

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ValueSet structure.

0..1 1..1 uri dateTime
Name Flags Card. Type Description & Constraints doco
. . ValueSet I C icon 1..1 ValueSet A set of codes drawn from one or more code systems
. . . 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: Common All Languages ( preferred required ): IETF language tag for a human language

Additional Bindings Purpose All Languages Max Binding
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* Extension Additional content defined Extension
Slice: Unordered, Open by implementations value:url
. . . knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . url S Σ C icon 1..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 S Σ 1..1 string Business version of the value set
. . name . versionAlgorithm[x] S Σ 1..1 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
... name S Σ C icon 0..1 string Name for this value set (computer friendly)
. . . title S Σ 1..1 string Name for this value set (human friendly)
. . . status ?! S Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

. . . experimental S Σ 1..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher S Σ 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description S 1..1 markdown Natural language description of the value set
. . . useContext Σ TU 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ XD 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
. . . copyrightLabel TU 0..1 string Copyright holder and year(s)
... approvalDate TU 0..1 date When the ValueSet was approved by publisher
... lastReviewDate TU 0..1 date When the ValueSet was last reviewed by the publisher
.. . compose effectivePeriod Σ TU 0..1 BackboneElement Period When the ValueSet is expected to be used
... topic XD 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( example )
... author TU 0..* ContactDetail Who authored the ValueSet
... editor TU 0..* ContactDetail Who edited the ValueSet
... reviewer TU 0..* ContactDetail Who reviewed the ValueSet
... endorser TU 0..* ContactDetail Who endorsed the ValueSet
... relatedArtifact TU 0..* RelatedArtifact Additional documentation, citations, etc
... 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 Σ I C icon 1..* BackboneElement Include one or more codes from a code system or other value set(s)
. . . . . 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 Σ I C icon 0..1 uri The system the codes come from
. . . . . version Σ 0..1 string Specific version of the code system referred to
. . . . . concept I C icon 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 C icon 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: Common All Languages ( preferred required ): IETF language tag for a human language

Additional Bindings . . Purpose . . . . All Languages . use C icon Max Binding 0..1 Coding Types of uses of designations
Binding: Designation Use ( extensible ): Details of how a designation would be used.

. . . . . . . use additionalUse C icon TU 0..1 0..* Coding Types of uses of designations Additional ways how this designation would be used
Binding: Designation Use ( extensible ): Details of how a designation would be used.


. . . . . . . value 1..1 string The text value for this designation
. . . . . filter Σ I C icon 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 | child-of | descendent-leaf | exists
Binding: FilterOperator Filter Operator ( 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 Σ I C icon 0..* canonical ( ValueSet ) Select the contents included in this value set
. . . . exclude . copyright I TU 0..* 0..1 string A copyright statement for the specific code system included in the value set
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
. . . . property TU 0..* string Property to return if client doesn't override
.. . 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 next TU 1..1 0..1 uri Opaque urls for paging through expansion results
.... 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
. . . . . . valueUri valueCode code
...... valueDateTime dateTime
.... property TU 0..* BackboneElement Additional information supplied about each concept
. . . . . valueCode id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension code ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . valueDateTime code 1..1 code Identifies the property on the concepts, and when referred to in operations
. . . . . uri 0..1 uri Formal identifier for the property
. . . . contains I C icon 0..* BackboneElement Codes in the value set
. . . . . 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 icon 0..1 uri System value for the code
. . . . . abstract C icon 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 I C icon 0..1 code Code - if blank, this is not a selectable code
. . . . . display I C icon 0..1 string User display for the concept
. . . . . designation 0..* See designation (ValueSet) Additional representations for this item
. . . . . property TU 0..* BackboneElement Property value for the 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
...... code 1..1 code Reference to ValueSet.expansion.property.code
. . . . . . value[x] 1..1 Value of the property for this concept
.. . . . . . valueCode code
....... valueCoding Coding
....... valueString string
....... valueInteger integer
....... valueBoolean boolean
....... valueDateTime dateTime
..... . contains . valueDecimal decimal
. . . . . . subProperty 0..* BackboneElement SubProperty value for the 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
....... code 1..1 code Reference to ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
. . . scope TU 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... 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
.... inclusionCriteria 0..1 string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1 string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format icon

XML Template

<!-- Shareable ValueSet -->

<!-- ShareableValueSet -->doco


<ValueSet xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <</meta>
 <
 <
 <

 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 

     Text summary of the resource, for human interpretation --></text>
 <</contained>
 <<a href="shareablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
 <
 <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this value set, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 

     Additional identifier for the value set (business identifier) --></identifier>
 <
 <
 <
 <
 <
 <
 <
 <</contact>
 <
 <

 <version value="[string]"/><!-- I 1..1 Business version of the value set -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this value set (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this value set (human friendly) -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the value set -->
 <useContext><!-- I 0..* UsageContext 

     The context that the content is intended to support --></useContext>
 <</jurisdiction>
 <
 <
 <
 <
  <<a href="shareablevalueset-definitions.html#ValueSet.compose.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for value set (if applicable)   --></jurisdiction>
 <immutable value="[boolean]"/><!-- I 0..1 Indicates whether or not any change to the content logical definition may occur -->
 <purpose value="[markdown]"/><!-- I 0..1 Why this value set is defined -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the ValueSet was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the ValueSet was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the ValueSet is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the ValueSet --></author>
 <editor><!-- I 0..* ContactDetail Who edited the ValueSet --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the ValueSet --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the ValueSet --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc --></relatedArtifact>
 <compose> I 0..1 BackboneElement  <!-- I 0..1 Content logical definition of the value set (CLD) -->
  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <
  <
  <
   <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <lockedDate value="[date]"/><!-- I 0..1 Fixed date for references with no specified version (transitive) -->
  <inactive value="[boolean]"/><!-- I 0..1 Whether inactive codes are in the value set -->
  <include> I 1..* BackboneElement  <!-- I 1..* Include one or more codes from a code system or other value set(s) -->
   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <
   <
    <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.concept.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- I 0..1 The system the codes come from -->
   <version value="[string]"/><!-- I 0..1 Specific version of the code system referred to -->
   <concept> I 0..* BackboneElement  <!-- I 0..* A concept defined in the system -->
    <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
    <
    <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- I 1..1 Code or expression from system -->
    <display value="[string]"/><!-- I 0..1 

        Text to display for this code for this value set in this valueset -->
    <
     <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.concept.designation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    <designation> I 0..* BackboneElement  <!-- I 0..* Additional representations for this concept -->
     <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* 

       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <
     <</use>
     <

     <language value="[code]"/><!-- I 0..1 Human language of the designation   -->
     <use><!-- I 0..1 Coding Types of uses of designations   --></use>
     <additionalUse><!-- I 0..* 
       Coding Additional ways how this designation would be used   --></additionalUse>

     <value value="[string]"/><!-- I 1..1 The text value for this designation -->

    </designation>
   </concept>
   <
    <<a href="shareablevalueset-definitions.html#ValueSet.compose.include.filter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

   <filter> I 0..* BackboneElement  <!-- I 0..* Select codes/concepts by their properties (including relationships) -->
    <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
    <
    <
    <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <property value="[code]"/><!-- I 1..1 A property/filter defined by the code system -->
    <op value="[code]"/><!-- I 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists   -->
    <value value="[string]"/><!-- I 1..1 

        Code from the system, or regex criteria, or boolean value for exists -->
   </filter>
   <

   <valueSet value="[canonical]"/><!-- I 0..* Select the contents included in this value set -->
   <copyright value="[string]"/><!-- I 0..1 
       A copyright statement for the specific code system included in the value set -->

  </include>
  <exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include  Explicitly exclude codes from a code system or other value sets --></exclude>
  <property value="[string]"/><!-- I 0..* Property to return if client doesn't override -->

 </compose>
 <
  <<a href="shareablevalueset-definitions.html#ValueSet.expansion.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

 <expansion> I 0..1 BackboneElement  <!-- I 0..1 Used when the value set is "expanded" -->
  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <
  <
  <
  <
  <
   <<a href="shareablevalueset-definitions.html#ValueSet.expansion.parameter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <identifier value="[uri]"/><!-- I 0..1 Identifies the value set expansion (business identifier) -->
  <next value="[uri]"/><!-- I 0..1 Opaque urls for paging through expansion results -->
  <timestamp value="[dateTime]"/><!-- I 1..1 Time ValueSet expansion happened -->
  <total value="[integer]"/><!-- I 0..1 Total number of codes in the expansion -->
  <offset value="[integer]"/><!-- I 0..1 Offset at which this resource starts -->
  <parameter> I 0..* BackboneElement  <!-- I 0..* Parameter that controlled the expansion process -->
   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <|

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <name value="[string]"/><!-- I 1..1 Name as assigned by the client or server -->
   <value[x]><!-- I 0..1 string|boolean|integer|

     decimal|uri|code|dateTime Value of the named parameter --></value[x]>
  </parameter>
  <
   <<a href="shareablevalueset-definitions.html#ValueSet.expansion.contains.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

  <property> I 0..* BackboneElement  <!-- I 0..* Additional information supplied about each concept -->
   <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
   <
   <
   <
   <
   <
   <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- I 1..1 
       Identifies the property on the concepts, and when referred to in operations -->
   <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property -->
  </property>
  <contains> I 0..* BackboneElement  <!-- I 0..* Codes in the value set -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- I 0..1 System value for the code -->
   <abstract value="[boolean]"/><!-- I 0..1 If user cannot select this entry -->
   <inactive value="[boolean]"/><!-- I 0..1 If concept is inactive in the code system -->
   <version value="[string]"/><!-- I 0..1 Version in which this code/display is defined -->
   <code value="[code]"/><!-- I 0..1 Code - if blank, this is not a selectable code -->
   <display value="[string]"/><!-- I 0..1 User display for the concept -->

   <designation><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation  Additional representations for this item --></designation>
   <property> I 0..* BackboneElement  <!-- I 0..* Property value for the concept -->
    <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- I 1..1 Reference to ValueSet.expansion.property.code -->
    <value[x]><!-- I 1..1 code|Coding|string|
      integer|boolean|dateTime|decimal 

        Value of the property for this concept --></value[x]>
    <subProperty> I 0..* BackboneElement  <!-- I 0..* SubProperty value for the concept -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

     <code value="[code]"/><!-- I 1..1 
         Reference to ValueSet.expansion.property.code -->
     <value[x]><!-- I 1..1 code|
       Coding|string|integer|boolean|dateTime|decimal 

         Value of the subproperty for this concept --></value[x]>
    </subProperty>
   </property>

   <contains><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains  Codes contained under this entry --></contains>
  </contains>
 </expansion>
 <scope> I 0..1 BackboneElement  <!-- I 0..1 Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <inclusionCriteria value="[string]"/><!-- I 0..1 
      Criteria describing which concepts or codes should be included and why -->
  <exclusionCriteria value="[string]"/><!-- I 0..1 
      Criteria describing which concepts or codes should be excluded and why -->
 </scope>

</ValueSet>

JSON Template

{ // 

{ // ShareableValueSet

  // from Element: extension
    "
    "
    "
    "
    "
    "<a href="shareablevalueset-definitions.html#ValueSet.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Reference to the current trusted source of the ValueSet resource (metadata and definition) // I
        // from Element: extension
      }
    ],
    "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this value set, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the value set (business identifier)
    "version" : "<string>", // I R! Business version of the value set
  // value[x]: How to compare versions. One of these 2:

    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this value set (computer friendly)
    "title" : "<string>", // I R! Name for this value set (human friendly)
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the value set
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for value set (if applicable)
    "immutable" : <boolean>, // IIndicates whether or not any change to the content logical definition may occur
    "purpose" : "<markdown>", // IWhy this value set is defined
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the ValueSet was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the ValueSet was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the ValueSet is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the ValueSet
    "editor" : [{ ContactDetail }], // IWho edited the ValueSet
    "reviewer" : [{ ContactDetail }], // IWho reviewed the ValueSet
    "endorser" : [{ ContactDetail }], // IWho endorsed the ValueSet
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
    "compose" : { BackboneElement }, // IContent logical definition of the value set (CLD)
    "expansion" : { BackboneElement }, // IUsed when the value set is "expanded"
    "scope" : { BackboneElement }, // IDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description

  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

Path Name Conformance ValueSet
ValueSet.language Common All Languages preferred required Common All Languages
ValueSet.versionAlgorithm[x] Version Algorithm extensible Version Algorithm
ValueSet.status PublicationStatus required PublicationStatus
ValueSet.jurisdiction Jurisdiction ValueSet extensible Jurisdiction ValueSet
ValueSet.topic Definition Topic example Definition Topic
ValueSet.compose.include.concept.designation.language Common All Languages preferred required Common All Languages
ValueSet.compose.include.concept.designation.use Designation Use extensible Designation Use
ValueSet.compose.include.concept.designation.additionalUse Designation Use extensible Designation Use
ValueSet.compose.include.filter.op FilterOperator Filter Operator required FilterOperator Filter Operator
. .