Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - 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

4.9.20.7 StructureDefinition: PublishableValueSet

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

The canonical URL for this profile is: 

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

Defines and enforces the minimum expectations for publication and distribution of a value set, typically as part of an artifact repository or implementation guide publication

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.

4.9.20.7.1 Formal Views of Profile Content

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

This structure is derived from ShareableValueSet.

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: 1 element
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base ShareableValueSet structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1ShareableValueSetA set of codes drawn from one or more code systems
... trustedExpansion S0..1urlReference to a trusted expansion
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... otherTitle 0..*(Complex)Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
... sourceReference 0..1uriWhere did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for value set (if applicable)
... purpose S0..1markdownWhy this value set is defined
... copyright S0..1markdownUse and/or publishing restrictions
... copyrightLabel S0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the ValueSet was approved by publisher
... lastReviewDate 0..1dateWhen the ValueSet was last reviewed by the publisher
... effectivePeriod S0..1PeriodWhen the ValueSet is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
... author 0..*ContactDetailWho authored the ValueSet
... editor 0..*ContactDetailWho edited the ValueSet
... reviewer 0..*ContactDetailWho reviewed the ValueSet
... endorser 0..*ContactDetailWho endorsed the ValueSet
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... composeCreatedBy 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... composeCreationDate 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... include 1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... copyright S0..1stringA copyright statement for the specific code system included in 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 ShareableValueSet structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C icon1..1ShareableValueSetA set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... authoritativeSource S0..1uriReference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
... trustedExpansion S0..1urlReference to a trusted expansion
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... otherTitle 0..*(Complex)Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
... sourceReference 0..1uriWhere did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the value set (business identifier)
... version SΣ1..1stringBusiness version of the value set
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this value set (computer friendly)
... title SΣ1..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose S0..1markdownWhy this value set is defined
... copyright S0..1markdownUse and/or publishing restrictions
... copyrightLabel S0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the ValueSet was approved by publisher
... lastReviewDate 0..1dateWhen the ValueSet was last reviewed by the publisher
... effectivePeriod SΣ0..1PeriodWhen the ValueSet is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author 0..*ContactDetailWho authored the ValueSet
... editor 0..*ContactDetailWho edited the ValueSet
... reviewer 0..*ContactDetailWho reviewed the ValueSet
... endorser 0..*ContactDetailWho endorsed the ValueSet
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... composeCreatedBy 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... composeCreationDate 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lockedDate Σ0..1dateFixed date for references with no specified version (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣC icon1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system ΣC icon0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept C icon0..*BackboneElementA concept defined in the system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation C icon0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language 0..1codeHuman language of the designation
Binding: All Languages (required): IETF language tag for a human language

....... use C icon0..1CodingTypes of uses of designations
Binding: Designation Use (extensible): Details of how a designation would be used.

....... additionalUse C iconTU0..*CodingAdditional ways how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.


....... value 1..1stringThe text value for this designation
..... filter ΣC icon0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Binding: Filter Operator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC icon0..*canonical(ValueSet)Select the contents included in this value set
..... copyright S0..1stringA 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 TU0..*stringProperty to return if client doesn't override
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... next TU0..1uriOpaque urls for paging through expansion results
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... property TU0..*BackboneElementAdditional information supplied about each concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeIdentifies the property on the concepts, and when referred to in operations
..... uri 0..1uriFormal identifier for the property
.... contains C icon0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system C icon0..1uriSystem value for the code
..... abstract C icon0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code C icon0..1codeCode - if blank, this is not a selectable code
..... display C icon0..1stringUser display for the concept
..... designation 0..*See designation (ValueSet)Additional representations for this item
..... property TU0..*BackboneElementProperty value for the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 1..1codeReference to ValueSet.expansion.property.code
...... value[x] 1..1Value of the property for this concept
....... valueCodecode
....... valueCodingCoding
....... valueStringstring
....... valueIntegerinteger
....... valueBooleanboolean
....... valueDateTimedateTime
....... valueDecimaldecimal
...... subProperty 0..*BackboneElementSubProperty value for the concept
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... code 1..1codeReference to ValueSet.expansion.property.code
....... value[x] 1..1Value of the subproperty for this concept
........ valueCodecode
........ valueCodingCoding
........ valueStringstring
........ valueIntegerinteger
........ valueBooleanboolean
........ valueDateTimedateTime
........ valueDecimaldecimal
..... contains 0..*See contains (ValueSet)Codes contained under this entry
... scope TU0..1BackboneElementDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... inclusionCriteria 0..1stringCriteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1stringCriteria describing which concepts or codes should be excluded and why

doco Documentation for this format icon
<!-- PublishableValueSet -->doco

<ValueSet xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <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>
 <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 1..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><!-- 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) -->
  <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) -->
   <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 -->
    <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 -->
    <designation> I 0..* BackboneElement  <!-- I 0..* Additional representations for this concept -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <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>
   <filter> I 0..* BackboneElement  <!-- I 0..* Select codes/concepts by their properties (including relationships) -->
    <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>
 <expansion> I 0..1 BackboneElement  <!-- I 0..1 Used when the value set is "expanded" -->
  <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 -->
   <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>
  <property> I 0..* BackboneElement  <!-- I 0..* Additional information supplied about each concept -->
   <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>

{ // PublishableValueSet
  // from Element: extension
    "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
      },
      { // Reference to a trusted expansion // I
        // from Element: extension
      },
      { // Alternative titles // I
        // from Element: extension
      },
      { // Where did this content come from // I
        // from Element: extension
      }
    ],
    "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>", // I R! Date 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 ShareableValueSet.

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: 1 element
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

Differential View

This indicates the differences between this profile and the base ShareableValueSet structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1ShareableValueSetA set of codes drawn from one or more code systems
... trustedExpansion S0..1urlReference to a trusted expansion
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... otherTitle 0..*(Complex)Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
... sourceReference 0..1uriWhere did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for value set (if applicable)
... purpose S0..1markdownWhy this value set is defined
... copyright S0..1markdownUse and/or publishing restrictions
... copyrightLabel S0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the ValueSet was approved by publisher
... lastReviewDate 0..1dateWhen the ValueSet was last reviewed by the publisher
... effectivePeriod S0..1PeriodWhen the ValueSet is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
... author 0..*ContactDetailWho authored the ValueSet
... editor 0..*ContactDetailWho edited the ValueSet
... reviewer 0..*ContactDetailWho reviewed the ValueSet
... endorser 0..*ContactDetailWho endorsed the ValueSet
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... composeCreatedBy 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... composeCreationDate 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... include 1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... copyright S0..1stringA copyright statement for the specific code system included in 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 ShareableValueSet structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C icon1..1ShareableValueSetA set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... authoritativeSource S0..1uriReference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
... trustedExpansion S0..1urlReference to a trusted expansion
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... otherTitle 0..*(Complex)Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
... sourceReference 0..1uriWhere did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the value set (business identifier)
... version SΣ1..1stringBusiness version of the value set
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this value set (computer friendly)
... title SΣ1..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose S0..1markdownWhy this value set is defined
... copyright S0..1markdownUse and/or publishing restrictions
... copyrightLabel S0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the ValueSet was approved by publisher
... lastReviewDate 0..1dateWhen the ValueSet was last reviewed by the publisher
... effectivePeriod SΣ0..1PeriodWhen the ValueSet is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author 0..*ContactDetailWho authored the ValueSet
... editor 0..*ContactDetailWho edited the ValueSet
... reviewer 0..*ContactDetailWho reviewed the ValueSet
... endorser 0..*ContactDetailWho endorsed the ValueSet
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... composeCreatedBy 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... composeCreationDate 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lockedDate Σ0..1dateFixed date for references with no specified version (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣC icon1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system ΣC icon0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept C icon0..*BackboneElementA concept defined in the system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation C icon0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language 0..1codeHuman language of the designation
Binding: All Languages (required): IETF language tag for a human language

....... use C icon0..1CodingTypes of uses of designations
Binding: Designation Use (extensible): Details of how a designation would be used.

....... additionalUse C iconTU0..*CodingAdditional ways how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.


....... value 1..1stringThe text value for this designation
..... filter ΣC icon0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Binding: Filter Operator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC icon0..*canonical(ValueSet)Select the contents included in this value set
..... copyright S0..1stringA 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 TU0..*stringProperty to return if client doesn't override
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... next TU0..1uriOpaque urls for paging through expansion results
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... property TU0..*BackboneElementAdditional information supplied about each concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeIdentifies the property on the concepts, and when referred to in operations
..... uri 0..1uriFormal identifier for the property
.... contains C icon0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system C icon0..1uriSystem value for the code
..... abstract C icon0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code C icon0..1codeCode - if blank, this is not a selectable code
..... display C icon0..1stringUser display for the concept
..... designation 0..*See designation (ValueSet)Additional representations for this item
..... property TU0..*BackboneElementProperty value for the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 1..1codeReference to ValueSet.expansion.property.code
...... value[x] 1..1Value of the property for this concept
....... valueCodecode
....... valueCodingCoding
....... valueStringstring
....... valueIntegerinteger
....... valueBooleanboolean
....... valueDateTimedateTime
....... valueDecimaldecimal
...... subProperty 0..*BackboneElementSubProperty value for the concept
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... code 1..1codeReference to ValueSet.expansion.property.code
....... value[x] 1..1Value of the subproperty for this concept
........ valueCodecode
........ valueCodingCoding
........ valueStringstring
........ valueIntegerinteger
........ valueBooleanboolean
........ valueDateTimedateTime
........ valueDecimaldecimal
..... contains 0..*See contains (ValueSet)Codes contained under this entry
... scope TU0..1BackboneElementDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... inclusionCriteria 0..1stringCriteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1stringCriteria describing which concepts or codes should be excluded and why

doco Documentation for this format icon

XML Template

<!-- PublishableValueSet -->doco

<ValueSet xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <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>
 <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 1..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><!-- 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) -->
  <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) -->
   <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 -->
    <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 -->
    <designation> I 0..* BackboneElement  <!-- I 0..* Additional representations for this concept -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <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>
   <filter> I 0..* BackboneElement  <!-- I 0..* Select codes/concepts by their properties (including relationships) -->
    <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>
 <expansion> I 0..1 BackboneElement  <!-- I 0..1 Used when the value set is "expanded" -->
  <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 -->
   <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>
  <property> I 0..* BackboneElement  <!-- I 0..* Additional information supplied about each concept -->
   <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

{ // PublishableValueSet
  // from Element: extension
    "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
      },
      { // Reference to a trusted expansion // I
        // from Element: extension
      },
      { // Alternative titles // I
        // from Element: extension
      },
      { // Where did this content come from // I
        // from Element: extension
      }
    ],
    "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>", // I R! Date 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

4.9.20.7.2 Terminology Bindings

PathNameConformanceValueSet
ValueSet.languageAll LanguagesrequiredAll Languages
ValueSet.versionAlgorithm[x]Version AlgorithmextensibleVersion Algorithm
ValueSet.statusPublicationStatusrequiredPublicationStatus
ValueSet.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
ValueSet.topicDefinition TopicexampleDefinition Topic
ValueSet.compose.include.concept.designation.languageAll LanguagesrequiredAll Languages
ValueSet.compose.include.concept.designation.useDesignation UseextensibleDesignation Use
ValueSet.compose.include.concept.designation.additionalUseDesignation UseextensibleDesignation Use
ValueSet.compose.include.filter.opFilter OperatorrequiredFilter Operator
. .