Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

C.2.1 StructureDefinition: SDCDE-ValueSet

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/sdcde-valueset

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 Health Level Seven International (Orders and Observations - Structured Data Capture).

C.2.1.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 0..*ValueSet
... url S0..1uri
... identifier S1..1Identifier
... version S0..1string
... name S1..1string
... status S1..1code
... experimental S0..1boolean
... publisher S0..1string
... date S0..1dateTime
... lockedDate S0..1date
... description S0..1string
... useContext S0..*CodeableConcept
... immutable S0..1boolean
... extensible S0..1boolean
... codeSystem S0..1BackboneElement
.... system S1..1uri
.... version S0..1string
.... caseSensitive S0..1boolean
.... concept S1..*BackboneElement
..... code S1..1code
..... abstract S0..1boolean
..... display S0..1string
..... definition S0..1string
..... concept S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
... compose S0..1BackboneElement
.... import S0..*uri
.... include S0..*BackboneElement
..... system S1..1uri
..... version S0..1string
..... concept S0..*BackboneElement
...... code S1..1code
...... display S0..1string
...... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... filter S0..*BackboneElement
...... property S1..1code
...... op S1..1code
...... value S1..1code
.... exclude S0..*
... expansion S0..1BackboneElement
.... identifier S1..1uri
.... timestamp S1..1dateTime
.... contains S0..*BackboneElement
..... system S0..1uri
..... abstract S0..1boolean
..... version S0..1string
..... code S0..1code
..... display S0..1string
..... contains S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... valueset-definition S0..1stringA definition for this code
URL: http://hl7.org/fhir/StructureDefinition/valueset-definition
..... valueset-systemName S1..1stringCode system name
URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName
... styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/styleSensitive
... valueset-trusted-expansion S0..1uriReference to a trusted expansion
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... valueset-effectiveDate S0..1dateWhen the value set version becomes Active and is available for use
URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
... valueset-expirationDate S0..1dateWhen the value set version should no longer be used
URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
vsd-7: A defined code system (if present) SHALL have a different url than the value set url
vsd-5: Value set SHALL contain at least one of a codeSystem, 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 and inline code system
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... styleSensitive S0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/styleSensitive
... valueset-trusted-expansion S0..1uriExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... valueset-effectiveDate S0..1dateExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
... valueset-expirationDate S0..1dateExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S ∑0..1uriGlobally unique logical identifier for value set
... identifier S ∑1..1IdentifierAdditional identifier for the value set (e.g. HL7 v2 / CDA)
... version S ∑0..1stringLogical identifier for this version of the value set
... name S ∑1..1stringInformal name for this value set
... status ?! S∑1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S ∑0..1booleanIf for testing purposes, not real usage
... publisher S ∑0..1stringName of the publisher (organization or individual)
... contact ∑0..*BackboneElementContact details of the publisher
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name ∑0..1stringName of an individual to contact
.... telecom ∑0..*ContactPointContact details for individual or publisher
... date S ∑0..1dateTimeDate for given status
... lockedDate S ∑0..1dateFixed date for all referenced code systems and value sets
... description S ∑0..1stringHuman language description of the value set
... useContext S ∑0..*CodeableConceptContent intends to support these contexts
Binding: Context of Use ValueSet (extensible)
... immutable S ∑0..1booleanIndicates whether or not any change to the content logical definition may occur
... requirements 0..1stringWhy needed
... copyright 0..1stringUse and/or publishing restrictions
... extensible S ∑0..1booleanWhether this is intended to be used with an extensible binding
... codeSystem S ∑I0..1BackboneElementAn inline code system, which is part of this value set
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 (e.g. in Coding.system)
.... version S ∑0..1stringVersion (for use in Coding.version)
.... caseSensitive S ∑0..1booleanIf code comparison is case sensitive
.... concept S1..*BackboneElementConcepts in the code system
..... valueset-conceptOrder S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... 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..*BackboneElementAdditional representations for the concept
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... language 0..1codeHuman language of the designation
Binding: IETF BCP-47 (required)
...... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible)
...... value 1..1stringThe text value for this designation
..... concept S0..*See ValueSet.codeSystem.conceptChild Concepts (is-a/contains/categorizes)
... compose S I0..1BackboneElementWhen 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..*BackboneElementInclude one or more codes from a code system
vsd-11: Cannot have both concept and filter
..... 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 S I0..*BackboneElementA concept defined in the system
...... valueset-conceptOrder S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... code S1..1codeCode or expression from system
...... display S0..1stringTest to display for this code for this value set
...... designation 0..*See ValueSet.codeSystem.concept.designationAdditional representations for this valueset
..... filter S I0..*BackboneElementSelect 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..*See ValueSet.compose.includeExplicitly exclude codes
... expansion S I0..1BackboneElementUsed when the value set is "expanded"
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier S1..1uriUniquely identifies this expansion
.... timestamp S1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter 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 the server
..... value[x] 0..1string, boolean, integer, decimal, uri, codeValue of the named parameter
.... contains S I0..*BackboneElementCodes 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
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... valueset-definition S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-definition
..... valueset-systemName S1..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... system S0..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 selectable code
..... display S I0..1stringUser display for the concept
..... contains S0..*See ValueSet.expansion.containsCodes contained under this entry

doco Documentation for this format

todo

Differential View

This structure is derived from ValueSet.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*ValueSet
... url S0..1uri
... identifier S1..1Identifier
... version S0..1string
... name S1..1string
... status S1..1code
... experimental S0..1boolean
... publisher S0..1string
... date S0..1dateTime
... lockedDate S0..1date
... description S0..1string
... useContext S0..*CodeableConcept
... immutable S0..1boolean
... extensible S0..1boolean
... codeSystem S0..1BackboneElement
.... system S1..1uri
.... version S0..1string
.... caseSensitive S0..1boolean
.... concept S1..*BackboneElement
..... code S1..1code
..... abstract S0..1boolean
..... display S0..1string
..... definition S0..1string
..... concept S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
... compose S0..1BackboneElement
.... import S0..*uri
.... include S0..*BackboneElement
..... system S1..1uri
..... version S0..1string
..... concept S0..*BackboneElement
...... code S1..1code
...... display S0..1string
...... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... filter S0..*BackboneElement
...... property S1..1code
...... op S1..1code
...... value S1..1code
.... exclude S0..*
... expansion S0..1BackboneElement
.... identifier S1..1uri
.... timestamp S1..1dateTime
.... contains S0..*BackboneElement
..... system S0..1uri
..... abstract S0..1boolean
..... version S0..1string
..... code S0..1code
..... display S0..1string
..... contains S0..*
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... valueset-definition S0..1stringA definition for this code
URL: http://hl7.org/fhir/StructureDefinition/valueset-definition
..... valueset-systemName S1..1stringCode system name
URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName
... styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/styleSensitive
... valueset-trusted-expansion S0..1uriReference to a trusted expansion
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... valueset-effectiveDate S0..1dateWhen the value set version becomes Active and is available for use
URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
... valueset-expirationDate S0..1dateWhen the value set version should no longer be used
URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
vsd-7: A defined code system (if present) SHALL have a different url than the value set url
vsd-5: Value set SHALL contain at least one of a codeSystem, 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 and inline code system
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... styleSensitive S0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/styleSensitive
... valueset-trusted-expansion S0..1uriExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
... valueset-effectiveDate S0..1dateExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
... valueset-expirationDate S0..1dateExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S ∑0..1uriGlobally unique logical identifier for value set
... identifier S ∑1..1IdentifierAdditional identifier for the value set (e.g. HL7 v2 / CDA)
... version S ∑0..1stringLogical identifier for this version of the value set
... name S ∑1..1stringInformal name for this value set
... status ?! S∑1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S ∑0..1booleanIf for testing purposes, not real usage
... publisher S ∑0..1stringName of the publisher (organization or individual)
... contact ∑0..*BackboneElementContact details of the publisher
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name ∑0..1stringName of an individual to contact
.... telecom ∑0..*ContactPointContact details for individual or publisher
... date S ∑0..1dateTimeDate for given status
... lockedDate S ∑0..1dateFixed date for all referenced code systems and value sets
... description S ∑0..1stringHuman language description of the value set
... useContext S ∑0..*CodeableConceptContent intends to support these contexts
Binding: Context of Use ValueSet (extensible)
... immutable S ∑0..1booleanIndicates whether or not any change to the content logical definition may occur
... requirements 0..1stringWhy needed
... copyright 0..1stringUse and/or publishing restrictions
... extensible S ∑0..1booleanWhether this is intended to be used with an extensible binding
... codeSystem S ∑I0..1BackboneElementAn inline code system, which is part of this value set
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 (e.g. in Coding.system)
.... version S ∑0..1stringVersion (for use in Coding.version)
.... caseSensitive S ∑0..1booleanIf code comparison is case sensitive
.... concept S1..*BackboneElementConcepts in the code system
..... valueset-conceptOrder S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... 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..*BackboneElementAdditional representations for the concept
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... language 0..1codeHuman language of the designation
Binding: IETF BCP-47 (required)
...... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible)
...... value 1..1stringThe text value for this designation
..... concept S0..*See ValueSet.codeSystem.conceptChild Concepts (is-a/contains/categorizes)
... compose S I0..1BackboneElementWhen 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..*BackboneElementInclude one or more codes from a code system
vsd-11: Cannot have both concept and filter
..... 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 S I0..*BackboneElementA concept defined in the system
...... valueset-conceptOrder S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... code S1..1codeCode or expression from system
...... display S0..1stringTest to display for this code for this value set
...... designation 0..*See ValueSet.codeSystem.concept.designationAdditional representations for this valueset
..... filter S I0..*BackboneElementSelect 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..*See ValueSet.compose.includeExplicitly exclude codes
... expansion S I0..1BackboneElementUsed when the value set is "expanded"
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier S1..1uriUniquely identifies this expansion
.... timestamp S1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter 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 the server
..... value[x] 0..1string, boolean, integer, decimal, uri, codeValue of the named parameter
.... contains S I0..*BackboneElementCodes 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
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... valueset-definition S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-definition
..... valueset-systemName S1..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-systemName
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... system S0..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 selectable code
..... display S I0..1stringUser display for the concept
..... contains S0..*See ValueSet.expansion.containsCodes contained under this entry

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

C.2.1.2 Terminology Bindings

PathNameConformanceValueSet
ValueSet.language?extrequiredhttp://tools.ietf.org/html/bcp47
ValueSet.statusConformanceResourceStatusrequiredConformanceResourceStatus
ValueSet.useContextContext of Use ValueSetextensibleContext of Use ValueSet
ValueSet.codeSystem.concept.designation.language?extrequiredhttp://tools.ietf.org/html/bcp47
ValueSet.codeSystem.concept.designation.useDesignation UseextensibleDesignation Use
ValueSet.compose.include.filter.opFilterOperatorrequiredFilterOperator

C.2.1.3 Constraints

IdPathDetailsRequirements
vsd-7ValueSetA defined code system (if present) SHALL have a different url than the value set url
XPath: not(f:codeSystem/f:system/@value = f:url/@value)
vsd-5ValueSetValue set SHALL contain at least one of a codeSystem, a compose, or an expansion element
XPath: exists(f:codeSystem) 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 includes and 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) or exists(f:codeSystem))
vsd-8ValueSet.codeSystemCodes must be unique
XPath: count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))
vsd-3ValueSet.codeSystemWithin 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-11ValueSet.compose.includeCannot have both concept and filter
XPath: not(exists(f:concept)) or not(exists(f:filter))
vsd-9ValueSet.expansion.containsMust have a code if not abstract
XPath: exists(f:code) or (f:abstract/@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))
.