Release 4 5 Draft Ballot
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Vocabulary Work Group   Maturity Level : 1 0 Trial Use Use Context : Any

The official 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

This profile was published on [no date] Thu, Jan 1, 1970 00:00+0000 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

Mandatory: 7 5 elements

This structure is derived from ValueSet .

Name Flags Card. Type Description & Constraints doco
. . ValueSet 1..1 ValueSet A set of codes drawn from one or more code systems
. . . url 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
. . . version 1..1 string Business version of the value set
. . . name 1..1 string Name for this value set (computer friendly)
. . . experimental 1..1 boolean For testing purposes, not real usage
. . . publisher 1..1 0 .. 1 string Name of the publisher (organization or individual)
. . . description 1..1 0 .. 1 markdown Natural language description of the value set

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ValueSet I 1..1 ValueSet A set of codes drawn from one or more code systems
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred )
Max Binding: All Languages : IETF language tag

. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . url Σ I 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
. . . identifier Σ I 0..* Identifier Additional identifier for the value set (business identifier)
. . . version Σ I 1..1 string Business version of the value set
. . . name Σ I 1..1 string Name for this value set (computer friendly)
. . . title Σ I 0..1 string Name for this value set (human friendly)
. . . status ?! Σ I 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ) ): The lifecycle status of an artifact.

. . . experimental Σ I 1..1 boolean For testing purposes, not real usage
. . . date Σ I 0..1 dateTime Date last changed
. . . publisher Σ I 1..1 0..1 string Name of the publisher (organization or individual)
. . . contact Σ I 0..* ContactDetail Contact details for the publisher
. . . description I 1..1 0..1 markdown Natural language description of the value set
. . . useContext Σ I 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ I 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ( extensible ) ): Countries and regions within which this artifact is targeted for use.


. . . immutable Σ I 0..1 boolean Indicates whether or not any change to the content logical definition may occur
. . . purpose I 0..1 markdown Why this value set is defined
. . . copyright I 0..1 markdown Use and/or publishing restrictions
. . . compose I 0..1 BackboneElement Content logical definition of the value set (CLD)
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . lockedDate Σ I 0..1 date Fixed date for references with no specified version (transitive)
. . . . inactive Σ I 0..1 boolean Whether inactive codes are in the value set
. . . . include Σ I 1..* BackboneElement Include one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . system Σ I 0..1 uri The system the codes come from
. . . . . version Σ I 0..1 string Specific version of the code system referred to
. . . . . concept I 0..* BackboneElement A concept defined in the system
. . . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . code I 1..1 code Code or expression from system
. . . . . . display I 0..1 string Text to display for this code for this value set in this valueset
. . . . . . designation I 0..* BackboneElement Additional representations for this concept
. . . . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . . language I 0..1 code Human language of the designation
Binding: Common Languages ( preferred )
Max Binding: All Languages : IETF language tag

. . . . . . . use I 0..1 Coding Types of uses of designations
Binding: Designation Use ( extensible ) ): Details of how a designation would be used.

. . . . . . . value I 1..1 string The text value for this designation
. . . . . filter Σ I 0..* BackboneElement Select codes/concepts by their properties (including relationships)
. . . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . property Σ I 1..1 code A property/filter defined by the code system
. . . . . . op Σ I 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Binding: FilterOperator ( required ) ): The kind of operation to perform as a part of a property based filter.

. . . . . . value Σ I 1..1 string Code from the system, or regex criteria, or boolean value for exists
. . . . . valueSet Σ I 0..* canonical ( ValueSet ) Select the contents included in this value set
. . . . . copyright 0..1 string A copyright statement for the specific code system included in the value set
.... exclude I 0..* See include (ValueSet) Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets
. . . . property 0..* string Property to return if client doesn't override
.. . expansion I 0..1 BackboneElement Used when the value set is "expanded"
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . identifier I 0..1 uri Identifies the value set expansion (business identifier)
. . . . timestamp I 1..1 dateTime Time ValueSet expansion happened
. . . . total I 0..1 integer Total number of codes in the expansion
. . . . offset I 0..1 integer Offset at which this resource starts
. . . . parameter I 0..* BackboneElement Parameter that controlled the expansion process
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . name I 1..1 string Name as assigned by the client or server
. . . . . value[x] I 0..1 Value of the named parameter
. . . . . . valueString string
. . . . . . valueBoolean boolean
. . . . . . valueInteger integer
. . . . . . valueDecimal decimal
. . . . . . valueUri uri
. . . . . . valueCode code
. . . . . . valueDateTime dateTime
. . . . property 0..* BackboneElement Additional information supplied about each concept
..... id 0..1 id 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 Identifies the property on the concepts, and when referred to in operations
... . . uri 0..1 uri Formal identifier for the property
... . contains I 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . system I 0..1 uri System value for the code
. . . . . abstract I 0..1 boolean If user cannot select this entry
. . . . . inactive I 0..1 boolean If concept is inactive in the code system
. . . . . version I 0..1 string Version in which this code/display is defined
. . . . . code I 0..1 code Code - if blank, this is not a selectable code
. . . . . display I 0..1 string User display for the concept
. . . . . designation I 0..* See designation (ValueSet) Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item
. . . . . property 0..* BackboneElement Property value for the concept
.. . . contains . . id 0..1 id Unique id for inter-element referencing
...... extension I 0..* Extension Additional content defined by implementations
...... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code Unknown reference 1..1 code Reference to #ValueSet.expansion.contains 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
....... valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
. . . scope 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover
.... id 0..1 id 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
.... focus 0..1 string General focus of the Value Set as it relates to the intended semantic space
.... 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
<!-- Shareable ValueSet -->doco
< xmlns="http://hl7.org/fhir"

<ValueSet xmlns="http://hl7.org/fhir"

>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

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

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <

 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this value set, represented as a URI (globally unique) -->

 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the value set (business identifier) --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the value set -->
 <name value="[string]"/><!-- ?? 1..1 Name for this value set (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this value set (human friendly) -->
 <

 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown    -->

 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <

 <publisher value="[string]"/><!-- ?? 0..1 Name of the publisher (organization or individual) -->

 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <

 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the value set -->

 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for value set (if applicable)   --></jurisdiction>
 <immutable value="[boolean]"/><!-- ?? 0..1 Indicates whether or not any change to the content logical definition may occur -->
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this value set is defined -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <

 <compose> ?? 0..1 BackboneElement  <!-- ?? 0..1 Content logical definition of the value set (CLD) -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <lockedDate value="[date]"/><!-- ?? 0..1 Fixed date for references with no specified version (transitive) -->
  <inactive value="[boolean]"/><!-- ?? 0..1 Whether inactive codes are in the value set -->
  <

  <include> ?? 1..* BackboneElement  <!-- ?? 1..* Include one or more codes from a code system or other value set(s) -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 The system the codes come from -->
   <version value="[string]"/><!-- ?? 0..1 Specific version of the code system referred to -->
   <

   <concept> ?? 0..* BackboneElement  <!-- ?? 0..* A concept defined in the system -->

    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- ?? 1..1 Code or expression from system -->
    <display value="[string]"/><!-- ?? 0..1 
        Text to display for this code for this value set in this valueset -->
    <

    <designation> ?? 0..* BackboneElement  <!-- ?? 0..* Additional representations for this concept -->

     <modifierExtension><!-- ?? 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <language value="[code]"/><!-- ?? 0..1 Human language of the designation   -->
     <use><!-- ?? 0..1 Coding Types of uses of designations   --></use>
     <value value="[string]"/><!-- ?? 1..1 The text value for this designation -->
    </designation>
   </concept>
   <

   <filter> ?? 0..* BackboneElement  <!-- ?? 0..* Select codes/concepts by their properties (including relationships) -->

    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <property value="[code]"/><!-- ?? 1..1 A property/filter defined by the code system -->
    <

    <op value="[code]"/><!-- ?? 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists    -->

    <value value="[string]"/><!-- ?? 1..1 
        Code from the system, or regex criteria, or boolean value for exists -->
   </filter>
   <

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

  </include>
  <</exclude>

  <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]"/><!-- ?? 0..* Property to return if client doesn't override -->

 </compose>
 <

 <expansion> ?? 0..1 BackboneElement  <!-- ?? 0..1 Used when the value set is "expanded" -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <identifier value="[uri]"/><!-- ?? 0..1 Identifies the value set expansion (business identifier) -->
  <timestamp value="[dateTime]"/><!-- ?? 1..1 Time ValueSet expansion happened -->
  <total value="[integer]"/><!-- ?? 0..1 Total number of codes in the expansion -->
  <offset value="[integer]"/><!-- ?? 0..1 Offset at which this resource starts -->
  <

  <parameter> ?? 0..* BackboneElement  <!-- ?? 0..* Parameter that controlled the expansion process -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <name value="[string]"/><!-- ?? 1..1 Name as assigned by the client or server -->
   <value[x]><!-- ?? 0..1 string|boolean|integer|
     decimal|uri|code|dateTime Value of the named parameter --></value[x]>
  </parameter>
  <

  <property> ?? 0..* BackboneElement  <!-- ?? 0..* Additional information supplied about each concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- ?? 1..1 
       Identifies the property on the concepts, and when referred to in operations -->
   <uri value="[uri]"/><!-- ?? 0..1 Formal identifier for the property -->
  </property>
  <contains> ?? 0..* BackboneElement  <!-- ?? 0..* Codes in the value set -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 System value for the code -->
   <abstract value="[boolean]"/><!-- ?? 0..1 If user cannot select this entry -->
   <inactive value="[boolean]"/><!-- ?? 0..1 If concept is inactive in the code system -->
   <version value="[string]"/><!-- ?? 0..1 Version in which this code/display is defined -->
   <code value="[code]"/><!-- ?? 0..1 Code - if blank, this is not a selectable code -->
   <display value="[string]"/><!-- ?? 0..1 User display for the concept -->
   <</designation>
   <</contains>

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

  </contains>
 </expansion>
 <scope> ?? 0..1 BackboneElement  <!-- ?? 0..1 Description of the semantic space the Value Set Expansion is intended to cover -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <focus value="[string]"/><!-- ?? 0..1 General focus of the Value Set as it relates to the intended semantic space -->
  <inclusionCriteria value="[string]"/><!-- ?? 0..1 
      Criteria describing which concepts or codes should be included and why -->
  <exclusionCriteria value="[string]"/><!-- ?? 0..1 
      Criteria describing which concepts or codes should be excluded and why -->
 </scope>

</ValueSet>
{ // Shareable ValueSet
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], //Contained, inline Resources

    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "

    "url" : "<uri>", // C? R! Canonical identifier for this value set, represented as a URI (globally unique)

    "identifier" : [{ Identifier }], // C?Additional identifier for the value set (business identifier)
    "version" : "<string>", // C? R! Business version of the value set
    "name" : "<string>", // C? R! Name for this value set (computer friendly)
    "title" : "<string>", // C?Name for this value set (human friendly)
    "

    "status" : "<code>", // C? R! draft | active | retired | unknown 

    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "date" : "<dateTime>", // C?Date last changed
    "

    "publisher" : "<string>", // C?Name of the publisher (organization or individual)

    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "

    "description" : "<markdown>", // C?Natural language description of the value set

    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for value set (if applicable)
    "immutable" : <boolean>, // C?Indicates whether or not any change to the content logical definition may occur
    "purpose" : "<markdown>", // C?Why this value set is defined
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "
    "

    "compose" : { BackboneElement }, // C?Content logical definition of the value set (CLD)
    "expansion" : { BackboneElement }, // C?Used when the value set is "expanded"
    "scope" : { BackboneElement } // C?Description of the semantic space the Value Set Expansion is intended to cover

  }

This structure is derived from ValueSet .

Summary

Mandatory: 7 5 elements

Differential View

This structure is derived from ValueSet .

Name Flags Card. Type Description & Constraints doco
. . ValueSet 1..1 ValueSet A set of codes drawn from one or more code systems
. . . url 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
. . . version 1..1 string Business version of the value set
. . . name 1..1 string Name for this value set (computer friendly)
. . . experimental 1..1 boolean For testing purposes, not real usage
. . . publisher 1..1 0 .. 1 string Name of the publisher (organization or individual)
. . . description 1..1 0 .. 1 markdown Natural language description of the value set

doco Documentation for this format

Snapshot View

Name Flags Card. Type Description & Constraints doco
. . ValueSet I 1..1 ValueSet A set of codes drawn from one or more code systems
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred )
Max Binding: All Languages : IETF language tag

. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . url Σ I 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
. . . identifier Σ I 0..* Identifier Additional identifier for the value set (business identifier)
. . . version Σ I 1..1 string Business version of the value set
. . . name Σ I 1..1 string Name for this value set (computer friendly)
. . . title Σ I 0..1 string Name for this value set (human friendly)
. . . status ?! Σ I 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ) ): The lifecycle status of an artifact.

. . . experimental Σ I 1..1 boolean For testing purposes, not real usage
. . . date Σ I 0..1 dateTime Date last changed
. . . publisher Σ I 1..1 0..1 string Name of the publisher (organization or individual)
. . . contact Σ I 0..* ContactDetail Contact details for the publisher
. . . description I 1..1 0..1 markdown Natural language description of the value set
. . . useContext Σ I 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ I 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ( extensible ) ): Countries and regions within which this artifact is targeted for use.


. . . immutable Σ I 0..1 boolean Indicates whether or not any change to the content logical definition may occur
. . . purpose I 0..1 markdown Why this value set is defined
. . . copyright I 0..1 markdown Use and/or publishing restrictions
. . . compose I 0..1 BackboneElement Content logical definition of the value set (CLD)
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . lockedDate Σ I 0..1 date Fixed date for references with no specified version (transitive)
. . . . inactive Σ I 0..1 boolean Whether inactive codes are in the value set
. . . . include Σ I 1..* BackboneElement Include one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . system Σ I 0..1 uri The system the codes come from
. . . . . version Σ I 0..1 string Specific version of the code system referred to
. . . . . concept I 0..* BackboneElement A concept defined in the system
. . . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . code I 1..1 code Code or expression from system
. . . . . . display I 0..1 string Text to display for this code for this value set in this valueset
. . . . . . designation I 0..* BackboneElement Additional representations for this concept
. . . . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . . language I 0..1 code Human language of the designation
Binding: Common Languages ( preferred )
Max Binding: All Languages : IETF language tag

. . . . . . . use I 0..1 Coding Types of uses of designations
Binding: Designation Use ( extensible ) ): Details of how a designation would be used.

. . . . . . . value I 1..1 string The text value for this designation
. . . . . filter Σ I 0..* BackboneElement Select codes/concepts by their properties (including relationships)
. . . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . property Σ I 1..1 code A property/filter defined by the code system
. . . . . . op Σ I 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Binding: FilterOperator ( required ) ): The kind of operation to perform as a part of a property based filter.

. . . . . . value Σ I 1..1 string Code from the system, or regex criteria, or boolean value for exists
. . . . . valueSet Σ I 0..* canonical ( ValueSet ) Select the contents included in this value set
. . . . . copyright 0..1 string A copyright statement for the specific code system included in the value set
.... exclude I 0..* See include (ValueSet) Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets
. . . . property 0..* string Property to return if client doesn't override
.. . expansion I 0..1 BackboneElement Used when the value set is "expanded"
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . identifier I 0..1 uri Identifies the value set expansion (business identifier)
. . . . timestamp I 1..1 dateTime Time ValueSet expansion happened
. . . . total I 0..1 integer Total number of codes in the expansion
. . . . offset I 0..1 integer Offset at which this resource starts
. . . . parameter I 0..* BackboneElement Parameter that controlled the expansion process
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . name I 1..1 string Name as assigned by the client or server
. . . . . value[x] I 0..1 Value of the named parameter
. . . . . . valueString string
. . . . . . valueBoolean boolean
. . . . . . valueInteger integer
. . . . . . valueDecimal decimal
. . . . . . valueUri uri
. . . . . . valueCode code
. . . . . . valueDateTime dateTime
. . . . property 0..* BackboneElement Additional information supplied about each concept
..... id 0..1 id 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 Identifies the property on the concepts, and when referred to in operations
... . . uri 0..1 uri Formal identifier for the property
... . contains I 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . system I 0..1 uri System value for the code
. . . . . abstract I 0..1 boolean If user cannot select this entry
. . . . . inactive I 0..1 boolean If concept is inactive in the code system
. . . . . version I 0..1 string Version in which this code/display is defined
. . . . . code I 0..1 code Code - if blank, this is not a selectable code
. . . . . display I 0..1 string User display for the concept
. . . . . designation I 0..* See designation (ValueSet) Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item
. . . . . property 0..* BackboneElement Property value for the concept
.. . . contains . . id 0..1 id Unique id for inter-element referencing
...... extension I 0..* Extension Additional content defined by implementations
...... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code Unknown reference 1..1 code Reference to #ValueSet.expansion.contains 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
....... valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
. . . scope 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover
.... id 0..1 id 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
.... focus 0..1 string General focus of the Value Set as it relates to the intended semantic space
.... 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

XML Template

<!-- Shareable ValueSet -->doco
< xmlns="http://hl7.org/fhir"

<ValueSet xmlns="http://hl7.org/fhir"

>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

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

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <

 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this value set, represented as a URI (globally unique) -->

 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the value set (business identifier) --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the value set -->
 <name value="[string]"/><!-- ?? 1..1 Name for this value set (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this value set (human friendly) -->
 <

 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown    -->

 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <

 <publisher value="[string]"/><!-- ?? 0..1 Name of the publisher (organization or individual) -->

 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <

 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the value set -->

 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for value set (if applicable)   --></jurisdiction>
 <immutable value="[boolean]"/><!-- ?? 0..1 Indicates whether or not any change to the content logical definition may occur -->
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this value set is defined -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <

 <compose> ?? 0..1 BackboneElement  <!-- ?? 0..1 Content logical definition of the value set (CLD) -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <lockedDate value="[date]"/><!-- ?? 0..1 Fixed date for references with no specified version (transitive) -->
  <inactive value="[boolean]"/><!-- ?? 0..1 Whether inactive codes are in the value set -->
  <

  <include> ?? 1..* BackboneElement  <!-- ?? 1..* Include one or more codes from a code system or other value set(s) -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 The system the codes come from -->
   <version value="[string]"/><!-- ?? 0..1 Specific version of the code system referred to -->
   <

   <concept> ?? 0..* BackboneElement  <!-- ?? 0..* A concept defined in the system -->

    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- ?? 1..1 Code or expression from system -->
    <display value="[string]"/><!-- ?? 0..1 
        Text to display for this code for this value set in this valueset -->
    <

    <designation> ?? 0..* BackboneElement  <!-- ?? 0..* Additional representations for this concept -->

     <modifierExtension><!-- ?? 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <language value="[code]"/><!-- ?? 0..1 Human language of the designation   -->
     <use><!-- ?? 0..1 Coding Types of uses of designations   --></use>
     <value value="[string]"/><!-- ?? 1..1 The text value for this designation -->
    </designation>
   </concept>
   <

   <filter> ?? 0..* BackboneElement  <!-- ?? 0..* Select codes/concepts by their properties (including relationships) -->

    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <property value="[code]"/><!-- ?? 1..1 A property/filter defined by the code system -->
    <

    <op value="[code]"/><!-- ?? 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists    -->

    <value value="[string]"/><!-- ?? 1..1 
        Code from the system, or regex criteria, or boolean value for exists -->
   </filter>
   <

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

  </include>
  <</exclude>

  <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]"/><!-- ?? 0..* Property to return if client doesn't override -->

 </compose>
 <

 <expansion> ?? 0..1 BackboneElement  <!-- ?? 0..1 Used when the value set is "expanded" -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <identifier value="[uri]"/><!-- ?? 0..1 Identifies the value set expansion (business identifier) -->
  <timestamp value="[dateTime]"/><!-- ?? 1..1 Time ValueSet expansion happened -->
  <total value="[integer]"/><!-- ?? 0..1 Total number of codes in the expansion -->
  <offset value="[integer]"/><!-- ?? 0..1 Offset at which this resource starts -->
  <

  <parameter> ?? 0..* BackboneElement  <!-- ?? 0..* Parameter that controlled the expansion process -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <name value="[string]"/><!-- ?? 1..1 Name as assigned by the client or server -->
   <value[x]><!-- ?? 0..1 string|boolean|integer|
     decimal|uri|code|dateTime Value of the named parameter --></value[x]>
  </parameter>
  <

  <property> ?? 0..* BackboneElement  <!-- ?? 0..* Additional information supplied about each concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- ?? 1..1 
       Identifies the property on the concepts, and when referred to in operations -->
   <uri value="[uri]"/><!-- ?? 0..1 Formal identifier for the property -->
  </property>
  <contains> ?? 0..* BackboneElement  <!-- ?? 0..* Codes in the value set -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 System value for the code -->
   <abstract value="[boolean]"/><!-- ?? 0..1 If user cannot select this entry -->
   <inactive value="[boolean]"/><!-- ?? 0..1 If concept is inactive in the code system -->
   <version value="[string]"/><!-- ?? 0..1 Version in which this code/display is defined -->
   <code value="[code]"/><!-- ?? 0..1 Code - if blank, this is not a selectable code -->
   <display value="[string]"/><!-- ?? 0..1 User display for the concept -->
   <</designation>
   <</contains>

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

  </contains>
 </expansion>
 <scope> ?? 0..1 BackboneElement  <!-- ?? 0..1 Description of the semantic space the Value Set Expansion is intended to cover -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <focus value="[string]"/><!-- ?? 0..1 General focus of the Value Set as it relates to the intended semantic space -->
  <inclusionCriteria value="[string]"/><!-- ?? 0..1 
      Criteria describing which concepts or codes should be included and why -->
  <exclusionCriteria value="[string]"/><!-- ?? 0..1 
      Criteria describing which concepts or codes should be excluded and why -->
 </scope>

</ValueSet>

JSON Template

{ // Shareable ValueSet
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], //Contained, inline Resources

    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "

    "url" : "<uri>", // C? R! Canonical identifier for this value set, represented as a URI (globally unique)

    "identifier" : [{ Identifier }], // C?Additional identifier for the value set (business identifier)
    "version" : "<string>", // C? R! Business version of the value set
    "name" : "<string>", // C? R! Name for this value set (computer friendly)
    "title" : "<string>", // C?Name for this value set (human friendly)
    "

    "status" : "<code>", // C? R! draft | active | retired | unknown 

    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "date" : "<dateTime>", // C?Date last changed
    "

    "publisher" : "<string>", // C?Name of the publisher (organization or individual)

    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "

    "description" : "<markdown>", // C?Natural language description of the value set

    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for value set (if applicable)
    "immutable" : <boolean>, // C?Indicates whether or not any change to the content logical definition may occur
    "purpose" : "<markdown>", // C?Why this value set is defined
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "
    "

    "compose" : { BackboneElement }, // C?Content logical definition of the value set (CLD)
    "expansion" : { BackboneElement }, // C?Used when the value set is "expanded"
    "scope" : { BackboneElement } // C?Description of the semantic space the Value Set Expansion is intended to cover

  }

 

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

Path Name Conformance ValueSet
ValueSet.language Common Languages preferred Common Languages
ValueSet.status PublicationStatus required PublicationStatus
ValueSet.jurisdiction Jurisdiction extensible Jurisdiction
ValueSet.compose.include.concept.designation.language Common Languages preferred Common Languages
ValueSet.compose.include.concept.designation.use Designation Use extensible Designation Use
ValueSet.compose.include.filter.op FilterOperator required FilterOperator
4.9.18.2.3 Constraints Rule Rule Rule Rule Rule Rule Id Path Details Requirements vsd-1 ValueSet.compose.include A value set include/exclude SHALL have a value set or a system Expression : valueSet.exists() or system.exists() vsd-2 ValueSet.compose.include A value set with concepts or filters SHALL include a system Expression : (concept.exists() or filter.exists()) implies system.exists() vsd-3 ValueSet.compose.include Cannot have both concept and filter Expression : concept.empty() or filter.empty() vsd-6 ValueSet.expansion.contains SHALL have a code or a display Expression : code.exists() or display.exists() vsd-9 ValueSet.expansion.contains Must have a code if not abstract Expression : code.exists() or abstract = true vsd-10 ValueSet.expansion.contains Must have a system if a code is present Expression : code.empty() or system.exists() .