HL7.FHIR.US.CQFMEASURES\CQFM Executable ValueSet

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

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

text

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

usageWarning

S

1..1

Extra warning about the correct use of the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning

id

0..1

Unique id for inter-element referencing

0..0

url

1..1

"http://hl7.org/fhir/StructureDefinition/valueset-warning"

S

1..1

Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.

?!

0..*

Extensions that cannot be ignored

url

Σ

1..1

Canonical identifier for this value set, represented as a URI (globally unique)

Σ

0..*

Identifier

Additional identifier for the value set (business identifier)

Σ

1..1

Business version of the value set

ΣC

1..1

Name for this value set (computer friendly)

title

Σ

0..1

Name for this value set (human friendly)

status

?!Σ

1..1

draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

experimental

Σ

1..1

For testing purposes, not real usage

Σ

0..1

Date last changed

publisher

Σ

1..1

Name of the publisher (organization or individual)

contact

Σ

0..*

ContactDetail

Contact details for the publisher

description

1..1

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

Indicates whether or not any change to the content logical definition may occur

purpose

0..1

Why this value set is defined

copyright

0..1

Use and/or publishing restrictions

compose

0..1

Content logical definition of the value set (CLD)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

lockedDate

Σ

0..1

Fixed date for references with no specified version (transitive)

Σ

0..1

Whether inactive codes are in the value set

include

ΣC

1..*

Include one or more codes from a code system or other value set(s)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

ΣC

0..1

The system the codes come from

Σ

0..1

Specific version of the code system referred to

concept

0..*

A concept defined in the system

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Code or expression from system

0..1

Text to display for this code for this value set in this valueset

0..*

Additional representations for this concept

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Human language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

use

0..1

Coding

Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

1..1

The text value for this designation

filter

ΣC

0..*

Select codes/concepts by their properties (including relationships)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

property

Σ

1..1

A property/filter defined by the code system

op

Σ

1..1

Σ

1..1

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

0..*

See include (ValueSet)

Explicitly exclude codes from a code system or other value sets

expansion

SC

1..1

Used when the value set is "expanded"
evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Identifies the value set expansion (business identifier)

timestamp

1..1

Time ValueSet expansion happened

total

0..1

Total number of codes in the expansion

offset

0..1

Offset at which this resource starts

parameter

S

0..*

Parameter that controlled the expansion process

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Name as assigned by the client or server

0..1

Value of the named parameter

valueString

valueBoolean

valueInteger

valueDecimal

valueUri

valueCode

valueDateTime

SC

0..*

Codes in the value set

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

S

0..1

System value for the code

abstract

0..1

If user cannot select this entry

S

0..1

If concept is inactive in the code system

SC

0..1

Version in which this code/display is defined

SC

1..1

Code - if blank, this is not a selectable code

SC

0..1

User display for the concept

Documentation for this format

0..*

See designation (ValueSet)

Additional representations for this item

contains

S

0..*

See contains (ValueSet)

Codes contained under this entry

Terminology Bindings

Path

Conformance

ValueSet

ValueSet.language

Additional Bindings

Purpose

AllLanguages

Max Binding

ValueSet.status

PublicationStatus

ValueSet.jurisdiction

Jurisdiction ValueSet

ValueSet.compose.include.concept.designation.language

Additional Bindings

Purpose

AllLanguages

Max Binding

ValueSet.compose.include.concept.designation.use

DesignationUse

ValueSet.compose.include.filter.op

Description & Constraints

FilterOperator

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
evs-1	error	ValueSet.expansion	For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists()
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
vsd-1	error	ValueSet.compose.include	A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists()
vsd-2	error	ValueSet.compose.include	A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists()
vsd-3	error	ValueSet.compose.include	Cannot have both concept and filter : concept.empty() or filter.empty()
vsd-6	error	ValueSet.expansion.contains	SHALL have a code or a display : code.exists() or display.exists()
vsd-9	error	ValueSet.expansion.contains	Must have a code if not abstract : code.exists() or abstract = true
vsd-10	error	ValueSet.expansion.contains	Must have a system if a code is present : code.empty() or system.exists()

This structure is derived from Shareable ValueSet

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

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

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
usageWarning	S	1..1	markdown	Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
value[x]	S	1..1	markdown	Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
expansion	SC	1..1	BackboneElement	Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
parameter	S	0..*	BackboneElement	Parameter that controlled the expansion process
contains	S	0..*	BackboneElement	Codes in the value set
system	S	0..1	uri	System value for the code
inactive	S	0..1	boolean	If concept is inactive in the code system
version	SC	0..1	string	Version in which this code/display is defined
code	S	1..1	code	Code - if blank, this is not a selectable code
display	S	0..1	string	User display for the concept
contains	S	0..*		Codes contained under this entry
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
evs-1	error	ValueSet.expansion	For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists()

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
usageWarning	S	1..1	markdown	Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-warning"
value[x]	S	1..1	markdown	Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
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
expansion	SC	1..1	BackboneElement	Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
timestamp		1..1	dateTime	Time ValueSet expansion happened
parameter	S	0..*	BackboneElement	Parameter that controlled the expansion process
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	string	Name as assigned by the client or server
contains	SC	0..*	BackboneElement	Codes in the value set
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system	S	0..1	uri	System value for the code
inactive	S	0..1	boolean	If concept is inactive in the code system
version	SC	0..1	string	Version in which this code/display is defined
code	SC	1..1	code	Code - if blank, this is not a selectable code
display	SC	0..1	string	User display for the concept
contains	S	0..*	See contains (ValueSet)	Codes contained under this entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.status	required	PublicationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ValueSet	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ValueSet	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	ValueSet	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ValueSet	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
evs-1	error	ValueSet.expansion	For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists()
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
vsd-0	warning	ValueSet	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-6	error	ValueSet.expansion.contains	SHALL have a code or a display : code.exists() or display.exists()
vsd-9	error	ValueSet.expansion.contains	Must have a code if not abstract : code.exists() or abstract = true
vsd-10	error	ValueSet.expansion.contains	Must have a system if a code is present : code.empty() or system.exists()

Snapshot View

ValueSet

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

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

text

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

usageWarning

S

1..1

Extra warning about the correct use of the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning

id

0..1

Unique id for inter-element referencing

0..0

url

1..1

"http://hl7.org/fhir/StructureDefinition/valueset-warning"

S

1..1

Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated.

?!

0..*

Extensions that cannot be ignored

url

Σ

1..1

Canonical identifier for this value set, represented as a URI (globally unique)

Σ

0..*

Identifier

Additional identifier for the value set (business identifier)

Σ

1..1

Business version of the value set

ΣC

1..1

Name for this value set (computer friendly)

title

Σ

0..1

Name for this value set (human friendly)

status

?!Σ

1..1

draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

experimental

Σ

1..1

For testing purposes, not real usage

Σ

0..1

Date last changed

publisher

Σ

1..1

Name of the publisher (organization or individual)

contact

Σ

0..*

ContactDetail

Contact details for the publisher

description

1..1

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

Indicates whether or not any change to the content logical definition may occur

purpose

0..1

Why this value set is defined

copyright

0..1

Use and/or publishing restrictions

compose

0..1

Content logical definition of the value set (CLD)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

lockedDate

Σ

0..1

Fixed date for references with no specified version (transitive)

Σ

0..1

Whether inactive codes are in the value set

include

ΣC

1..*

Include one or more codes from a code system or other value set(s)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

ΣC

0..1

The system the codes come from

Σ

0..1

Specific version of the code system referred to

concept

0..*

A concept defined in the system

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Code or expression from system

0..1

Text to display for this code for this value set in this valueset

0..*

Additional representations for this concept

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Human language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

use

0..1

Coding

Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

1..1

The text value for this designation

filter

ΣC

0..*

Select codes/concepts by their properties (including relationships)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

property

Σ

1..1

A property/filter defined by the code system

op

Σ

1..1

Σ

1..1

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

0..*

See include (ValueSet)

Explicitly exclude codes from a code system or other value sets

expansion

SC

1..1

Used when the value set is "expanded"
evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-version" parameter corresponding to the system of the entry and the version matches the system-version parameter.

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

Identifies the value set expansion (business identifier)

timestamp

1..1

Time ValueSet expansion happened

total

0..1

Total number of codes in the expansion

offset

0..1

Offset at which this resource starts

parameter

S

0..*

Parameter that controlled the expansion process

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Name as assigned by the client or server

0..1

Value of the named parameter

valueString

valueBoolean

valueInteger

valueDecimal

valueUri

valueCode

valueDateTime

SC

0..*

Codes in the value set

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

S

0..1

System value for the code

abstract

0..1

If user cannot select this entry

S

0..1

If concept is inactive in the code system

SC

0..1

Version in which this code/display is defined

SC

1..1

Code - if blank, this is not a selectable code

SC

0..1

User display for the concept

Documentation for this format

0..*

See designation (ValueSet)

Additional representations for this item

contains

S

0..*

See contains (ValueSet)

Codes contained under this entry

Terminology Bindings

Path

Conformance

ValueSet

ValueSet.language

Additional Bindings

Purpose

AllLanguages

Max Binding

ValueSet.status

PublicationStatus

ValueSet.jurisdiction

Jurisdiction ValueSet

ValueSet.compose.include.concept.designation.language

Additional Bindings

Purpose

AllLanguages

Max Binding

ValueSet.compose.include.concept.designation.use

DesignationUse

ValueSet.compose.include.filter.op