DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

6.21.3.4 StructureDefinition: StructuredDataCaptureValueSet

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/valueset-sdc-de-structureddatacapturevalueset

Defines how ValueSet is used to reflect code lists found in data element defintions for exchange and maintenance between data element registries according to requirements established by the ONC's Structured Data Capture standard.

This profile was published on Sun, Jul 6, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC)'s Standards and Infrastructure (S&I) Structured Data Capture project.

6.21.3.4.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from ValueSet.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1ValueSet
... url S0..1uri
... identifier S1..1Identifier
... version S0..1string
... name S1..1string
... immutable S1..1boolean
... publisher S0..1string
... status S1..1code
... experimental S0..1boolean
... extensible S1..1boolean
... date S0..1dateTime
... lockedDate S0..1date
... define S0..1
.... system S1..1uri
.... version S0..1string
.... caseSensitive S0..1boolean
.... concept S0..*
..... code S1..1code
..... abstract S0..1boolean
..... display S0..1string
..... definition S0..1string
..... concept S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
... compose S0..1
.... import S0..*uri
.... include S0..*
..... system S1..1uri
..... version S0..1string
..... concept S0..*code
...... code S1..1code
...... display S0..1string
...... valueset-conceptOrder S0..1integerAppearance order for user selection
..... filter S0..*
...... property S1..1code
...... op S1..1code
...... value S1..1code
.... exclude S0..*
... expansion S0..1
.... timestamp S1..1dateTime
.... contains S0..*
..... system S1..1uri
..... abstract S0..1boolean
..... version S0..1string
..... code S0..1code
..... display S0..1string
..... contains S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
..... valueset-definition S0..1stringA definition for this code
..... valueset-systemName S1..1stringCode system name
... valueset-category S0..*CodeableConceptKind of value set
... valueset-trusted-expansion S0..1uriReference to a trusted expansion
... valueset-effectiveDate S0..1dateWhen the value set version becomes Active and is available for use
... valueset-expirationDate S0..1dateWhen the value set version should no longer be used
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1ValueSetA set of codes drawn from one or more code systems
vsd-7: A defined code system (if present) SHALL have a different identifier to the value set itself
vsd-5: Value set SHALL contain either a define, 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 defines its own codes
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... valueset-category S0..*CodeableConceptExtension
... valueset-trusted-expansion S0..1uriExtension
... valueset-effectiveDate S0..1dateExtension
... valueset-expirationDate S0..1dateExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S Σ0..1uriGlobally unique logical id for value set
... identifier S Σ1..1IdentifierAdditional identifier for the value set (v2 / CDA)
... version S Σ0..1stringLogical id for this version of the value set
... name S Σ1..1stringInformal name for this value set
... useContext Σ0..*CodeableConceptContent intends to support these contexts
Binding: ConformanceUseContext (extensible)
... immutable S Σ1..1booleanIndicates whether or not any change to the content logical definition may occur
... publisher S Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*Contact details of the publisher
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... description Σ0..1stringHuman language description of the value set
... requirements 0..1stringWhy is this needed?
... copyright 0..1stringUse and/or Publishing restrictions
... status ?! SΣ1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S Σ0..1booleanIf for testing purposes, not real usage
... extensible S Σ1..1booleanWhether this is intended to be used with an extensible binding
... date S Σ0..1dateTimeDate for given status
... lockedDate S Σ0..1dateFixed date for all referenced code systems and value sets
... define S ΣI0..1When value set defines its own codes
vsd-8: Codes must be unique
vsd-3: Within a code system definition, all the codes SHALL be unique
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... system S Σ1..1uriURI to identify the code system
.... version S Σ0..1stringVersion of this system
.... caseSensitive S Σ0..1booleanIf code comparison is case sensitive
.... concept S0..*Concepts in the code system
..... valueset-conceptOrder S0..1integerExtension
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... code S1..1codeCode that identifies concept
..... abstract S0..1booleanIf this code is not for use as a real concept
..... display S0..1stringText to Display to the user
..... definition S0..1stringFormal Definition
..... designation 0..*Additional representations for the concept
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... language 0..1codeLanguage of the designation
Binding: Language (required)
...... use 0..1CodingDetails how this designation would be used
Binding: ConceptDesignationUse (extensible)
...... value 1..1stringThe text value for this designation
..... concept S0..*Child Concepts (is-a / contains)
... compose S I0..1When value set includes codes from elsewhere
vsd-1: A value set composition SHALL have an include or an import
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... import S ΣI0..*uriImport the contents of another value set
.... include S ΣI0..*Include one or more codes from a code system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... system S Σ1..1uriThe system the codes come from
..... version S Σ0..1stringSpecific version of the code system referred to
..... concept S0..*codeA concept defined in the system
...... valueset-conceptOrder S0..1integerExtension
...... value 0..1xs:stringPrimitive value for code
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... code 1..1codeCode or expression from system
...... display 0..1stringTest to display for this code for this value set
...... designation 0..*Additional representations for this valueset
..... filter S0..*Select codes/concepts by their properties (including relationships)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... property S1..1codeA property defined by the code system
...... op S1..1code= | is-a | is-not-a | regex | in | not-in
Binding: FilterOperator (required)
...... value S1..1codeCode from the system, or regex criteria
.... exclude S I0..*Explicitly exclude codes
... expansion S I0..1Used when the value set is "expanded"
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp S1..1dateTimeTime valueset expansion happened
.... parameter 0..*Parameter that controlled the expansion process
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName as assigned by server
..... value[x] I0..1string, boolean, integer, decimal, uri, codeValue of the parameter
.... contains S I0..*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-conceptOrder S0..1integerExtension
..... valueset-definition S0..1stringExtension
..... valueset-systemName S1..1stringExtension
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... system S1..1uriSystem value for the code
..... abstract S0..1booleanIf user cannot select this entry
..... version S0..1stringVersion in which this code / display is defined
..... code S I0..1codeCode - if blank, this is not a choosable code
..... display S I0..1stringUser display for the concept
..... contains S0..*Codes contained in this concept

todo

Differential View

This structure is derived from ValueSet.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 1..1ValueSet
... url S0..1uri
... identifier S1..1Identifier
... version S0..1string
... name S1..1string
... immutable S1..1boolean
... publisher S0..1string
... status S1..1code
... experimental S0..1boolean
... extensible S1..1boolean
... date S0..1dateTime
... lockedDate S0..1date
... define S0..1
.... system S1..1uri
.... version S0..1string
.... caseSensitive S0..1boolean
.... concept S0..*
..... code S1..1code
..... abstract S0..1boolean
..... display S0..1string
..... definition S0..1string
..... concept S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
... compose S0..1
.... import S0..*uri
.... include S0..*
..... system S1..1uri
..... version S0..1string
..... concept S0..*code
...... code S1..1code
...... display S0..1string
...... valueset-conceptOrder S0..1integerAppearance order for user selection
..... filter S0..*
...... property S1..1code
...... op S1..1code
...... value S1..1code
.... exclude S0..*
... expansion S0..1
.... timestamp S1..1dateTime
.... contains S0..*
..... system S1..1uri
..... abstract S0..1boolean
..... version S0..1string
..... code S0..1code
..... display S0..1string
..... contains S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
..... valueset-definition S0..1stringA definition for this code
..... valueset-systemName S1..1stringCode system name
... valueset-category S0..*CodeableConceptKind of value set
... valueset-trusted-expansion S0..1uriReference to a trusted expansion
... valueset-effectiveDate S0..1dateWhen the value set version becomes Active and is available for use
... valueset-expirationDate S0..1dateWhen the value set version should no longer be used

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I1..1ValueSetA set of codes drawn from one or more code systems
vsd-7: A defined code system (if present) SHALL have a different identifier to the value set itself
vsd-5: Value set SHALL contain either a define, 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 defines its own codes
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... valueset-category S0..*CodeableConceptExtension
... valueset-trusted-expansion S0..1uriExtension
... valueset-effectiveDate S0..1dateExtension
... valueset-expirationDate S0..1dateExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S Σ0..1uriGlobally unique logical id for value set
... identifier S Σ1..1IdentifierAdditional identifier for the value set (v2 / CDA)
... version S Σ0..1stringLogical id for this version of the value set
... name S Σ1..1stringInformal name for this value set
... useContext Σ0..*CodeableConceptContent intends to support these contexts
Binding: ConformanceUseContext (extensible)
... immutable S Σ1..1booleanIndicates whether or not any change to the content logical definition may occur
... publisher S Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*Contact details of the publisher
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... description Σ0..1stringHuman language description of the value set
... requirements 0..1stringWhy is this needed?
... copyright 0..1stringUse and/or Publishing restrictions
... status ?! SΣ1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S Σ0..1booleanIf for testing purposes, not real usage
... extensible S Σ1..1booleanWhether this is intended to be used with an extensible binding
... date S Σ0..1dateTimeDate for given status
... lockedDate S Σ0..1dateFixed date for all referenced code systems and value sets
... define S ΣI0..1When value set defines its own codes
vsd-8: Codes must be unique
vsd-3: Within a code system definition, all the codes SHALL be unique
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... system S Σ1..1uriURI to identify the code system
.... version S Σ0..1stringVersion of this system
.... caseSensitive S Σ0..1booleanIf code comparison is case sensitive
.... concept S0..*Concepts in the code system
..... valueset-conceptOrder S0..1integerExtension
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... code S1..1codeCode that identifies concept
..... abstract S0..1booleanIf this code is not for use as a real concept
..... display S0..1stringText to Display to the user
..... definition S0..1stringFormal Definition
..... designation 0..*Additional representations for the concept
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... language 0..1codeLanguage of the designation
Binding: Language (required)
...... use 0..1CodingDetails how this designation would be used
Binding: ConceptDesignationUse (extensible)
...... value 1..1stringThe text value for this designation
..... concept S0..*Child Concepts (is-a / contains)
... compose S I0..1When value set includes codes from elsewhere
vsd-1: A value set composition SHALL have an include or an import
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... import S ΣI0..*uriImport the contents of another value set
.... include S ΣI0..*Include one or more codes from a code system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... system S Σ1..1uriThe system the codes come from
..... version S Σ0..1stringSpecific version of the code system referred to
..... concept S0..*codeA concept defined in the system
...... valueset-conceptOrder S0..1integerExtension
...... value 0..1xs:stringPrimitive value for code
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... code 1..1codeCode or expression from system
...... display 0..1stringTest to display for this code for this value set
...... designation 0..*Additional representations for this valueset
..... filter S0..*Select codes/concepts by their properties (including relationships)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... property S1..1codeA property defined by the code system
...... op S1..1code= | is-a | is-not-a | regex | in | not-in
Binding: FilterOperator (required)
...... value S1..1codeCode from the system, or regex criteria
.... exclude S I0..*Explicitly exclude codes
... expansion S I0..1Used when the value set is "expanded"
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp S1..1dateTimeTime valueset expansion happened
.... parameter 0..*Parameter that controlled the expansion process
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName as assigned by server
..... value[x] I0..1string, boolean, integer, decimal, uri, codeValue of the parameter
.... contains S I0..*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-conceptOrder S0..1integerExtension
..... valueset-definition S0..1stringExtension
..... valueset-systemName S1..1stringExtension
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... system S1..1uriSystem value for the code
..... abstract S0..1booleanIf user cannot select this entry
..... version S0..1stringVersion in which this code / display is defined
..... code S I0..1codeCode - if blank, this is not a choosable code
..... display S I0..1stringUser display for the concept
..... contains S0..*Codes contained in this concept

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

6.21.3.4.2 Terminology Bindings

PathNameConformanceValueSet
ValueSet.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
ValueSet.useContextConformanceUseContextextensibleContext of Use ValueSet
ValueSet.statusConformanceResourceStatusrequiredConformanceResourceStatus
ValueSet.define.concept.designation.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
ValueSet.define.concept.designation.useConceptDesignationUseextensibleDesignation Use
ValueSet.compose.include.filter.opFilterOperatorrequiredFilterOperator

6.21.3.4.3 Constraints

IdPathNameDetails
vsd-7ValueSetA defined code system (if present) SHALL have a different identifier to the value set itself
XPath: not(f:define/f:system/@value = f:identifier/@value)
vsd-5ValueSetValue set SHALL contain either a define, a compose, or an expansion element
XPath: exists(f:define) or exists(f:compose) or exists(f:expansion)
vsd-2ValueSetA value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes
XPath: not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define))
vsd-8ValueSet.defineCodes must be unique
XPath: count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))
vsd-3ValueSet.defineWithin a code system definition, all the codes SHALL be unique
XPath: count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)
vsd-1ValueSet.composeA value set composition SHALL have an include or an import
XPath: exists(f:include) or exists(f:import)
vsd-9ValueSet.expansion.containsMust have a code if not abstract
XPath: exists(f:code) or (f:display/@value = 'true')
vsd-6ValueSet.expansion.containsSHALL have a code or a display
XPath: exists(f:code) or exists(f:display)
vsd-10ValueSet.expansion.containsMust have a system if a code is present
XPath: exists(f:system) or not(exists(f:code))
.