This page is part of the Structured Data Capture - Data Element Exchange Specification (v1.6: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 2.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/sdcde/StructureDefinition/sdcde-valueset
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ValueSet
Summary
Mandatory: 2 elements (+1 nested mandatory element)
Must-Support: 44 elements
Extensions
This structure refers to these extensions:
This structure is derived from ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 0..* | A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource vsd-2: A value set with only one import SHALL also have an include and/or an exclude vsd-5: Value set SHALL contain at least one of a a compose, or an expansion element | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
rendering-styleSensitive | SI | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-trusted-expansion | SI | 0..1 | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-effectiveDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-expirationDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | S | 0..1 | uri | Globally unique logical identifier for value set |
identifier | S | 1..1 | Identifier | Additional identifier for the value set (e.g. HL7 v2 / CDA) |
version | S | 0..1 | string | Logical identifier for this version of the value set |
name | S | 1..1 | string | Informal name for this value set |
status | ?!S | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
experimental | S | 0..1 | boolean | If for testing purposes, not real usage |
publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
contact | ∑ | 0..* | BackboneElement | Contact details of the publisher |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
name | ∑ | 0..1 | string | Name of an individual to contact |
telecom | ∑ | 0..* | ContactPoint | Contact details for individual or publisher |
date | S | 0..1 | dateTime | Date for given status |
lockedDate | S | 0..1 | date | Fixed date for all referenced code systems and value sets |
description | S | 0..1 | markdown | Human language description of the value set |
useContext | S | 0..* | CodeableConcept | Content intends to support these contexts Binding: Context of Use ValueSet (extensible) |
immutable | S | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
requirements | 0..1 | markdown | Why needed | |
copyright | 0..1 | string | Use and/or publishing restrictions | |
extensible | S | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
compose | SI | 0..1 | BackboneElement | When value set includes codes from elsewhere vsd-1: A value set composition SHALL have an include or an import |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
import | SI | 0..* | uri | Import the contents of another value set |
include | SI | 0..* | BackboneElement | Include one or more codes from a code system vsd-11: Cannot have both concept and filter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
system | S | 1..1 | uri | The system the codes come from |
version | S | 0..1 | string | Specific version of the code system referred to |
concept | SI | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
valueset-conceptOrder | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
code | S | 1..1 | code | Code or expression from system |
display | S | 0..1 | string | Text to display for this code for this value set |
designation | 0..* | BackboneElement | Additional representations for this valueset | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) | |
use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | SI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
property | S | 1..1 | code | A property defined by the code system |
op | S | 1..1 | code | = | is-a | is-not-a | regex | in | not-in | generalizes Binding: FilterOperator (required) |
value | S | 1..1 | code | Code from the system, or regex criteria |
exclude | SI | 0..* | Unknown reference to #ValueSet:sdcvalueset.compose.include Explicitly exclude codes | |
expansion | SI | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | uri | Uniquely identifies this expansion |
timestamp | S | 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 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
contains | SI | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
valueset-conceptOrder | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-definition | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-definition ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-systemName | SI | 1..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
system | S | 0..1 | uri | System value for the code |
abstract | S | 0..1 | boolean | If user cannot select this entry |
version | S | 0..1 | string | Version in which this code/display is defined |
code | SI | 0..1 | code | Code - if blank, this is not a selectable code |
display | SI | 0..1 | string | User display for the concept |
contains | S | 0..* | Unknown reference to #ValueSet:sdcvalueset.expansion.contains Codes contained under this entry | |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
yet to be done: Turtle template
This structure is derived from ValueSet
Summary
Mandatory: 2 elements (+1 nested mandatory element)
Must-Support: 44 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ValueSet
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 0..* | A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource vsd-2: A value set with only one import SHALL also have an include and/or an exclude vsd-5: Value set SHALL contain at least one of a a compose, or an expansion element | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
rendering-styleSensitive | SI | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-trusted-expansion | SI | 0..1 | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-effectiveDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-expirationDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | S | 0..1 | uri | Globally unique logical identifier for value set |
identifier | S | 1..1 | Identifier | Additional identifier for the value set (e.g. HL7 v2 / CDA) |
version | S | 0..1 | string | Logical identifier for this version of the value set |
name | S | 1..1 | string | Informal name for this value set |
status | ?!S | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
experimental | S | 0..1 | boolean | If for testing purposes, not real usage |
publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
contact | ∑ | 0..* | BackboneElement | Contact details of the publisher |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
name | ∑ | 0..1 | string | Name of an individual to contact |
telecom | ∑ | 0..* | ContactPoint | Contact details for individual or publisher |
date | S | 0..1 | dateTime | Date for given status |
lockedDate | S | 0..1 | date | Fixed date for all referenced code systems and value sets |
description | S | 0..1 | markdown | Human language description of the value set |
useContext | S | 0..* | CodeableConcept | Content intends to support these contexts Binding: Context of Use ValueSet (extensible) |
immutable | S | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
requirements | 0..1 | markdown | Why needed | |
copyright | 0..1 | string | Use and/or publishing restrictions | |
extensible | S | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
compose | SI | 0..1 | BackboneElement | When value set includes codes from elsewhere vsd-1: A value set composition SHALL have an include or an import |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
import | SI | 0..* | uri | Import the contents of another value set |
include | SI | 0..* | BackboneElement | Include one or more codes from a code system vsd-11: Cannot have both concept and filter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
system | S | 1..1 | uri | The system the codes come from |
version | S | 0..1 | string | Specific version of the code system referred to |
concept | SI | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
valueset-conceptOrder | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
code | S | 1..1 | code | Code or expression from system |
display | S | 0..1 | string | Text to display for this code for this value set |
designation | 0..* | BackboneElement | Additional representations for this valueset | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) | |
use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | SI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
property | S | 1..1 | code | A property defined by the code system |
op | S | 1..1 | code | = | is-a | is-not-a | regex | in | not-in | generalizes Binding: FilterOperator (required) |
value | S | 1..1 | code | Code from the system, or regex criteria |
exclude | SI | 0..* | Unknown reference to #ValueSet:sdcvalueset.compose.include Explicitly exclude codes | |
expansion | SI | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | uri | Uniquely identifies this expansion |
timestamp | S | 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 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
contains | SI | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
valueset-conceptOrder | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-definition | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-definition ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
valueset-systemName | SI | 1..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
system | S | 0..1 | uri | System value for the code |
abstract | S | 0..1 | boolean | If user cannot select this entry |
version | S | 0..1 | string | Version in which this code/display is defined |
code | SI | 0..1 | code | Code - if blank, this is not a selectable code |
display | SI | 0..1 | string | User display for the concept |
contains | S | 0..* | Unknown reference to #ValueSet:sdcvalueset.expansion.contains Codes contained under this entry | |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
TTL Template
yet to be done: Turtle template
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
ValueSet.language | Common Languages | extensible | Common Languages |
ValueSet.status | ConformanceResourceStatus | required | ConformanceResourceStatus |
ValueSet.useContext | Context of Use ValueSet | extensible | Context of Use ValueSet |
ValueSet.compose.include.concept.designation.language | Common Languages | extensible | Common Languages |
ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |
Id | Path | Details | Requirements |
dom-2 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
vsd-2 | ValueSet | A value set with only one import SHALL also have an include and/or an exclude XPath: not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude)) | |
vsd-5 | ValueSet | Value set SHALL contain at least one of a a compose, or an expansion element XPath: exists(f:compose) or exists(f:expansion) | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
vsd-1 | ValueSet.compose | A value set composition SHALL have an include or an import XPath: exists(f:include) or exists(f:import) | |
vsd-11 | ValueSet.compose.include | Cannot have both concept and filter XPath: not(exists(f:concept)) or not(exists(f:filter)) | |
ele-1 | ValueSet.compose.include.concept.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.compose.include.concept.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display XPath: exists(f:code) or exists(f:display) | |
vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract XPath: exists(f:code) or (f:abstract/@value = true()) | |
vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present XPath: exists(f:system) or not(exists(f:code)) | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) |