StructureDefinition: Definition

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.1.2 StructureDefinition: Definition

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition

Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets

This profile was published on [no date] as a draft by HL7.

6.21.1.2.1 Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
XML Template
JSON Template
All

This structure is derived from ValueSet.

Summary

Mandatory: 9 elements

This structure is derived from ValueSet.

Name	Card.	Type
ValueSet	1..1	ValueSet
url	1..1	uri
version	1..1	string
name	1..1	string
immutable	0..1	boolean
publisher	1..1	string
description	1..1	string
status	1..1	code
experimental	1..1	boolean
define	0..1
system	1..1	uri
version	0..1	string
caseSensitive	0..1	boolean
concept	0..*
code	1..1	code
abstract	0..1	boolean
display	0..1	string
definition	0..1	string
concept	0..*

Name	Flags	Card.	Type	Description & Constraints
ValueSet	I	1..1	ValueSet	A 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..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: Language (required)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Globally unique logical id for value set
identifier	Σ	0..1	Identifier	Additional identifier for the value set (v2 / CDA)
version	Σ	1..1	string	Logical id for this version of the value set
name	Σ	1..1	string	Informal name for this value set
useContext	Σ	0..*	CodeableConcept	Content intends to support these contexts Binding: ConformanceUseContext (extensible)
immutable	Σ	0..1	boolean	Indicates whether or not any change to the content logical definition may occur
publisher	Σ	1..1	string	Name of the publisher (Organization or individual)
contact	Σ	0..*		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 a individual to contact
telecom	Σ	0..*	ContactPoint	Contact details for individual or publisher
description	Σ	1..1	string	Human language description of the value set
requirements		0..1	string	Why is this needed?
copyright		0..1	string	Use and/or Publishing restrictions
status	?! Σ	1..1	code	draft \| active \| retired Binding: ConformanceResourceStatus (required)
experimental	Σ	1..1	boolean	If for testing purposes, not real usage
extensible	Σ	0..1	boolean	Whether this is intended to be used with an extensible binding
date	Σ	0..1	dateTime	Date for given status
lockedDate	Σ	0..1	date	Fixed date for all referenced code systems and value sets
define	Σ I	0..1		When 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..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
system	Σ	1..1	uri	URI to identify the code system
version	Σ	0..1	string	Version of this system
caseSensitive	Σ	0..1	boolean	If code comparison is case sensitive
concept		0..*		Concepts in the code system
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code		1..1	code	Code that identifies concept
abstract		0..1	boolean	If this code is not for use as a real concept
display		0..1	string	Text to Display to the user
definition		0..1	string	Formal Definition
designation		0..*		Additional representations for the concept
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
language		0..1	code	Language of the designation Binding: Language (required)
use		0..1	Coding	Details how this designation would be used Binding: ConceptDesignationUse (extensible)
value		1..1	string	The text value for this designation
concept		0..*		Child Concepts (is-a / contains)
compose	I	0..1		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	Σ I	0..*	uri	Import the contents of another value set
include	Σ I	0..*		Include one or more codes from a code system
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
system	Σ	1..1	uri	The system the codes come from
version	Σ	0..1	string	Specific version of the code system referred to
concept		0..*		A concept defined in the system
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code		1..1	code	Code or expression from system
display		0..1	string	Test to display for this code for this value set
designation		0..*		Additional representations for this valueset
filter		0..*		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		1..1	code	A property defined by the code system
op		1..1	code	= \| is-a \| is-not-a \| regex \| in \| not-in Binding: FilterOperator (required)
value		1..1	code	Code from the system, or regex criteria
exclude	I	0..*		Explicitly exclude codes
expansion	I	0..1		Used when the value set is "expanded"
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..1	uri	Uniquely identifies this expansion
timestamp		1..1	dateTime	Time valueset expansion happened
parameter		0..*		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 server
value[x]	I	0..1	string, boolean, integer, decimal, uri, code	Value of the parameter
contains	I	0..*		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
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
system		0..1	uri	System value for the code
abstract		0..1	boolean	If user cannot select this entry
version		0..1	string	Version in which this code / display is defined
code	I	0..1	code	Code - if blank, this is not a choosable code
display	I	0..1	string	User display for the concept
contains		0..*		Codes contained in this concept

todo

This structure is derived from ValueSet.

Summary

Mandatory: 9 elements

Differential View

This structure is derived from ValueSet.

Name	Card.	Type
ValueSet	1..1	ValueSet
url	1..1	uri
version	1..1	string
name	1..1	string
immutable	0..1	boolean
publisher	1..1	string
description	1..1	string
status	1..1	code
experimental	1..1	boolean
define	0..1
system	1..1	uri
version	0..1	string
caseSensitive	0..1	boolean
concept	0..*
code	1..1	code
abstract	0..1	boolean
display	0..1	string
definition	0..1	string
concept	0..*

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	I	1..1	ValueSet	A 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..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: Language (required)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Globally unique logical id for value set
identifier	Σ	0..1	Identifier	Additional identifier for the value set (v2 / CDA)
version	Σ	1..1	string	Logical id for this version of the value set
name	Σ	1..1	string	Informal name for this value set
useContext	Σ	0..*	CodeableConcept	Content intends to support these contexts Binding: ConformanceUseContext (extensible)
immutable	Σ	0..1	boolean	Indicates whether or not any change to the content logical definition may occur
publisher	Σ	1..1	string	Name of the publisher (Organization or individual)
contact	Σ	0..*		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 a individual to contact
telecom	Σ	0..*	ContactPoint	Contact details for individual or publisher
description	Σ	1..1	string	Human language description of the value set
requirements		0..1	string	Why is this needed?
copyright		0..1	string	Use and/or Publishing restrictions
status	?! Σ	1..1	code	draft \| active \| retired Binding: ConformanceResourceStatus (required)
experimental	Σ	1..1	boolean	If for testing purposes, not real usage
extensible	Σ	0..1	boolean	Whether this is intended to be used with an extensible binding
date	Σ	0..1	dateTime	Date for given status
lockedDate	Σ	0..1	date	Fixed date for all referenced code systems and value sets
define	Σ I	0..1		When 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..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
system	Σ	1..1	uri	URI to identify the code system
version	Σ	0..1	string	Version of this system
caseSensitive	Σ	0..1	boolean	If code comparison is case sensitive
concept		0..*		Concepts in the code system
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code		1..1	code	Code that identifies concept
abstract		0..1	boolean	If this code is not for use as a real concept
display		0..1	string	Text to Display to the user
definition		0..1	string	Formal Definition
designation		0..*		Additional representations for the concept
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
language		0..1	code	Language of the designation Binding: Language (required)
use		0..1	Coding	Details how this designation would be used Binding: ConceptDesignationUse (extensible)
value		1..1	string	The text value for this designation
concept		0..*		Child Concepts (is-a / contains)
compose	I	0..1		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	Σ I	0..*	uri	Import the contents of another value set
include	Σ I	0..*		Include one or more codes from a code system
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
system	Σ	1..1	uri	The system the codes come from
version	Σ	0..1	string	Specific version of the code system referred to
concept		0..*		A concept defined in the system
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code		1..1	code	Code or expression from system
display		0..1	string	Test to display for this code for this value set
designation		0..*		Additional representations for this valueset
filter		0..*		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		1..1	code	A property defined by the code system
op		1..1	code	= \| is-a \| is-not-a \| regex \| in \| not-in Binding: FilterOperator (required)
value		1..1	code	Code from the system, or regex criteria
exclude	I	0..*		Explicitly exclude codes
expansion	I	0..1		Used when the value set is "expanded"
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..1	uri	Uniquely identifies this expansion
timestamp		1..1	dateTime	Time valueset expansion happened
parameter		0..*		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 server
value[x]	I	0..1	string, boolean, integer, decimal, uri, code	Value of the parameter
contains	I	0..*		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
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
system		0..1	uri	System value for the code
abstract		0..1	boolean	If user cannot select this entry
version		0..1	string	Version in which this code / display is defined
code	I	0..1	code	Code - if blank, this is not a choosable code
display	I	0..1	string	User display for the concept
contains		0..*		Codes contained in this concept

XML Template

JSON Template

todo

Other representations of profile: (todo)

6.21.1.2.2 Terminology Bindings

Path	Name	Conformance	ValueSet
ValueSet.language	Language	required	http://tools.ietf.org/html/bcp47
ValueSet.useContext	ConformanceUseContext	extensible	Context of Use ValueSet
ValueSet.status	ConformanceResourceStatus	required	ConformanceResourceStatus
ValueSet.define.concept.designation.language	Language	required	http://tools.ietf.org/html/bcp47
ValueSet.define.concept.designation.use	ConceptDesignationUse	extensible	Designation Use
ValueSet.compose.include.filter.op	FilterOperator	required	FilterOperator

6.21.1.2.3 Constraints

Id	Path	Name	Details
vsd-7	ValueSet		A 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-5	ValueSet		Value 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-2	ValueSet		A 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-8	ValueSet.define		Codes must be unique XPath: count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))
vsd-3	ValueSet.define		Within 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-1	ValueSet.compose		A value set composition SHALL have an include or an import XPath: exists(f:include) or exists(f:import)
vsd-9	ValueSet.expansion.contains		Must have a code if not abstract XPath: exists(f:code) or (f:display/@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))

.