STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/sdc-valueset
Defines how ValueSet is used to reflect code lists found in data element defintions and form definitions to be used within the ONC's Structured Data Capture standard.
This profile was published on Sun, Jul 6, 2014 00:00+1000 as a draft by Health Level Seven International (Orders and Observations - Structured Data Capture).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ValueSet.
This structure is derived from ValueSet.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet | I | 0..* | ValueSet | A set of codes drawn from one or more code systems vsd-5: Value set SHALL contain at least one of a a compose, or an expansion element vsd-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set includes an inline code system |
 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: IETF BCP-47  (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 styleSensitive | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/styleSensitive |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | S ∑ | 0..1 | uri | Globally unique logical identifier for value set |
 identifier | ∑ | 0..1 | Identifier | Additional identifier for the value set (e.g. HL7 v2 / CDA) |
| version | ∑ | 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 | ∑ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | ∑ | 0..* | BackboneElement | Contact details of the publisher |
 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 ∑ | 1..1 | string | 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 ∑ | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| requirements | 0..1 | string | Why needed | |
| copyright | 0..1 | string | Use and/or publishing restrictions | |
| extensible | S ∑ | 1..1 | boolean | Whether this is intended to be used with an extensible binding |
| compose | S I | 0..1 | BackboneElement | When value set includes codes from elsewhere vsd-1: A value set composition SHALL have an include or an import |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| import | S ∑I | 0..* | uri | Import the contents of another value set |
| include | S ∑I | 0..* | BackboneElement | Include one or more codes from a code system vsd-11: Cannot have both concept and filter |
| 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 | S I | 0..* | BackboneElement | A concept defined in the system |
| valueset-label | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| valueString | 1..1 | string | Value of extension | |
 style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| valueset-conceptOrder | S | 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 | Test to display for this code for this value set |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| designation | 0..* | BackboneElement | Additional representations for this valueset | |
| 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: IETF BCP-47 (required) | |
| 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) |
| 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 Binding: FilterOperator (required) |
| value | S | 1..1 | code | Code from the system, or regex criteria |
 exclude | S I | 0..* | Unknown reference to #include Explicitly exclude codes | |
| expansion | S I | 0..1 | BackboneElement | Used when the value set is "expanded" |
| 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 | |
| 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 | S I | 0..* | BackboneElement | Codes in the value set vsd-9: Must have a code if not abstract vsd-6: SHALL have a code or a display vsd-10: Must have a system if a code is present |
| valueset-label | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| valueString | 1..1 | string | Value of extension | |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| valueset-conceptOrder | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| 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 | S I | 0..1 | code | Code - if blank, this is not a selectable code |
| display | S I | 0..1 | string | User display for the concept |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| contains | S | 0..* | Unknown reference to #contains Codes contained under this entry | |
| Documentation for this format | ||||
todo
This structure is derived from ValueSet.
Differential View
This structure is derived from ValueSet.
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 0..* | ValueSet | A set of codes drawn from one or more code systems vsd-5: Value set SHALL contain at least one of a a compose, or an expansion element vsd-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set includes an inline code system |
| 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: IETF BCP-47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| styleSensitive | S | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/styleSensitive |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | S ∑ | 0..1 | uri | Globally unique logical identifier for value set |
| identifier | ∑ | 0..1 | Identifier | Additional identifier for the value set (e.g. HL7 v2 / CDA) |
| version | ∑ | 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 | ∑ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | ∑ | 0..* | BackboneElement | Contact details of the publisher |
| 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 ∑ | 1..1 | string | 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 ∑ | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| requirements | 0..1 | string | Why needed | |
| copyright | 0..1 | string | Use and/or publishing restrictions | |
| extensible | S ∑ | 1..1 | boolean | Whether this is intended to be used with an extensible binding |
| compose | S I | 0..1 | BackboneElement | When value set includes codes from elsewhere vsd-1: A value set composition SHALL have an include or an import |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
| import | S ∑I | 0..* | uri | Import the contents of another value set |
| include | S ∑I | 0..* | BackboneElement | Include one or more codes from a code system vsd-11: Cannot have both concept and filter |
| 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 | S I | 0..* | BackboneElement | A concept defined in the system |
| valueset-label | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| valueString | 1..1 | string | Value of extension | |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| valueset-conceptOrder | S | 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 | Test to display for this code for this value set |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| designation | 0..* | BackboneElement | Additional representations for this valueset | |
| 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: IETF BCP-47 (required) | |
| 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) |
| 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 Binding: FilterOperator (required) |
| value | S | 1..1 | code | Code from the system, or regex criteria |
| exclude | S I | 0..* | Unknown reference to #include Explicitly exclude codes | |
| expansion | S I | 0..1 | BackboneElement | Used when the value set is "expanded" |
| 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 | |
| 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 | S I | 0..* | BackboneElement | Codes in the value set vsd-9: Must have a code if not abstract vsd-6: SHALL have a code or a display vsd-10: Must have a system if a code is present |
| valueset-label | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| valueString | 1..1 | string | Value of extension | |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| valueset-conceptOrder | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| 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 | S I | 0..1 | code | Code - if blank, this is not a selectable code |
| display | S I | 0..1 | string | User display for the concept |
| style | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/style | |
| markup | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/markup | |
| value | 0..1 | Primitive value for string | ||
| contains | S | 0..* | Unknown reference to #contains Codes contained under this entry | |
| Documentation for this format | ||||
XML Template
JSON Template
todo
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| ValueSet.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| ValueSet.status | ConformanceResourceStatus | required | ConformanceResourceStatus |
| ValueSet.useContext | Context of Use ValueSet | extensible | Context of Use ValueSet |
| ValueSet.compose.include.concept.designation.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
| ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |
| Id | Path | Details | Requirements |
| 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) | |
| vsd-2 | ValueSet | A value set with only one import SHALL also have an include and/or an exclude unless the value set includes an inline code system 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-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)) | |
| vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract XPath: exists(f:code) or (f:abstract/@value = true()) | |
| vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display XPath: exists(f:code) or exists(f:display) | |
| vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present XPath: exists(f:system) or not(exists(f:code)) |
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:10+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change