Profile_R5_ValueSet_R3 - Extensions for Using Data Elements from FHIR R5 in FHIR STU3 v0.1.0

0..*

A set of codes drawn from one or more code systems
Constraints: vsd-5

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: Common Languages

(extensible): A human language.

Additional Bindings

Purpose

text

0..1

Narrative

Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

contained

0..*

Resource

Contained, inline Resources

0..*

extension:versionAlgorithm

Extension
Slice: Unordered, Open by value:url

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]]

R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm

extension:copyrightLabel

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]]

R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel

extension:approvalDate

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-approvalDate]]

R5: When the ValueSet was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate

extension:lastReviewDate

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate]]

R5: When the ValueSet was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate

extension:effectivePeriod

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod]]

R5: When the ValueSet is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod

extension:topic

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-topic]]

R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic

extension:author

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-author]]

R5: Who authored the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author

extension:editor

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-editor]]

R5: Who edited the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor

extension:reviewer

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-reviewer]]

R5: Who reviewed the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer

extension:endorser

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-endorser]]

R5: Who endorsed the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser

extension:relatedArtifact

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact]]

R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

extension:scope

0..1

(Complex)

R5: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.scope

?!

0..*

Extensions that cannot be ignored

url

Σ

0..1

Logical URI to reference this value set (globally unique)

Σ

0..*

Identifier

Additional identifier for the value set

Σ

0..1

Business version of the value set

Σ

0..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 a Value Set or Concept Map.

experimental

?!Σ

0..1

For testing purposes, not real usage

Σ

0..1

Date this was last changed

publisher

Σ

0..1

Name of the publisher (organization or individual)

contact

Σ

0..*

ContactDetail

Contact details for the publisher

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:contact

0..*

(Complex)

R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.contact

Σ

0..1

Name of an individual to contact

telecom

Σ

0..*

ContactPoint

Contact details for individual or organization

description

0..1

Natural language description of the value set

useContext

Σ

0..*

UsageContext

Context 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

extensible

Σ

0..1

Whether this is intended to be used with an extensible binding

compose

0..1

Definition of the content of the value set (CLD)

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

0..*

R5: Property to return if client doesn't override (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.property

?!Σ

0..*

Extensions that cannot be ignored

lockedDate

Σ

0..1

Fixed date for version-less references (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)
Constraints: vsd-2, vsd-3, vsd-1

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:copyright

0..1

R5: A copyright statement for the specific code system included in the value set (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.copyright

?!Σ

0..*

Extensions that cannot be ignored

Σ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

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

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

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:additionalUse

0..*

R5: Additional ways how this designation would be used (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.concept.designation.additionalUse

?!Σ

0..*

Extensions that cannot be ignored

0..1

Human language of the designation
Binding: Common Languages

(extensible): A human language.

Additional Bindings

Purpose

use

0..1

Details how this designation would be used
Binding: Designation Use (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

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

property

Σ

1..1

A property defined by the code system

op

Σ

1..1

(required): The kind of operation to perform as a part of a property based filter.

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:op

0..1

0..1

Primitive value for code

Σ

1..1

Code from the system, or regex criteria, or boolean value for exists

valueSet

ΣC

0..*

Select only contents included in this value set

exclude

0..*

See include (ValueSet)

Explicitly exclude codes from a code system or other value sets

expansion

0..1

Used when the value set is "expanded"

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:next

0..1

R5: Opaque urls for paging through expansion results (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.next

0..*

(Complex)

R5: Additional information supplied about each concept (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property

?!Σ

0..*

Extensions that cannot be ignored

1..1

Uniquely identifies this expansion

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

0..*

Parameter that controlled the expansion process

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:value

0..1

R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.parameter.value

?!Σ

0..*

Extensions that cannot be ignored

1..1

Name as assigned by the server

value[x]

0..1

Value of the named parameter

valueString

valueBoolean

valueInteger

valueDecimal

valueUri

valueCode

0..*

Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

0..*

(Complex)

R5: Property value for the concept (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property

?!Σ

0..*

Extensions that cannot be ignored

0..1

System value for the code

abstract

0..1

If user cannot select this entry

0..1

If concept is inactive in the code system

0..1

Version in which this code/display is defined

0..1

Code - if blank, this is not a selectable code

0..1

User display for the concept

Documentation for this format

0..*

See designation (ValueSet)

Additional representations for this item

contains

0..*

See contains (ValueSet)

Codes contained under this entry

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ValueSet.language	Base	extensible	Common Languages	📍3.0.2	tx.fhir.org
ValueSet.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.
ValueSet.jurisdiction	Base	extensible	Jurisdiction ValueSet	📍3.0.2	FHIR Std.
ValueSet.compose.include.concept.designation.language	Base	extensible	Common Languages	📍3.0.2	tx.fhir.org
ValueSet.compose.include.concept.designation.use	Base	extensible	Designation Use	📍3.0.2	FHIR Std.
ValueSet.compose.include.filter.op	Base	required	FilterOperator	📍3.0.2	tx.fhir.org

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain any narrative	`contained.text.empty()`
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	`contained.where(('#'+id in %resource.descendants().reference).not()).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()`
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() \| (children().count() > id.count())`
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-5	error	ValueSet	Value set SHALL contain at least one of a compose or an expansion element	`compose.exists() or expansion.exists()`
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 ValueSet

Summary

Extensions

This structure refers to these extensions:

Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-approvalDate (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-topic (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-author (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-editor (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-reviewer (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-endorser (no extension found)
Unable to summarise extension http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact (no extension found)
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.scope|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.contact|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.property|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.copyright|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.concept.designation.additionalUse|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.filter.op|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.next|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.parameter.value|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property|0.1.0

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ValueSet	C	0..*	ValueSet	A set of codes drawn from one or more code systems Constraints: vsd-5
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:versionAlgorithm		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]]	R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
extension:copyrightLabel		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]]	R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-approvalDate]]	R5: When the ValueSet was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
extension:lastReviewDate		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate]]	R5: When the ValueSet was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
extension:effectivePeriod		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod]]	R5: When the ValueSet is expected to be used (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
extension:topic		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-topic]]	R5: E.g. Education, Treatment, Assessment, etc (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
extension:author		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-author]]	R5: Who authored the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-editor]]	R5: Who edited the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-reviewer]]	R5: Who reviewed the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-endorser]]	R5: Who endorsed the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact]]	R5: Additional documentation, citations, etc (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
extension:scope		0..1	(Complex)	R5: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.scope
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
experimental	?!Σ	0..1	boolean	For testing purposes, not real usage
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ValueSet.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain any narrative	`contained.text.empty()`
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	`contained.where(('#'+id in %resource.descendants().reference).not()).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()`
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() \| (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
vsd-5	error	ValueSet	Value set SHALL contain at least one of a compose or an expansion element	`compose.exists() or expansion.exists()`

Differential View

This structure is derived from ValueSet

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ValueSet	0..*	ValueSet	A set of codes drawn from one or more code systems
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:versionAlgorithm	0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]]	R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
extension:copyrightLabel	0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]]	R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-approvalDate]]	R5: When the ValueSet was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
extension:lastReviewDate	0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate]]	R5: When the ValueSet was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
extension:effectivePeriod	0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod]]	R5: When the ValueSet is expected to be used (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
extension:topic	0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-topic]]	R5: E.g. Education, Treatment, Assessment, etc (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
extension:author	0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-author]]	R5: Who authored the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-editor]]	R5: Who edited the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-reviewer]]	R5: Who reviewed the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-endorser]]	R5: Who endorsed the ValueSet (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact]]	R5: Additional documentation, citations, etc (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
extension:scope	0..1	(Complex)	R5: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.scope
contact
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contact	0..*	(Complex)	R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.contact
compose
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:property	0..*	string	R5: Property to return if client doesn't override (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.property
include
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:copyright	0..1	string	R5: A copyright statement for the specific code system included in the value set (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.copyright
concept
designation
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:additionalUse	0..*	Coding	R5: Additional ways how this designation would be used (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.concept.designation.additionalUse
filter
op
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:op	0..1	code	R5: = \| is-a \| descendent-of \| is-not-a \| regex \| in \| not-in \| generalizes \| child-of \| descendent-leaf \| exists URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.filter.op Binding: R5FilterOperatorForR3 (0.1.0) (required): The kind of operation to perform as a part of a property based filter.
expansion
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:next	0..1	uri	R5: Opaque urls for paging through expansion results (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.next
extension:property	0..*	(Complex)	R5: Additional information supplied about each concept (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
parameter
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:value	0..1	dateTime	R5: value additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.parameter.value
contains
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:property	0..*	(Complex)	R5: Property value for the concept (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
Documentation for this format

Snapshot View

Description & Constraints Filter: Filters

0..*

A set of codes drawn from one or more code systems
Constraints: vsd-5

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: Common Languages

(extensible): A human language.

Additional Bindings

Purpose

text

0..1

Narrative

Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

contained

0..*

Resource

Contained, inline Resources

0..*

extension:versionAlgorithm

Extension
Slice: Unordered, Open by value:url

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]]

R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm

extension:copyrightLabel

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]]

R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel

extension:approvalDate

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-approvalDate]]

R5: When the ValueSet was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate

extension:lastReviewDate

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate]]

R5: When the ValueSet was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate

extension:effectivePeriod

0..1

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod]]

R5: When the ValueSet is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod

extension:topic

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-topic]]

R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic

extension:author

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-author]]

R5: Who authored the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author

extension:editor

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-editor]]

R5: Who edited the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor

extension:reviewer

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-reviewer]]

R5: Who reviewed the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer

extension:endorser

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-endorser]]

R5: Who endorsed the ValueSet (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser

extension:relatedArtifact

0..*

?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact]]

R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

extension:scope

0..1

(Complex)

R5: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.scope

?!

0..*

Extensions that cannot be ignored

url

Σ

0..1

Logical URI to reference this value set (globally unique)

Σ

0..*

Identifier

Additional identifier for the value set

Σ

0..1

Business version of the value set

Σ

0..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 a Value Set or Concept Map.

experimental

?!Σ

0..1

For testing purposes, not real usage

Σ

0..1

Date this was last changed

publisher

Σ

0..1

Name of the publisher (organization or individual)

contact

Σ

0..*

ContactDetail

Contact details for the publisher

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:contact

0..*

(Complex)

R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.contact

Σ

0..1

Name of an individual to contact

telecom

Σ

0..*

ContactPoint

Contact details for individual or organization

description

0..1

Natural language description of the value set

useContext

Σ

0..*

UsageContext

Context 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

extensible

Σ

0..1

Whether this is intended to be used with an extensible binding

compose

0..1

Definition of the content of the value set (CLD)

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

0..*

R5: Property to return if client doesn't override (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.property

?!Σ

0..*

Extensions that cannot be ignored

lockedDate

Σ

0..1

Fixed date for version-less references (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)
Constraints: vsd-2, vsd-3, vsd-1

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:copyright

0..1

R5: A copyright statement for the specific code system included in the value set (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.copyright

?!Σ

0..*

Extensions that cannot be ignored

Σ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

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

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

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:additionalUse

0..*

R5: Additional ways how this designation would be used (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.compose.include.concept.designation.additionalUse

?!Σ

0..*

Extensions that cannot be ignored

0..1

Human language of the designation
Binding: Common Languages

(extensible): A human language.

Additional Bindings

Purpose

use

0..1

Details how this designation would be used
Binding: Designation Use (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

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

property

Σ

1..1

A property defined by the code system

op

Σ

1..1

(required): The kind of operation to perform as a part of a property based filter.

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:op

0..1

0..1

Primitive value for code

Σ

1..1

Code from the system, or regex criteria, or boolean value for exists

valueSet

ΣC

0..*

Select only contents included in this value set

exclude

0..*

See include (ValueSet)

Explicitly exclude codes from a code system or other value sets

expansion

0..1

Used when the value set is "expanded"

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:next

0..1

R5: Opaque urls for paging through expansion results (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.next

0..*

(Complex)

R5: Additional information supplied about each concept (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property

?!Σ

0..*

Extensions that cannot be ignored

1..1

Uniquely identifies this expansion

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

0..*

Parameter that controlled the expansion process

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:value

0..1

R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.parameter.value

?!Σ

0..*

Extensions that cannot be ignored

1..1

Name as assigned by the server

value[x]

0..1

Value of the named parameter

valueString

valueBoolean

valueInteger

valueDecimal

valueUri

valueCode

0..*

Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

0..*

(Complex)

R5: Property value for the concept (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property

?!Σ

0..*

Extensions that cannot be ignored

0..1

System value for the code

abstract

0..1

If user cannot select this entry

0..1

If concept is inactive in the code system

0..1

Version in which this code/display is defined

0..1

Code - if blank, this is not a selectable code

0..1

User display for the concept