This page is part of the Structured Data Capture - Data Element Exchange Specification (v2.0: STU 2) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). 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
This profile sets expectations for use of the ValueSet resource within the Structured Data Capture Data Element Exchange implementation guide. This includes identifying which core elements and extensions must be supported.
For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the ValueSet. It means that servers SHALL be capable of persisting those elements and returning them in response to requests. For systems rendering Questionnaires, these Supported elements and extensions must be supported in the rendering of allowed choices associated with questions.
This profile relies on the use of the valueset-extensions profile which defines a number of less common properties for value sets, several of which are mandated for this profile. It also makes use of the rendering-extensions which defines rendering information for display names and labels of codes.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ValueSet
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 47 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 | |
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 |
valueset-trusted-expansion | SI | 0..1 | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion |
valueset-effectiveDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate |
valueset-expirationDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 0..1 | uri | Logical URI to reference this value set (globally unique) |
identifier | SΣ | 1..1 | Identifier | Additional identifier for the value set |
version | SΣ | 0..1 | string | Business version of the value set |
name | SΣ | 1..1 | string | Name for this value set (computer friendly) |
title | SΣ | 0..1 | string | Name for this value set (human friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!SΣ | 0..1 | boolean | For testing purposes, not real usage |
date | SΣ | 0..1 | dateTime | Date this was last changed |
publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | S | 0..1 | markdown | Natural language description of the value set |
useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | SΣ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
extensible | SΣ | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
compose | SI | 0..1 | BackboneElement | Definition of the content of the value set (CLD) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
lockedDate | SΣ | 0..1 | date | Fixed date for version-less references (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 | 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ΣI | 0..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 |
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 in this valueset |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) | |
use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ?!SΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
property | SΣ | 1..1 | code | A property defined by the code system |
op | SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | SΣ | 1..1 | code | Code from the system, or regex criteria, or boolean value for exists |
valueSet | SΣI | 0..* | uri | Select only contents included in this value set |
exclude | SI | 0..* | Unknown reference to #ValueSet:sdcvalueset.compose.include Explicitly exclude codes from a code system or other value sets | |
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 | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
contains | SI | 0..* | BackboneElement | Codes in the value set |
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 |
valueset-definition | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-definition |
valueset-systemName | SI | 1..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName |
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 |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
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 |
designation | 0..* | Unknown reference to #ValueSet:sdcvalueset.compose.include.concept.designation Additional representations for this item | ||
contains | S | 0..* | Unknown reference to #ValueSet:sdcvalueset.expansion.contains Codes contained under this entry | |
Documentation for this format |
This structure is derived from ValueSet
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 47 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 | |
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 |
valueset-trusted-expansion | SI | 0..1 | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion |
valueset-effectiveDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate |
valueset-expirationDate | SI | 0..1 | date | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 0..1 | uri | Logical URI to reference this value set (globally unique) |
identifier | SΣ | 1..1 | Identifier | Additional identifier for the value set |
version | SΣ | 0..1 | string | Business version of the value set |
name | SΣ | 1..1 | string | Name for this value set (computer friendly) |
title | SΣ | 0..1 | string | Name for this value set (human friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!SΣ | 0..1 | boolean | For testing purposes, not real usage |
date | SΣ | 0..1 | dateTime | Date this was last changed |
publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | S | 0..1 | markdown | Natural language description of the value set |
useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | SΣ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
extensible | SΣ | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
compose | SI | 0..1 | BackboneElement | Definition of the content of the value set (CLD) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
lockedDate | SΣ | 0..1 | date | Fixed date for version-less references (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 | 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ΣI | 0..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 |
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 in this valueset |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) | |
use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ?!SΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
property | SΣ | 1..1 | code | A property defined by the code system |
op | SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | SΣ | 1..1 | code | Code from the system, or regex criteria, or boolean value for exists |
valueSet | SΣI | 0..* | uri | Select only contents included in this value set |
exclude | SI | 0..* | Unknown reference to #ValueSet:sdcvalueset.compose.include Explicitly exclude codes from a code system or other value sets | |
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 | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
contains | SI | 0..* | BackboneElement | Codes in the value set |
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 |
valueset-definition | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-definition |
valueset-systemName | SI | 1..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName |
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 |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
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 |
designation | 0..* | Unknown reference to #ValueSet:sdcvalueset.compose.include.concept.designation Additional representations for this item | ||
contains | S | 0..* | Unknown reference to #ValueSet:sdcvalueset.expansion.contains Codes contained under this entry | |
Documentation for this format |
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
ValueSet.language | Common Languages | extensible | Common Languages |
ValueSet.status | PublicationStatus | required | PublicationStatus |
ValueSet.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
ValueSet.compose.include.concept.designation.language | Common Languages | extensible | Common Languages |
ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |
Id | Path | Details | Requirements |
dom-2 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
vsd-5 | ValueSet | Value set SHALL contain at least one of a compose or an expansion element : compose.exists() or expansion.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.compose | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
vsd-2 | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() | |
vsd-3 | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() | |
vsd-1 | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() | |
ele-1 | ValueSet.compose.include.concept | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include.concept.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.compose.include.concept.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.compose.include.concept.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.compose.include.concept.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.compose.include.concept.designation | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include.filter | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ValueSet.expansion | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ValueSet.expansion.parameter | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ValueSet.expansion.contains | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |