Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

4.9.20.2 StructureDefinition: ShareableValueSet

The canonical URL for this profile is:

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

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

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

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

4.9.20.2.1 Formal Views of Profile Content

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

This structure is derived from ValueSet.

Summary

mustSupport

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

Mandatory: 5 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

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

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

doco Documentation for this format icon

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

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

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

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


... immutable Σ0..1boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1markdown Why this value set is defined
... copyright 0..1markdown Use and/or publishing restrictions
... copyrightLabel TU 0..1string Copyright holder and year(s)
... approvalDate TU 0..1date When the ValueSet was approved by publisher
... lastReviewDate TU 0..1date When the ValueSet was last reviewed by the publisher
... effectivePeriod ΣTU 0..1Period When the ValueSet is expected to be used
... topic XD 0..*CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author TU 0..*ContactDetail Who authored the ValueSet
... editor TU 0..*ContactDetail Who edited the ValueSet
... reviewer TU 0..*ContactDetail Who reviewed the ValueSet
... endorser TU 0..*ContactDetail Who endorsed the ValueSet
... relatedArtifact TU 0..*RelatedArtifact Additional documentation, citations, etc
... compose 0..1BackboneElement Content logical definition of the value set (CLD)
.... id 0..1string Unique id for inter-element referencing
.... extension 0..*Extension Additional content defined by implementations
.... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ0..1date Fixed date for references with no specified version (transitive)
.... inactive Σ0..1boolean Whether inactive codes are in the value set
.... include ΣC icon 1..*BackboneElement Include one or more codes from a code system or other value set(s)
..... id 0..1string Unique id for inter-element referencing
..... extension 0..*Extension Additional content defined by implementations
..... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC icon 0..1uri The system the codes come from
..... version Σ0..1string Specific version of the code system referred to
..... concept C icon 0..*BackboneElement A concept defined in the system
...... id 0..1string 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..1code Code or expression from system
...... display 0..1string Text to display for this code for this value set in this valueset
...... designation C icon 0..*BackboneElement Additional representations for this concept
....... id 0..1string Unique id for inter-element referencing
....... extension 0..*Extension Additional content defined by implementations
....... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1code Human language of the designation
Binding: All Languages (required): IETF language tag for a human language

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

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


....... value 1..1string The text value for this designation
..... filter ΣC icon 0..*BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1string Unique id for inter-element referencing
...... extension 0..*Extension Additional content defined by implementations
...... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
...... property Σ1..1code A 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..1string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC icon 0..*canonical(ValueSet)Select the contents included in this value set
..... copyright TU 0..1string A copyright statement for the specific code system included in the value set
.... exclude 0..*See include (ValueSet) Explicitly exclude codes from a code system or other value sets
.... property TU 0..*string Property to return if client doesn't override
... expansion 0..1BackboneElement Used when the value set is "expanded"
.... id 0..1string Unique id for inter-element referencing
.... extension 0..*Extension Additional content defined by implementations
.... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1uri Identifies the value set expansion (business identifier)
.... next TU 0..1uri Opaque urls for paging through expansion results
.... timestamp 1..1dateTime Time ValueSet expansion happened
.... total 0..1integer Total number of codes in the expansion
.... offset 0..1integer Offset at which this resource starts
.... parameter 0..*BackboneElement Parameter that controlled the expansion process
..... id 0..1string Unique id for inter-element referencing
..... extension 0..*Extension Additional content defined by implementations
..... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1string Name as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... property TU 0..*BackboneElement Additional information supplied about each concept
..... id 0..1string 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..1code Identifies the property on the concepts, and when referred to in operations
..... uri 0..1uri Formal identifier for the property
.... contains C icon 0..*BackboneElement Codes in the value set
..... id 0..1string Unique id for inter-element referencing
..... extension 0..*Extension Additional content defined by implementations
..... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
..... system C icon 0..1uri System value for the code
..... abstract C icon 0..1boolean If user cannot select this entry
..... inactive 0..1boolean If concept is inactive in the code system
..... version 0..1string Version in which this code/display is defined
..... code C icon 0..1code Code - if blank, this is not a selectable code
..... display C icon 0..1string User display for the concept
..... designation 0..*See designation (ValueSet) Additional representations for this item
..... property TU 0..*BackboneElement Property value for the concept
...... id 0..1string 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..1code Reference to ValueSet.expansion.property.code
...... value[x] 1..1Value of the property for this concept
....... valueCodecode
....... valueCodingCoding
....... valueStringstring
....... valueIntegerinteger
....... valueBooleanboolean
....... valueDateTimedateTime
....... valueDecimaldecimal
...... subProperty 0..*BackboneElement SubProperty value for the concept
....... id 0..1string 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..1code Reference 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 TU 0..1BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... id 0..1string Unique id for inter-element referencing
.... extension 0..*Extension Additional content defined by implementations
.... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
.... inclusionCriteria 0..1string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format icon
<!-- ShareableValueSet -->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 0..1 Date last changed -->
 <publisher value="[string ]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail  Contact details for the publisher --></contact>
 <description value="[markdown ]"/><!-- I 1..1 Natural language description of the value set -->
 <useContext><!-- I 0..* UsageContext  
 The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 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>
{ // ShareableValueSet
 // from Element: extension
 "meta" : { Meta  }, // I Metadata about the resource
 "implicitRules" : "<uri >", // I A set of rules under which this content was created
 "language" : "<code >", // I Language of the resource content 
 "text" : { Narrative  }, // I Text 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
 }
 ],
 "modifierExtension" : [{ Extension  }], // I Extensions that cannot be ignored
 "url" : "<uri >", // I  R! Canonical identifier for this value set, represented as a URI (globally unique)
 "identifier" : [{ Identifier  }], // I Additional 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 >", // I How to compare versions 
 "versionAlgorithmCoding" : { Coding  }, // I How to compare versions 
 "name" : "<string >", // I Name 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 Date last changed
 "publisher" : "<string >", // I Name of the publisher/steward (organization or individual)
 "contact" : [{ ContactDetail  }], // I Contact details for the publisher
 "description" : "<markdown >", // I  R! Natural language description of the value set
 "useContext" : [{ UsageContext  }], // I The context that the content is intended to support
 "jurisdiction" : [{ CodeableConcept  }], // I Intended jurisdiction for value set (if applicable) 
 "immutable" : <boolean >, // I Indicates whether or not any change to the content logical definition may occur
 "purpose" : "<markdown >", // I Why this value set is defined
 "copyright" : "<markdown >", // I Use and/or publishing restrictions
 "copyrightLabel" : "<string >", // I Copyright holder and year(s)
 "approvalDate" : "<date >", // I When the ValueSet was approved by publisher
 "lastReviewDate" : "<date >", // I When the ValueSet was last reviewed by the publisher
 "effectivePeriod" : { Period  }, // I When the ValueSet is expected to be used
 "topic" : [{ CodeableConcept  }], // I E.g. Education, Treatment, Assessment, etc 
 "author" : [{ ContactDetail  }], // I Who authored the ValueSet
 "editor" : [{ ContactDetail  }], // I Who edited the ValueSet
 "reviewer" : [{ ContactDetail  }], // I Who reviewed the ValueSet
 "endorser" : [{ ContactDetail  }], // I Who endorsed the ValueSet
 "relatedArtifact" : [{ RelatedArtifact  }], // I Additional documentation, citations, etc
 "compose" : { BackboneElement  }, // I Content logical definition of the value set (CLD)
 "expansion" : { BackboneElement  }, // I Used when the value set is "expanded"
 "scope" : { BackboneElement  }, // I Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
 }

This structure is derived from ValueSet.

Summary

mustSupport

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

Mandatory: 5 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Differential View

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

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

doco Documentation for this format icon

Snapshot View

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

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

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

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


... immutable Σ0..1boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1markdown Why this value set is defined
... copyright 0..1markdown Use and/or publishing restrictions
... copyrightLabel TU 0..1string Copyright holder and year(s)
... approvalDate TU 0..1date When the ValueSet was approved by publisher
... lastReviewDate TU 0..1date When the ValueSet was last reviewed by the publisher
... effectivePeriod ΣTU 0..1Period When the ValueSet is expected to be used
... topic XD 0..*CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author TU 0..*ContactDetail Who authored the ValueSet
... editor TU 0..*ContactDetail Who edited the ValueSet
... reviewer TU 0..*ContactDetail Who reviewed the ValueSet
... endorser TU 0..*ContactDetail Who endorsed the ValueSet
... relatedArtifact TU 0..*RelatedArtifact Additional documentation, citations, etc
... compose 0..1BackboneElement Content logical definition of the value set (CLD)
.... id 0..1string Unique id for inter-element referencing
.... extension 0..*Extension Additional content defined by implementations
.... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ0..1date Fixed date for references with no specified version (transitive)
.... inactive Σ0..1boolean Whether inactive codes are in the value set
.... include ΣC icon 1..*BackboneElement Include one or more codes from a code system or other value set(s)
..... id 0..1string Unique id for inter-element referencing
..... extension 0..*Extension Additional content defined by implementations
..... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC icon 0..1uri The system the codes come from
..... version Σ0..1string Specific version of the code system referred to
..... concept C icon 0..*BackboneElement A concept defined in the system
...... id 0..1string 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..1code Code or expression from system
...... display 0..1string Text to display for this code for this value set in this valueset
...... designation C icon 0..*BackboneElement Additional representations for this concept
....... id 0..1string Unique id for inter-element referencing
....... extension 0..*Extension Additional content defined by implementations
....... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1code Human language of the designation
Binding: All Languages (required): IETF language tag for a human language

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

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


....... value 1..1string The text value for this designation
..... filter ΣC icon 0..*BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1string Unique id for inter-element referencing
...... extension 0..*Extension Additional content defined by implementations
...... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
...... property Σ1..1code A 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..1string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC icon 0..*canonical(ValueSet)Select the contents included in this value set
..... copyright TU 0..1string A copyright statement for the specific code system included in the value set
.... exclude 0..*See include (ValueSet) Explicitly exclude codes from a code system or other value sets
.... property TU 0..*string Property to return if client doesn't override
... expansion 0..1BackboneElement Used when the value set is "expanded"
.... id 0..1string Unique id for inter-element referencing
.... extension 0..*Extension Additional content defined by implementations
.... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1uri Identifies the value set expansion (business identifier)
.... next TU 0..1uri Opaque urls for paging through expansion results
.... timestamp 1..1dateTime Time ValueSet expansion happened
.... total 0..1integer Total number of codes in the expansion
.... offset 0..1integer Offset at which this resource starts
.... parameter 0..*BackboneElement Parameter that controlled the expansion process
..... id 0..1string Unique id for inter-element referencing
..... extension 0..*Extension Additional content defined by implementations
..... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1string Name as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... property TU 0..*BackboneElement Additional information supplied about each concept
..... id 0..1string 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..1code Identifies the property on the concepts, and when referred to in operations
..... uri 0..1uri Formal identifier for the property
.... contains C icon 0..*BackboneElement Codes in the value set
..... id 0..1string Unique id for inter-element referencing
..... extension 0..*Extension Additional content defined by implementations
..... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
..... system C icon 0..1uri System value for the code
..... abstract C icon 0..1boolean If user cannot select this entry
..... inactive 0..1boolean If concept is inactive in the code system
..... version 0..1string Version in which this code/display is defined
..... code C icon 0..1code Code - if blank, this is not a selectable code
..... display C icon 0..1string User display for the concept
..... designation 0..*See designation (ValueSet) Additional representations for this item
..... property TU 0..*BackboneElement Property value for the concept
...... id 0..1string 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..1code Reference to ValueSet.expansion.property.code
...... value[x] 1..1Value of the property for this concept
....... valueCodecode
....... valueCodingCoding
....... valueStringstring
....... valueIntegerinteger
....... valueBooleanboolean
....... valueDateTimedateTime
....... valueDecimaldecimal
...... subProperty 0..*BackboneElement SubProperty value for the concept
....... id 0..1string 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..1code Reference 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 TU 0..1BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... id 0..1string Unique id for inter-element referencing
.... extension 0..*Extension Additional content defined by implementations
.... modifierExtension ?!Σ0..*Extension Extensions that cannot be ignored even if unrecognized
.... inclusionCriteria 0..1string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format icon

XML Template

<!-- ShareableValueSet -->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 0..1 Date last changed -->
 <publisher value="[string ]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail  Contact details for the publisher --></contact>
 <description value="[markdown ]"/><!-- I 1..1 Natural language description of the value set -->
 <useContext><!-- I 0..* UsageContext  
 The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 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

{ // ShareableValueSet
 // from Element: extension
 "meta" : { Meta  }, // I Metadata about the resource
 "implicitRules" : "<uri >", // I A set of rules under which this content was created
 "language" : "<code >", // I Language of the resource content 
 "text" : { Narrative  }, // I Text 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
 }
 ],
 "modifierExtension" : [{ Extension  }], // I Extensions that cannot be ignored
 "url" : "<uri >", // I  R! Canonical identifier for this value set, represented as a URI (globally unique)
 "identifier" : [{ Identifier  }], // I Additional 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 >", // I How to compare versions 
 "versionAlgorithmCoding" : { Coding  }, // I How to compare versions 
 "name" : "<string >", // I Name 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 Date last changed
 "publisher" : "<string >", // I Name of the publisher/steward (organization or individual)
 "contact" : [{ ContactDetail  }], // I Contact details for the publisher
 "description" : "<markdown >", // I  R! Natural language description of the value set
 "useContext" : [{ UsageContext  }], // I The context that the content is intended to support
 "jurisdiction" : [{ CodeableConcept  }], // I Intended jurisdiction for value set (if applicable) 
 "immutable" : <boolean >, // I Indicates whether or not any change to the content logical definition may occur
 "purpose" : "<markdown >", // I Why this value set is defined
 "copyright" : "<markdown >", // I Use and/or publishing restrictions
 "copyrightLabel" : "<string >", // I Copyright holder and year(s)
 "approvalDate" : "<date >", // I When the ValueSet was approved by publisher
 "lastReviewDate" : "<date >", // I When the ValueSet was last reviewed by the publisher
 "effectivePeriod" : { Period  }, // I When the ValueSet is expected to be used
 "topic" : [{ CodeableConcept  }], // I E.g. Education, Treatment, Assessment, etc 
 "author" : [{ ContactDetail  }], // I Who authored the ValueSet
 "editor" : [{ ContactDetail  }], // I Who edited the ValueSet
 "reviewer" : [{ ContactDetail  }], // I Who reviewed the ValueSet
 "endorser" : [{ ContactDetail  }], // I Who endorsed the ValueSet
 "relatedArtifact" : [{ RelatedArtifact  }], // I Additional documentation, citations, etc
 "compose" : { BackboneElement  }, // I Content logical definition of the value set (CLD)
 "expansion" : { BackboneElement  }, // I Used when the value set is "expanded"
 "scope" : { BackboneElement  }, // I Description 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.2.2 Terminology Bindings

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

AltStyle によって変換されたページ (->オリジナル) /