This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Vocabulary Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/vsd-alignedvalueset
This profile defines the necessary extensions and constraints on ValueSet to align with the HL7 Specification: Characteristics of a Value Set Definition, Release 1 (VSD). This normative specification describes elements to create a ValueSet definition, and does not describe elements related to a ValueSet expansion.
This profile was published on Thu, Jan 1, 1970 00:00+1000 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: 6 elements
Must-Support: 26 elements
Extensions
This structure refers to these extensions:
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 | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-otherTitle | I | 0..* | (Complex) | Alternative titles URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle vsd-2: Either title or extension-otherTitle must be valued |
valueset-authoritativeSource | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource | |
valueset-trusted-expansion | 0..* | url | Reference to a trusted expansion URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion | |
valueset-sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference | |
valueset-keyWord | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord | |
valueset-workflowStatusDescription | S | 0..1 | string | Indicates the state of development of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription |
valueset-steward | S | 0..* | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | S | 0..* | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
valueset-expression | S | 0..1 | Expression | An alternative computable expression of the value set content URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
valueset-supplement | S | 0..* | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
url | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | |
identifier | SI | 0..* | Identifier | Additional identifier for the value set (business identifier) vsd-1: Identifier.system is restricted to OID, RUID, UUID, URI |
version | S | 1..1 | string | Business version of the value set |
name | 1..1 | string | Name for this value set (computer friendly) | |
title | I | 0..1 | string | Name for this value set (human friendly) vsd-2: Either title or extension-otherTitle must be valued |
status | S | 1..1 | code | draft | active | retired | unknown |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-status-activityStatusDate | S | 0..1 | date | Date when the activity status is in effect URL: http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate |
experimental | S | 1..1 | boolean | For testing purposes, not real usage |
publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
useContext | S | 0..* | UsageContext | The context that the content is intended to support |
immutable | S | 1..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 | |
compose | S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-creationDate | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate | |
valueset-compose-createdBy | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy | |
lockedDate | S | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | S | 0..1 | boolean | Whether inactive codes are in the value set |
include | S | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-include-valueSetTitle | 0..1 | string | Code system name URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-valueSetTitle | |
valueset-systemTitle | 0..1 | string | Code system title URL: http://hl7.org/fhir/StructureDefinition/valueset-systemTitle | |
valueset-compose-include-minimumMultiplicity | S | 0..1 | integer | the minimum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-minimumMultiplicity |
valueset-compose-include-maximumMultiplicity | S | 0..1 | integer | the maximum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-maximumMultiplicity |
system | S | 0..1 | uri | The system the codes come from |
filter | S | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
property | S | 1..1 | code | A property/filter defined by the code system |
op | S | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists |
value | S | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
copyright | S | 0..1 | string | A copyright statement for the specific code system included in the value set |
scope | S | 1..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover |
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 | Σ | 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 (preferred) Max Binding: All Languages: IETF language tag | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-otherTitle | I | 0..* | (Complex) | Alternative titles URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle vsd-2: Either title or extension-otherTitle must be valued |
valueset-authoritativeSource | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource | |
valueset-trusted-expansion | 0..* | url | Reference to a trusted expansion URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion | |
valueset-sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference | |
valueset-keyWord | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord | |
valueset-workflowStatusDescription | S | 0..1 | string | Indicates the state of development of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription |
valueset-steward | S | 0..* | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | S | 0..* | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
valueset-expression | S | 0..1 | Expression | An alternative computable expression of the value set content URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
valueset-supplement | S | 0..* | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
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 | SΣI | 0..* | Identifier | Additional identifier for the value set (business identifier) vsd-1: Identifier.system is restricted to OID, RUID, UUID, URI |
version | SΣ | 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) vsd-2: Either title or extension-otherTitle must be valued |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-status-activityStatusDate | S | 0..1 | date | Date when the activity status is in effect URL: http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate |
value | 0..1 | string | Primitive value for code | |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the value set | |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use. |
immutable | SΣ | 1..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 | |
compose | S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-creationDate | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate | |
valueset-compose-createdBy | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | SΣ | 0..1 | boolean | Whether inactive codes are in the value set |
include | SΣ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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-include-valueSetTitle | 0..1 | string | Code system name URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-valueSetTitle | |
valueset-systemTitle | 0..1 | string | Code system title URL: http://hl7.org/fhir/StructureDefinition/valueset-systemTitle | |
valueset-compose-include-minimumMultiplicity | S | 0..1 | integer | the minimum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-minimumMultiplicity |
valueset-compose-include-maximumMultiplicity | S | 0..1 | integer | the maximum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-maximumMultiplicity |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | SΣ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 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..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 | 0..* | BackboneElement | Additional representations for this concept | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) Max Binding: All Languages: IETF language tag | |
use | 0..1 | Coding | Types of uses of designations Binding: Designation Use (extensible): Details of how a designation would be used. | |
value | 1..1 | string | The text value for this designation | |
filter | SΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | SΣ | 1..1 | code | A property/filter defined by the code system |
op | SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. |
value | SΣ | 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 |
copyright | S | 0..1 | string | A copyright statement for the specific code system included in the value set |
exclude | I | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets |
property | 0..* | string | Property to return if client doesn't override | |
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |
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 | 0..* | BackboneElement | Parameter that controlled the expansion process | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | 1..1 | string | Name as assigned by the client or server | |
value[x] | 0..1 | Value of the named parameter | ||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
property | 0..* | BackboneElement | Additional information supplied about each concept | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | |
uri | 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 | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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..* | See designation (ValueSet) | Additional representations for this item | |
property | 0..* | BackboneElement | Property value for the concept | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Reference to ValueSet.expansion.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
contains | 0..* | See contains (ValueSet) | Codes contained under this entry | |
scope | S | 1..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
focus | 0..1 | string | General focus of the Value Set as it relates to the intended semantic space | |
inclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be included and why | |
exclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be excluded and why | |
Documentation for this format |
<!-- VSDALignedValueSet --> <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 <!-- 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]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..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]"/><!-- 1..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 | child-of | descendent-leaf | 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 --> <copyright value="[string]"/><!-- 0..1 A copyright statement for the specific code system included in the value set --> </include> <exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include Explicitly exclude codes from a code system or other value sets --></exclude> <property value="[string]"/><!-- 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 http://hl7.org/fhir/StructureDefinition/ValueSet#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 http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> <scope> 1..1 BackboneElement <!-- 1..1 Description of the semantic space the Value Set Expansion is intended to cover --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <focus value="[string]"/><!-- 0..1 General focus of the Value Set as it relates to the intended semantic space --> <inclusionCriteria value="[string]"/><!-- 0..1 Criteria describing which concepts or codes should be included and why --> <exclusionCriteria value="[string]"/><!-- 0..1 Criteria describing which concepts or codes should be excluded and why --> </scope> </ValueSet>
{ // VSDALignedValueSet // 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 "extension" : [ // sliced by value:url in the specified order, Open { // Alternative titles // C? // from Element: extension }, { // Reference to the current trusted source of the ValueSet resource (metadata and definition) // C? // from Element: extension }, { // Reference to a trusted expansion // C? // from Element: extension }, { // Where did this content come from // C? // from Element: extension }, { // Descriptors and key terms for search // C? // from Element: extension }, { // Indicates the state of development of the value set // C? // from Element: extension }, { // Entity responsible for Value Set // C? // from Element: extension }, { // Entity/entities that create and may modify the Value Set // C? // from Element: extension }, { // An alternative computable expression of the value set content // C? // from Element: extension }, { // Declares dependency on a particular supplment // C? // from Element: extension } ], "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?Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C?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? R! 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" "scope" : { BackboneElement }, // C? R! Description of the semantic space the Value Set Expansion is intended to cover }
This structure is derived from ValueSet.
Summary
Mandatory: 6 elements
Must-Support: 26 elements
Extensions
This structure refers to these extensions:
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 | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-otherTitle | I | 0..* | (Complex) | Alternative titles URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle vsd-2: Either title or extension-otherTitle must be valued |
valueset-authoritativeSource | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource | |
valueset-trusted-expansion | 0..* | url | Reference to a trusted expansion URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion | |
valueset-sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference | |
valueset-keyWord | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord | |
valueset-workflowStatusDescription | S | 0..1 | string | Indicates the state of development of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription |
valueset-steward | S | 0..* | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | S | 0..* | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
valueset-expression | S | 0..1 | Expression | An alternative computable expression of the value set content URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
valueset-supplement | S | 0..* | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
url | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | |
identifier | SI | 0..* | Identifier | Additional identifier for the value set (business identifier) vsd-1: Identifier.system is restricted to OID, RUID, UUID, URI |
version | S | 1..1 | string | Business version of the value set |
name | 1..1 | string | Name for this value set (computer friendly) | |
title | I | 0..1 | string | Name for this value set (human friendly) vsd-2: Either title or extension-otherTitle must be valued |
status | S | 1..1 | code | draft | active | retired | unknown |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-status-activityStatusDate | S | 0..1 | date | Date when the activity status is in effect URL: http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate |
experimental | S | 1..1 | boolean | For testing purposes, not real usage |
publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
useContext | S | 0..* | UsageContext | The context that the content is intended to support |
immutable | S | 1..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 | |
compose | S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-creationDate | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate | |
valueset-compose-createdBy | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy | |
lockedDate | S | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | S | 0..1 | boolean | Whether inactive codes are in the value set |
include | S | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-include-valueSetTitle | 0..1 | string | Code system name URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-valueSetTitle | |
valueset-systemTitle | 0..1 | string | Code system title URL: http://hl7.org/fhir/StructureDefinition/valueset-systemTitle | |
valueset-compose-include-minimumMultiplicity | S | 0..1 | integer | the minimum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-minimumMultiplicity |
valueset-compose-include-maximumMultiplicity | S | 0..1 | integer | the maximum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-maximumMultiplicity |
system | S | 0..1 | uri | The system the codes come from |
filter | S | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
property | S | 1..1 | code | A property/filter defined by the code system |
op | S | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists |
value | S | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
copyright | S | 0..1 | string | A copyright statement for the specific code system included in the value set |
scope | S | 1..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover |
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 | Σ | 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 (preferred) Max Binding: All Languages: IETF language tag | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-otherTitle | I | 0..* | (Complex) | Alternative titles URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle vsd-2: Either title or extension-otherTitle must be valued |
valueset-authoritativeSource | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource | |
valueset-trusted-expansion | 0..* | url | Reference to a trusted expansion URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion | |
valueset-sourceReference | 0..1 | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference | |
valueset-keyWord | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord | |
valueset-workflowStatusDescription | S | 0..1 | string | Indicates the state of development of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription |
valueset-steward | S | 0..* | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | S | 0..* | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
valueset-expression | S | 0..1 | Expression | An alternative computable expression of the value set content URL: http://hl7.org/fhir/StructureDefinition/valueset-expression |
valueset-supplement | S | 0..* | canonical(CodeSystem) | Declares dependency on a particular supplment URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement |
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 | SΣI | 0..* | Identifier | Additional identifier for the value set (business identifier) vsd-1: Identifier.system is restricted to OID, RUID, UUID, URI |
version | SΣ | 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) vsd-2: Either title or extension-otherTitle must be valued |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-status-activityStatusDate | S | 0..1 | date | Date when the activity status is in effect URL: http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate |
value | 0..1 | string | Primitive value for code | |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the value set | |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use. |
immutable | SΣ | 1..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 | |
compose | S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-creationDate | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate | |
valueset-compose-createdBy | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | SΣ | 0..1 | boolean | Whether inactive codes are in the value set |
include | SΣ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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
valueset-compose-include-valueSetTitle | 0..1 | string | Code system name URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-valueSetTitle | |
valueset-systemTitle | 0..1 | string | Code system title URL: http://hl7.org/fhir/StructureDefinition/valueset-systemTitle | |
valueset-compose-include-minimumMultiplicity | S | 0..1 | integer | the minimum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-minimumMultiplicity |
valueset-compose-include-maximumMultiplicity | S | 0..1 | integer | the maximum number of the specified relationships allowed URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-include-maximumMultiplicity |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | SΣ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 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..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 | 0..* | BackboneElement | Additional representations for this concept | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) Max Binding: All Languages: IETF language tag | |
use | 0..1 | Coding | Types of uses of designations Binding: Designation Use (extensible): Details of how a designation would be used. | |
value | 1..1 | string | The text value for this designation | |
filter | SΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | SΣ | 1..1 | code | A property/filter defined by the code system |
op | SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. |
value | SΣ | 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 |
copyright | S | 0..1 | string | A copyright statement for the specific code system included in the value set |
exclude | I | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets |
property | 0..* | string | Property to return if client doesn't override | |
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |
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 | 0..* | BackboneElement | Parameter that controlled the expansion process | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | 1..1 | string | Name as assigned by the client or server | |
value[x] | 0..1 | Value of the named parameter | ||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
property | 0..* | BackboneElement | Additional information supplied about each concept | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | |
uri | 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 | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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..* | See designation (ValueSet) | Additional representations for this item | |
property | 0..* | BackboneElement | Property value for the concept | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Reference to ValueSet.expansion.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
contains | 0..* | See contains (ValueSet) | Codes contained under this entry | |
scope | S | 1..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
focus | 0..1 | string | General focus of the Value Set as it relates to the intended semantic space | |
inclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be included and why | |
exclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be excluded and why | |
Documentation for this format |
XML Template
<!-- VSDALignedValueSet --> <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 <!-- 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]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..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]"/><!-- 1..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 | child-of | descendent-leaf | 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 --> <copyright value="[string]"/><!-- 0..1 A copyright statement for the specific code system included in the value set --> </include> <exclude><!-- See http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include Explicitly exclude codes from a code system or other value sets --></exclude> <property value="[string]"/><!-- 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 http://hl7.org/fhir/StructureDefinition/ValueSet#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 http://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains Codes contained under this entry --></contains> </contains> </expansion> <scope> 1..1 BackboneElement <!-- 1..1 Description of the semantic space the Value Set Expansion is intended to cover --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <focus value="[string]"/><!-- 0..1 General focus of the Value Set as it relates to the intended semantic space --> <inclusionCriteria value="[string]"/><!-- 0..1 Criteria describing which concepts or codes should be included and why --> <exclusionCriteria value="[string]"/><!-- 0..1 Criteria describing which concepts or codes should be excluded and why --> </scope> </ValueSet>
JSON Template
{ // VSDALignedValueSet // 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 "extension" : [ // sliced by value:url in the specified order, Open { // Alternative titles // C? // from Element: extension }, { // Reference to the current trusted source of the ValueSet resource (metadata and definition) // C? // from Element: extension }, { // Reference to a trusted expansion // C? // from Element: extension }, { // Where did this content come from // C? // from Element: extension }, { // Descriptors and key terms for search // C? // from Element: extension }, { // Indicates the state of development of the value set // C? // from Element: extension }, { // Entity responsible for Value Set // C? // from Element: extension }, { // Entity/entities that create and may modify the Value Set // C? // from Element: extension }, { // An alternative computable expression of the value set content // C? // from Element: extension }, { // Declares dependency on a particular supplment // C? // from Element: extension } ], "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?Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C?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? R! 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" "scope" : { BackboneElement }, // C? R! Description of the semantic space the Value Set Expansion is intended to cover }
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 |
Id | Path | Details | Requirements |
vsd-2 | ValueSet.extension | Either title or extension-otherTitle must be valued Expression : ValueSet.title.exists() or ValueSet.extension:valueset-other-title.exists() | |
vsd-1 | ValueSet.identifier | Identifier.system is restricted to OID, RUID, UUID, URI Expression : identifier.exists(system in ('OID' or 'RUID' or 'UUID' or 'URI')) | |
vsd-2 | ValueSet.title | Either title or extension-otherTitle must be valued Expression : ValueSet.title.exists() or ValueSet.extension:valueset-other-title.exists() |