This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
(No assigned work group) | Maturity Level: 1 | Informative | 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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 1..1 | A set of codes drawn from one or more code systems | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) |
version | Σ | 1..1 | string | Business version of the value set |
name | Σ | 1..1 | string | Name for this value set (computer friendly) |
title | Σ | 0..1 | string | Name for this value set (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 1..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 1..1 | markdown | Natural language description of the value set | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
extensible | Σ | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
compose | I | 0..1 | BackboneElement | Definition of the content of the value set |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
lockedDate | Σ | 0..1 | date | Fixed date for version-less references (transitive) |
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter vsd-1: A value set include/exclude SHALL have a value set or a system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
system | ΣI | 0..1 | uri | The system the codes come from |
version | Σ | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) | |
use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
property | Σ | 1..1 | code | A property defined by the code system |
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | uri | Uniquely identifies this expansion | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
contains | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | ||
contains | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | ||
Documentation for this format |
<!-- Shareable ValueSet --> <ValueSet xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 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 --> <extensible value="[boolean]"/><!-- 0..1 Whether this is intended to be used with an extensible binding --> <compose> 0..1 BackboneElement <!-- 0..1 Definition of the content of the value set --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <lockedDate value="[date]"/><!-- 0..1 Fixed date for version-less references (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 --></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 --></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 --></modifierExtension> <language value="[code]"/><!-- 0..1 Human language of the designation --> <use><!-- 0..1 Coding Details how this designation would be used --></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 --></modifierExtension> <property value="[code]"/><!-- 1..1 A property 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> </compose> <expansion> 0..1 BackboneElement <!-- 0..1 Used when the value set is "expanded" --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier value="[uri]"/><!-- 0..1 Uniquely identifies this expansion --> <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 --></modifierExtension> <name value="[string]"/><!-- 1..1 Name as assigned by the server --> <value[x]><!-- 0..1 string|boolean|integer| decimal|uri|code Value of the named parameter --></value[x]> </parameter> <contains> 0..* BackboneElement <!-- 0..* Codes in the value set --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></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> <contains><!-- See #ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> </ValueSet>
{ // Shareable ValueSet // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "url" : "<uri>", // R! Canonical identifier for this value set, represented as a URI (globally unique) "identifier" : [{ Identifier }], //Additional identifier for the value set (business identifier) "version" : "<string>", // R! Business version of the value set "name" : "<string>", // R! Name for this value set (computer friendly) "title" : "<string>", //Name for this value set (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // R! For testing purposes, not real usage "date" : "<dateTime>", //Date last changed "publisher" : "<string>", // R! Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], //Contact details for the publisher "description" : "<markdown>", // R! Natural language description of the value set "useContext" : [{ UsageContext }], //The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], //Intended jurisdiction for value set (if applicable) "immutable" : <boolean>, //Indicates whether or not any change to the content logical definition may occur "purpose" : "<markdown>", //Why this value set is defined "copyright" : "<markdown>", //Use and/or publishing restrictions "extensible" : <boolean>, //Whether this is intended to be used with an extensible binding "compose" : { BackboneElement }, // C?Definition of the content of the value set "expansion" : { BackboneElement } // C?Used when the value set is "expanded" }
This structure is derived from ValueSet.
Differential View
This structure is derived from ValueSet.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 1..1 | A set of codes drawn from one or more code systems | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) |
version | Σ | 1..1 | string | Business version of the value set |
name | Σ | 1..1 | string | Name for this value set (computer friendly) |
title | Σ | 0..1 | string | Name for this value set (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 1..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 1..1 | markdown | Natural language description of the value set | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
extensible | Σ | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
compose | I | 0..1 | BackboneElement | Definition of the content of the value set |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
lockedDate | Σ | 0..1 | date | Fixed date for version-less references (transitive) |
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter vsd-1: A value set include/exclude SHALL have a value set or a system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
system | ΣI | 0..1 | uri | The system the codes come from |
version | Σ | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) | |
use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
property | Σ | 1..1 | code | A property defined by the code system |
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | uri | Uniquely identifies this expansion | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
contains | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | ||
contains | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | ||
Documentation for this format |
XML Template
<!-- Shareable ValueSet --> <ValueSet xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 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 --> <extensible value="[boolean]"/><!-- 0..1 Whether this is intended to be used with an extensible binding --> <compose> 0..1 BackboneElement <!-- 0..1 Definition of the content of the value set --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <lockedDate value="[date]"/><!-- 0..1 Fixed date for version-less references (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 --></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 --></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 --></modifierExtension> <language value="[code]"/><!-- 0..1 Human language of the designation --> <use><!-- 0..1 Coding Details how this designation would be used --></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 --></modifierExtension> <property value="[code]"/><!-- 1..1 A property 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> </compose> <expansion> 0..1 BackboneElement <!-- 0..1 Used when the value set is "expanded" --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier value="[uri]"/><!-- 0..1 Uniquely identifies this expansion --> <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 --></modifierExtension> <name value="[string]"/><!-- 1..1 Name as assigned by the server --> <value[x]><!-- 0..1 string|boolean|integer| decimal|uri|code Value of the named parameter --></value[x]> </parameter> <contains> 0..* BackboneElement <!-- 0..* Codes in the value set --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></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> <contains><!-- See #ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> </ValueSet>
JSON Template
{ // Shareable ValueSet // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "url" : "<uri>", // R! Canonical identifier for this value set, represented as a URI (globally unique) "identifier" : [{ Identifier }], //Additional identifier for the value set (business identifier) "version" : "<string>", // R! Business version of the value set "name" : "<string>", // R! Name for this value set (computer friendly) "title" : "<string>", //Name for this value set (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // R! For testing purposes, not real usage "date" : "<dateTime>", //Date last changed "publisher" : "<string>", // R! Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], //Contact details for the publisher "description" : "<markdown>", // R! Natural language description of the value set "useContext" : [{ UsageContext }], //The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], //Intended jurisdiction for value set (if applicable) "immutable" : <boolean>, //Indicates whether or not any change to the content logical definition may occur "purpose" : "<markdown>", //Why this value set is defined "copyright" : "<markdown>", //Use and/or publishing restrictions "extensible" : <boolean>, //Whether this is intended to be used with an extensible binding "compose" : { BackboneElement }, // C?Definition of the content of the value set "expansion" : { BackboneElement } // C?Used when the value set is "expanded" }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
ValueSet.language | Common Languages | extensible | Common Languages |
ValueSet.status | PublicationStatus | required | PublicationStatus |
ValueSet.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
ValueSet.compose.include.concept.designation.language | Common Languages | extensible | Common Languages |
ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |
Id | Path | Details | Requirements |
vsd-2 | ValueSet.compose.include | A value set with concepts or filters SHALL include a system Expression : (concept.exists() or filter.exists()) implies system.exists() | |
vsd-3 | ValueSet.compose.include | Cannot have both concept and filter Expression : concept.empty() or filter.empty() | |
vsd-1 | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system Expression : valueSet.exists() or system.exists() | |
vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display Expression : code.exists() or display.exists() | |
vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract Expression : code.exists() or abstract = true | |
vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present Expression : code.empty() or system.exists() |