This page is part of the Sharing Valuesets, Codes, and Maps (SVCM) (v1.5.1: Publication) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: SVCM ValueSet

A profile on the ValueSet resource for SVCM.

Usage:

• Examples for this Resource Profile: SVCMExampleValueSet and SVCMExample2ValueSet

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Shareable ValueSet

Name	Flags	Card.	Type	Description & Constraints
ValueSet		1..1	Shareable ValueSet	A set of codes drawn from one or more code systems
url		1..1	uri	For existing value sets with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
identifier		0..*	Identifier	The identifier shall contain any business identifiers this value set is identified by.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	1..1	Shareable ValueSet	A set of codes drawn from one or more code systems
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	For existing value sets with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
identifier	Σ	0..*	Identifier	The identifier shall contain any business identifiers this value set is identified by.
version	Σ	1..1	string	Business version of the value set
name	ΣC	1..1	string	Name for this value set (computer friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
description		1..1	markdown	Natural language description of the value set
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.status	required	PublicationStatus

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	1..1	Shareable ValueSet	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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		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	For existing value sets with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
identifier	Σ	0..*	Identifier	The identifier shall contain any business identifiers this value set is identified by.
version	Σ	1..1	string	Business version of the value set
name	ΣC	1..1	string	Name for this value set (computer friendly)
title	Σ	0..1	string	Name for this value set (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		1..1	markdown	Natural language description of the value set
useContext	ΣTU	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
immutable	Σ	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
compose		0..1	BackboneElement	Content logical definition of the value set (CLD)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lockedDate	Σ	0..1	date	Fixed date for references with no specified version (transitive)
inactive	Σ	0..1	boolean	Whether inactive codes are in the value set
include	ΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system	ΣC	0..1	uri	The system the codes come from
version	Σ	0..1	string	Specific version of the code system referred to
concept	C	0..*	BackboneElement	A concept defined in the system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	code	Code or expression from system
display		0..1	string	Text to display for this code for this value set in this valueset
designation		0..*	BackboneElement	Additional representations for this concept
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		0..1	code	Human language of the designation Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
use		0..1	Coding	Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value		1..1	string	The text value for this designation
filter	ΣC	0..*	BackboneElement	Select codes/concepts by their properties (including relationships)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
property	Σ	1..1	code	A property/filter defined by the code system
op	Σ	1..1	code	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value	Σ	1..1	string	Code from the system, or regex criteria, or boolean value for exists
valueSet	ΣC	0..*	canonical(ValueSet)	Select the contents included in this value set
exclude	C	0..*	See include (ValueSet)	Explicitly exclude codes from a code system or other value sets
expansion		0..1	BackboneElement	Used when the value set is "expanded"
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	uri	Identifies the value set expansion (business identifier)
timestamp		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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	string	Name as assigned by the client or server
value[x]		0..1		Value of the named parameter
valueString			string
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueUri			uri
valueCode			code
valueDateTime			dateTime
contains	C	0..*	BackboneElement	Codes in the value set
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system		0..1	uri	System value for the code
abstract		0..1	boolean	If user cannot select this entry
inactive		0..1	boolean	If concept is inactive in the code system
version		0..1	string	Version in which this code/display is defined
code	C	0..1	code	Code - if blank, this is not a selectable code
display	C	0..1	string	User display for the concept
designation		0..*	See designation (ValueSet)	Additional representations for this item
contains		0..*	See contains (ValueSet)	Codes contained under this entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.status	required	PublicationStatus
ValueSet.jurisdiction	extensible	Jurisdiction ValueSet
ValueSet.compose.include.concept.designation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use	extensible	DesignationUse
ValueSet.compose.include.filter.op	required	FilterOperator

This structure is derived from Shareable ValueSet

Summary

Differential View

This structure is derived from Shareable ValueSet

Name	Flags	Card.	Type	Description & Constraints
ValueSet		1..1	Shareable ValueSet	A set of codes drawn from one or more code systems
url		1..1	uri	For existing value sets with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
identifier		0..*	Identifier	The identifier shall contain any business identifiers this value set is identified by.
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	1..1	Shareable ValueSet	A set of codes drawn from one or more code systems
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	For existing value sets with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
identifier	Σ	0..*	Identifier	The identifier shall contain any business identifiers this value set is identified by.
version	Σ	1..1	string	Business version of the value set
name	ΣC	1..1	string	Name for this value set (computer friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
description		1..1	markdown	Natural language description of the value set
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.status	required	PublicationStatus

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	1..1	Shareable ValueSet	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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		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	For existing value sets with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
identifier	Σ	0..*	Identifier	The identifier shall contain any business identifiers this value set is identified by.
version	Σ	1..1	string	Business version of the value set
name	ΣC	1..1	string	Name for this value set (computer friendly)
title	Σ	0..1	string	Name for this value set (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		1..1	markdown	Natural language description of the value set
useContext	ΣTU	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
immutable	Σ	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
compose		0..1	BackboneElement	Content logical definition of the value set (CLD)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lockedDate	Σ	0..1	date	Fixed date for references with no specified version (transitive)
inactive	Σ	0..1	boolean	Whether inactive codes are in the value set
include	ΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system	ΣC	0..1	uri	The system the codes come from
version	Σ	0..1	string	Specific version of the code system referred to
concept	C	0..*	BackboneElement	A concept defined in the system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	code	Code or expression from system
display		0..1	string	Text to display for this code for this value set in this valueset
designation		0..*	BackboneElement	Additional representations for this concept
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		0..1	code	Human language of the designation Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
use		0..1	Coding	Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value		1..1	string	The text value for this designation
filter	ΣC	0..*	BackboneElement	Select codes/concepts by their properties (including relationships)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
property	Σ	1..1	code	A property/filter defined by the code system
op	Σ	1..1	code	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value	Σ	1..1	string	Code from the system, or regex criteria, or boolean value for exists
valueSet	ΣC	0..*	canonical(ValueSet)	Select the contents included in this value set
exclude	C	0..*	See include (ValueSet)	Explicitly exclude codes from a code system or other value sets
expansion		0..1	BackboneElement	Used when the value set is "expanded"
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	uri	Identifies the value set expansion (business identifier)
timestamp		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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	string	Name as assigned by the client or server
value[x]		0..1		Value of the named parameter
valueString			string
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueUri			uri
valueCode			code
valueDateTime			dateTime
contains	C	0..*	BackboneElement	Codes in the value set
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system		0..1	uri	System value for the code
abstract		0..1	boolean	If user cannot select this entry
inactive		0..1	boolean	If concept is inactive in the code system
version		0..1	string	Version in which this code/display is defined
code	C	0..1	code	Code - if blank, this is not a selectable code
display	C	0..1	string	User display for the concept
designation		0..*	See designation (ValueSet)	Additional representations for this item
contains		0..*	See contains (ValueSet)	Codes contained under this entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.status	required	PublicationStatus
ValueSet.jurisdiction	extensible	Jurisdiction ValueSet
ValueSet.compose.include.concept.designation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use	extensible	DesignationUse
ValueSet.compose.include.filter.op	required	FilterOperator

This structure is derived from Shareable ValueSet

Summary

Other representations of profile: CSV, Excel, Schematron