This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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
Vocabulary Work Group | Maturity Level: 1 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/shareablevalueset
Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets
This profile was published on [no date] as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ValueSet.
This structure is derived from ValueSet.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 1..1 | ValueSet | A set of codes drawn from one or more code systems | |
url | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | |
version | 1..1 | string | Business version of the value set | |
name | 1..1 | string | Name for this value set (computer friendly) | |
status | 1..1 | code | draft | active | retired | unknown | |
experimental | 1..1 | boolean | For testing purposes, not real usage | |
publisher | 1..1 | string | Name of the publisher (organization or individual) | |
description | 1..1 | markdown | Natural language description of the value set | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 1..1 | ValueSet | A set of codes drawn from one or more code systems |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | ΣI | 0..* | Identifier | Additional identifier for the value set (business identifier) |
version | ΣI | 1..1 | string | Business version of the value set |
name | ΣI | 1..1 | string | Name for this value set (computer friendly) |
title | ΣI | 0..1 | string | Name for this value set (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | I | 1..1 | markdown | Natural language description of the value set |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction (extensible) |
immutable | ΣI | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | I | 0..1 | markdown | Why this value set is defined |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
compose | I | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | ΣI | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | ΣI | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | ΣI | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Code or expression from system |
display | I | 0..1 | string | Text to display for this code for this value set in this valueset |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | I | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) Max Binding: All Languages |
use | I | 0..1 | Coding | Types of uses of designations Binding: Designation Use (extensible) |
value | I | 1..1 | string | The text value for this designation |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | ΣI | 1..1 | code | A property/filter defined by the code system |
op | ΣI | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | ΣI | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | See include | Explicitly exclude codes from a code system or other value sets |
property | I | 0..* | string | Property to return if client doesn't override |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | I | 0..1 | uri | Identifies the value set expansion (business identifier) |
timestamp | I | 1..1 | dateTime | Time ValueSet expansion happened |
total | I | 0..1 | integer | Total number of codes in the expansion |
offset | I | 0..1 | integer | Offset at which this resource starts |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | I | 1..1 | string | Name as assigned by the client or server |
value[x] | I | 0..1 | Value of the named parameter | |
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
property | I | 0..* | BackboneElement | Additional information supplied about each concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | I | 0..1 | uri | Formal identifier for the property |
contains | I | 0..* | BackboneElement | Codes in the value set |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | I | 0..1 | uri | System value for the code |
abstract | I | 0..1 | boolean | If user cannot select this entry |
inactive | I | 0..1 | boolean | If concept is inactive in the code system |
version | I | 0..1 | string | Version in which this code/display is defined |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | I | 0..* | See designation | Additional representations for this item |
property | I | 0..* | BackboneElement | Property value for the concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Reference to ValueSet.expansion.property.code |
value[x] | I | 1..1 | Value of the property for this concept | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
contains | I | 0..* | See 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 --> <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.
Differential View
This structure is derived from ValueSet.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 1..1 | ValueSet | A set of codes drawn from one or more code systems | |
url | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | |
version | 1..1 | string | Business version of the value set | |
name | 1..1 | string | Name for this value set (computer friendly) | |
status | 1..1 | code | draft | active | retired | unknown | |
experimental | 1..1 | boolean | For testing purposes, not real usage | |
publisher | 1..1 | string | Name of the publisher (organization or individual) | |
description | 1..1 | markdown | Natural language description of the value set | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 1..1 | ValueSet | A set of codes drawn from one or more code systems |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | ΣI | 0..* | Identifier | Additional identifier for the value set (business identifier) |
version | ΣI | 1..1 | string | Business version of the value set |
name | ΣI | 1..1 | string | Name for this value set (computer friendly) |
title | ΣI | 0..1 | string | Name for this value set (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ΣI | 1..1 | boolean | For testing purposes, not real usage |
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | Name of the publisher (organization or individual) |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | I | 1..1 | markdown | Natural language description of the value set |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction (extensible) |
immutable | ΣI | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | I | 0..1 | markdown | Why this value set is defined |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
compose | I | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | ΣI | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | ΣI | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | ΣI | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Code or expression from system |
display | I | 0..1 | string | Text to display for this code for this value set in this valueset |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | I | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) Max Binding: All Languages |
use | I | 0..1 | Coding | Types of uses of designations Binding: Designation Use (extensible) |
value | I | 1..1 | string | The text value for this designation |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | ΣI | 1..1 | code | A property/filter defined by the code system |
op | ΣI | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | ΣI | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | See include | Explicitly exclude codes from a code system or other value sets |
property | I | 0..* | string | Property to return if client doesn't override |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | I | 0..1 | uri | Identifies the value set expansion (business identifier) |
timestamp | I | 1..1 | dateTime | Time ValueSet expansion happened |
total | I | 0..1 | integer | Total number of codes in the expansion |
offset | I | 0..1 | integer | Offset at which this resource starts |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | I | 1..1 | string | Name as assigned by the client or server |
value[x] | I | 0..1 | Value of the named parameter | |
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
property | I | 0..* | BackboneElement | Additional information supplied about each concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | I | 0..1 | uri | Formal identifier for the property |
contains | I | 0..* | BackboneElement | Codes in the value set |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | I | 0..1 | uri | System value for the code |
abstract | I | 0..1 | boolean | If user cannot select this entry |
inactive | I | 0..1 | boolean | If concept is inactive in the code system |
version | I | 0..1 | string | Version in which this code/display is defined |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | I | 0..* | See designation | Additional representations for this item |
property | I | 0..* | BackboneElement | Property value for the concept |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Reference to ValueSet.expansion.property.code |
value[x] | I | 1..1 | Value of the property for this concept | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
contains | I | 0..* | See 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 --> <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
Path | Name | Conformance | ValueSet |
ValueSet.language | Common Languages | preferred | Common Languages |
ValueSet.status | PublicationStatus | required | PublicationStatus |
ValueSet.jurisdiction | Jurisdiction | extensible | Jurisdiction |
ValueSet.compose.include.concept.designation.language | Common Languages | preferred | Common Languages |
ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |