Release 4
Vocabulary Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is:

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

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

This profile was published on [no date] as a draft by HL7.

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

This structure is derived from ValueSet.

Summary

Mandatory: 7 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1A set of codes drawn from one or more code systems
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier ΣI0..*IdentifierAdditional identifier for the value set (business identifier)
... version ΣI1..1stringBusiness version of the value set
... name ΣI1..1stringName for this value set (computer friendly)
... title ΣI0..1stringName for this value set (human friendly)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... date ΣI0..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description I1..1markdownNatural language description of the value set
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction (extensible)
... immutable ΣI0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose I0..1markdownWhy this value set is defined
... copyright I0..1markdownUse and/or publishing restrictions
... compose I0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lockedDate ΣI0..1dateFixed date for references with no specified version (transitive)
.... inactive ΣI0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system ΣI0..1uriThe system the codes come from
..... version ΣI0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code I1..1codeCode or expression from system
...... display I0..1stringText to display for this code for this value set in this valueset
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language I0..1codeHuman language of the designation
Binding: Common Languages (preferred)
Max Binding: All Languages
....... use I0..1CodingTypes of uses of designations
Binding: Designation Use (extensible)
....... value I1..1stringThe text value for this designation
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property ΣI1..1codeA property/filter defined by the code system
...... op ΣI1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value ΣI1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
.... property I0..*stringProperty to return if client doesn't override
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..1uriIdentifies the value set expansion (business identifier)
.... timestamp I1..1dateTimeTime ValueSet expansion happened
.... total I0..1integerTotal number of codes in the expansion
.... offset I0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name I1..1stringName as assigned by the client or server
..... value[x] I0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... property I0..*BackboneElementAdditional information supplied about each concept
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code I1..1codeIdentifies the property on the concepts, and when referred to in operations
..... uri I0..1uriFormal identifier for the property
.... contains I0..*BackboneElementCodes in the value set
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system I0..1uriSystem value for the code
..... abstract I0..1booleanIf user cannot select this entry
..... inactive I0..1booleanIf concept is inactive in the code system
..... version I0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation I0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... property I0..*BackboneElementProperty value for the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code I1..1codeReference to ValueSet.expansion.property.code
...... value[x] I1..1Value of the property for this concept
....... valueCodecode
....... valueCodingCoding
....... valueStringstring
....... valueIntegerinteger
....... valueBooleanboolean
....... valueDateTimedateTime
....... valueDecimaldecimal
..... contains I0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

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

<ValueSet xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[string]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this value set, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the value set (business identifier) --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the value set -->
 <name value="[string]"/><!-- ?? 1..1 Name for this value set (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this value set (human friendly) -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the value set -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for value set (if applicable)   --></jurisdiction>
 <immutable value="[boolean]"/><!-- ?? 0..1 Indicates whether or not any change to the content logical definition may occur -->
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this value set is defined -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <compose> ?? 0..1 BackboneElement  <!-- ?? 0..1 Content logical definition of the value set (CLD) -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <lockedDate value="[date]"/><!-- ?? 0..1 Fixed date for references with no specified version (transitive) -->
  <inactive value="[boolean]"/><!-- ?? 0..1 Whether inactive codes are in the value set -->
  <include> ?? 1..* BackboneElement  <!-- ?? 1..* Include one or more codes from a code system or other value set(s) -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 The system the codes come from -->
   <version value="[string]"/><!-- ?? 0..1 Specific version of the code system referred to -->
   <concept> ?? 0..* BackboneElement  <!-- ?? 0..* A concept defined in the system -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- ?? 1..1 Code or expression from system -->
    <display value="[string]"/><!-- ?? 0..1 
        Text to display for this code for this value set in this valueset -->
    <designation> ?? 0..* BackboneElement  <!-- ?? 0..* Additional representations for this concept -->
     <modifierExtension><!-- ?? 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <language value="[code]"/><!-- ?? 0..1 Human language of the designation   -->
     <use><!-- ?? 0..1 Coding Types of uses of designations   --></use>
     <value value="[string]"/><!-- ?? 1..1 The text value for this designation -->
    </designation>
   </concept>
   <filter> ?? 0..* BackboneElement  <!-- ?? 0..* Select codes/concepts by their properties (including relationships) -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <property value="[code]"/><!-- ?? 1..1 A property/filter defined by the code system -->
    <op value="[code]"/><!-- ?? 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists   -->
    <value value="[string]"/><!-- ?? 1..1 
        Code from the system, or regex criteria, or boolean value for exists -->
   </filter>
   <valueSet value="[canonical]"/><!-- ?? 0..* Select the contents included in this value set -->
  </include>
  <exclude><!-- See #ValueSet.compose.include  Explicitly exclude codes from a code system or other value sets --></exclude>
  <property value="[string]"/><!-- ?? 0..* Property to return if client doesn't override -->
 </compose>
 <expansion> ?? 0..1 BackboneElement  <!-- ?? 0..1 Used when the value set is "expanded" -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <identifier value="[uri]"/><!-- ?? 0..1 Identifies the value set expansion (business identifier) -->
  <timestamp value="[dateTime]"/><!-- ?? 1..1 Time ValueSet expansion happened -->
  <total value="[integer]"/><!-- ?? 0..1 Total number of codes in the expansion -->
  <offset value="[integer]"/><!-- ?? 0..1 Offset at which this resource starts -->
  <parameter> ?? 0..* BackboneElement  <!-- ?? 0..* Parameter that controlled the expansion process -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <name value="[string]"/><!-- ?? 1..1 Name as assigned by the client or server -->
   <value[x]><!-- ?? 0..1 string|boolean|integer|
     decimal|uri|code|dateTime Value of the named parameter --></value[x]>
  </parameter>
  <property> ?? 0..* BackboneElement  <!-- ?? 0..* Additional information supplied about each concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- ?? 1..1 
       Identifies the property on the concepts, and when referred to in operations -->
   <uri value="[uri]"/><!-- ?? 0..1 Formal identifier for the property -->
  </property>
  <contains> ?? 0..* BackboneElement  <!-- ?? 0..* Codes in the value set -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 System value for the code -->
   <abstract value="[boolean]"/><!-- ?? 0..1 If user cannot select this entry -->
   <inactive value="[boolean]"/><!-- ?? 0..1 If concept is inactive in the code system -->
   <version value="[string]"/><!-- ?? 0..1 Version in which this code/display is defined -->
   <code value="[code]"/><!-- ?? 0..1 Code - if blank, this is not a selectable code -->
   <display value="[string]"/><!-- ?? 0..1 User display for the concept -->
   <designation><!-- See #ValueSet.compose.include.concept.designation  Additional representations for this item --></designation>
   <property> ?? 0..* BackboneElement  <!-- ?? 0..* Property value for the concept -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- ?? 1..1 Reference to ValueSet.expansion.property.code -->
    <value[x]><!-- ?? 1..1 code|Coding|string|
      integer|boolean|dateTime|decimal 
        Value of the property for this concept --></value[x]>
   </property>
   <contains><!-- See #ValueSet.expansion.contains  Codes contained under this entry --></contains>
  </contains>
 </expansion>
</ValueSet>
{ // Shareable ValueSet
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this value set, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the value set (business identifier)
    "version" : "<string>", // C? R! Business version of the value set
    "name" : "<string>", // C? R! Name for this value set (computer friendly)
    "title" : "<string>", // C?Name for this value set (human friendly)
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the value set
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for value set (if applicable)
    "immutable" : <boolean>, // C?Indicates whether or not any change to the content logical definition may occur
    "purpose" : "<markdown>", // C?Why this value set is defined
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "compose" : { BackboneElement }, // C?Content logical definition of the value set (CLD)
    "expansion" : { BackboneElement } // C?Used when the value set is "expanded"
  }

This structure is derived from ValueSet.

Summary

Mandatory: 7 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1A set of codes drawn from one or more code systems
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier ΣI0..*IdentifierAdditional identifier for the value set (business identifier)
... version ΣI1..1stringBusiness version of the value set
... name ΣI1..1stringName for this value set (computer friendly)
... title ΣI0..1stringName for this value set (human friendly)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... date ΣI0..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description I1..1markdownNatural language description of the value set
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction (extensible)
... immutable ΣI0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose I0..1markdownWhy this value set is defined
... copyright I0..1markdownUse and/or publishing restrictions
... compose I0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lockedDate ΣI0..1dateFixed date for references with no specified version (transitive)
.... inactive ΣI0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system ΣI0..1uriThe system the codes come from
..... version ΣI0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code I1..1codeCode or expression from system
...... display I0..1stringText to display for this code for this value set in this valueset
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language I0..1codeHuman language of the designation
Binding: Common Languages (preferred)
Max Binding: All Languages
....... use I0..1CodingTypes of uses of designations
Binding: Designation Use (extensible)
....... value I1..1stringThe text value for this designation
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property ΣI1..1codeA property/filter defined by the code system
...... op ΣI1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value ΣI1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
.... property I0..*stringProperty to return if client doesn't override
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..1uriIdentifies the value set expansion (business identifier)
.... timestamp I1..1dateTimeTime ValueSet expansion happened
.... total I0..1integerTotal number of codes in the expansion
.... offset I0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name I1..1stringName as assigned by the client or server
..... value[x] I0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... property I0..*BackboneElementAdditional information supplied about each concept
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code I1..1codeIdentifies the property on the concepts, and when referred to in operations
..... uri I0..1uriFormal identifier for the property
.... contains I0..*BackboneElementCodes in the value set
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... system I0..1uriSystem value for the code
..... abstract I0..1booleanIf user cannot select this entry
..... inactive I0..1booleanIf concept is inactive in the code system
..... version I0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation I0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... property I0..*BackboneElementProperty value for the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code I1..1codeReference to ValueSet.expansion.property.code
...... value[x] I1..1Value of the property for this concept
....... valueCodecode
....... valueCodingCoding
....... valueStringstring
....... valueIntegerinteger
....... valueBooleanboolean
....... valueDateTimedateTime
....... valueDecimaldecimal
..... contains I0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

XML Template

<!-- Shareable ValueSet -->doco

<ValueSet xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[string]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this value set, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the value set (business identifier) --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the value set -->
 <name value="[string]"/><!-- ?? 1..1 Name for this value set (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this value set (human friendly) -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the value set -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for value set (if applicable)   --></jurisdiction>
 <immutable value="[boolean]"/><!-- ?? 0..1 Indicates whether or not any change to the content logical definition may occur -->
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this value set is defined -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <compose> ?? 0..1 BackboneElement  <!-- ?? 0..1 Content logical definition of the value set (CLD) -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <lockedDate value="[date]"/><!-- ?? 0..1 Fixed date for references with no specified version (transitive) -->
  <inactive value="[boolean]"/><!-- ?? 0..1 Whether inactive codes are in the value set -->
  <include> ?? 1..* BackboneElement  <!-- ?? 1..* Include one or more codes from a code system or other value set(s) -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 The system the codes come from -->
   <version value="[string]"/><!-- ?? 0..1 Specific version of the code system referred to -->
   <concept> ?? 0..* BackboneElement  <!-- ?? 0..* A concept defined in the system -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- ?? 1..1 Code or expression from system -->
    <display value="[string]"/><!-- ?? 0..1 
        Text to display for this code for this value set in this valueset -->
    <designation> ?? 0..* BackboneElement  <!-- ?? 0..* Additional representations for this concept -->
     <modifierExtension><!-- ?? 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <language value="[code]"/><!-- ?? 0..1 Human language of the designation   -->
     <use><!-- ?? 0..1 Coding Types of uses of designations   --></use>
     <value value="[string]"/><!-- ?? 1..1 The text value for this designation -->
    </designation>
   </concept>
   <filter> ?? 0..* BackboneElement  <!-- ?? 0..* Select codes/concepts by their properties (including relationships) -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <property value="[code]"/><!-- ?? 1..1 A property/filter defined by the code system -->
    <op value="[code]"/><!-- ?? 1..1 = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists   -->
    <value value="[string]"/><!-- ?? 1..1 
        Code from the system, or regex criteria, or boolean value for exists -->
   </filter>
   <valueSet value="[canonical]"/><!-- ?? 0..* Select the contents included in this value set -->
  </include>
  <exclude><!-- See #ValueSet.compose.include  Explicitly exclude codes from a code system or other value sets --></exclude>
  <property value="[string]"/><!-- ?? 0..* Property to return if client doesn't override -->
 </compose>
 <expansion> ?? 0..1 BackboneElement  <!-- ?? 0..1 Used when the value set is "expanded" -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <identifier value="[uri]"/><!-- ?? 0..1 Identifies the value set expansion (business identifier) -->
  <timestamp value="[dateTime]"/><!-- ?? 1..1 Time ValueSet expansion happened -->
  <total value="[integer]"/><!-- ?? 0..1 Total number of codes in the expansion -->
  <offset value="[integer]"/><!-- ?? 0..1 Offset at which this resource starts -->
  <parameter> ?? 0..* BackboneElement  <!-- ?? 0..* Parameter that controlled the expansion process -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <name value="[string]"/><!-- ?? 1..1 Name as assigned by the client or server -->
   <value[x]><!-- ?? 0..1 string|boolean|integer|
     decimal|uri|code|dateTime Value of the named parameter --></value[x]>
  </parameter>
  <property> ?? 0..* BackboneElement  <!-- ?? 0..* Additional information supplied about each concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- ?? 1..1 
       Identifies the property on the concepts, and when referred to in operations -->
   <uri value="[uri]"/><!-- ?? 0..1 Formal identifier for the property -->
  </property>
  <contains> ?? 0..* BackboneElement  <!-- ?? 0..* Codes in the value set -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <system value="[uri]"/><!-- ?? 0..1 System value for the code -->
   <abstract value="[boolean]"/><!-- ?? 0..1 If user cannot select this entry -->
   <inactive value="[boolean]"/><!-- ?? 0..1 If concept is inactive in the code system -->
   <version value="[string]"/><!-- ?? 0..1 Version in which this code/display is defined -->
   <code value="[code]"/><!-- ?? 0..1 Code - if blank, this is not a selectable code -->
   <display value="[string]"/><!-- ?? 0..1 User display for the concept -->
   <designation><!-- See #ValueSet.compose.include.concept.designation  Additional representations for this item --></designation>
   <property> ?? 0..* BackboneElement  <!-- ?? 0..* Property value for the concept -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- ?? 1..1 Reference to ValueSet.expansion.property.code -->
    <value[x]><!-- ?? 1..1 code|Coding|string|
      integer|boolean|dateTime|decimal 
        Value of the property for this concept --></value[x]>
   </property>
   <contains><!-- See #ValueSet.expansion.contains  Codes contained under this entry --></contains>
  </contains>
 </expansion>
</ValueSet>

JSON Template

{ // Shareable ValueSet
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this value set, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the value set (business identifier)
    "version" : "<string>", // C? R! Business version of the value set
    "name" : "<string>", // C? R! Name for this value set (computer friendly)
    "title" : "<string>", // C?Name for this value set (human friendly)
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the value set
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for value set (if applicable)
    "immutable" : <boolean>, // C?Indicates whether or not any change to the content logical definition may occur
    "purpose" : "<markdown>", // C?Why this value set is defined
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "compose" : { BackboneElement }, // C?Content logical definition of the value set (CLD)
    "expansion" : { BackboneElement } // C?Used when the value set is "expanded"
  }

 

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

PathNameConformanceValueSet
ValueSet.languageCommon LanguagespreferredCommon Languages
ValueSet.statusPublicationStatusrequiredPublicationStatus
ValueSet.jurisdictionJurisdictionextensibleJurisdiction
ValueSet.compose.include.concept.designation.languageCommon LanguagespreferredCommon Languages
ValueSet.compose.include.concept.designation.useDesignation UseextensibleDesignation Use
ValueSet.compose.include.filter.opFilterOperatorrequiredFilterOperator
RuleRuleRuleRuleRuleRule
IdPathDetailsRequirements
vsd-1ValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
Expression : valueSet.exists() or system.exists()
vsd-2ValueSet.compose.includeA value set with concepts or filters SHALL include a system
Expression : (concept.exists() or filter.exists()) implies system.exists()
vsd-3ValueSet.compose.includeCannot have both concept and filter
Expression : concept.empty() or filter.empty()
vsd-6ValueSet.expansion.containsSHALL have a code or a display
Expression : code.exists() or display.exists()
vsd-9ValueSet.expansion.containsMust have a code if not abstract
Expression : code.exists() or abstract = true
vsd-10ValueSet.expansion.containsMust have a system if a code is present
Expression : code.empty() or system.exists()
.