OCL Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: OCL ValueSet Profile

A profile for ValueSet resources as defined by Open Concept Lab terminology services.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children
identifier	SΣ	0..*	Identifier	Additional identifier for the value set (business identifier) ele-1: All FHIR elements must have a @value or children
version	SΣ	1..1	string	Business version of the value set ele-1: All FHIR elements must have a @value or children
name	SΣ	1..1	string	Name for this value set (computer friendly) ele-1: All FHIR elements must have a @value or children
title	SΣ	1..1	string	Name for this value set (human friendly) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required) ele-1: All FHIR elements must have a @value or children
publisher	SΣ	0..1	string	Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children
compose	S	0..1	BackboneElement	Content logical definition of the value set (CLD) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
include	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	1..1	uri	The system the codes come from ele-1: All FHIR elements must have a @value or children
concept	C	0..*	BackboneElement	A concept defined in the system ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	code	Code or expression from system ele-1: All FHIR elements must have a @value or children
expansion	S	0..1	BackboneElement	Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
timestamp	S	1..1	dateTime	Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children
contains	C	0..*	BackboneElement	Codes in the value set ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	S	1..1	uri	System value for the code ele-1: All FHIR elements must have a @value or children
code	SC	1..1	code	Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ValueSet.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard

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.exists() and ('#'+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(uri) = '#').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())
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.exists() implies name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
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 ValueSet

Name	Flags	Card.	Type	Description & Constraints
ValueSet		0..*	ValueSet	A set of codes drawn from one or more code systems
url	S	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
identifier	S	0..*	Identifier	Additional identifier for the value set (business identifier)
version	S	1..1	string	Business version of the value set
name	S	1..1	string	Name for this value set (computer friendly)
title	S	1..1	string	Name for this value set (human friendly)
status	S	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
publisher	S	0..1	string	Name of the publisher (organization or individual)
compose	S	0..1	BackboneElement	Content logical definition of the value set (CLD)
include	S	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
system	S	1..1	uri	The system the codes come from
concept
code	S	1..1	code	Code or expression from system
expansion	S	0..1	BackboneElement	Used when the value set is "expanded"
timestamp	S	1..1	dateTime	Time ValueSet expansion happened
contains
system	S	1..1	uri	System value for the code
code	S	1..1	code	Code - if blank, this is not a selectable code
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ValueSet.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	A set of codes drawn from one or more code systems vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
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): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the value set (business identifier)
version	SΣ	1..1	string	Business version of the value set
name	SΣ	1..1	string	Name for this value set (computer friendly)
title	SΣ	1..1	string	Name for this value set (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the value set
useContext	Σ	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	S	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	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
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	SΣC	1..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	S	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): IETF language tag 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	S	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	S	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 vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
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	S	1..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	SC	1..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	URI
ValueSet.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ValueSet.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ValueSet.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
ValueSet.compose.include.concept.designation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use	extensible	DesignationUse http://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard
ValueSet.compose.include.filter.op	required	FilterOperator http://hl7.org/fhir/ValueSet/filter-operator|4.3.0 from the FHIR Standard

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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	ValueSet.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
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.exists() implies name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
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 ValueSet

Summary

Mandatory: 4 elements(3 nested mandatory elements)
Must-Support: 15 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children
identifier	SΣ	0..*	Identifier	Additional identifier for the value set (business identifier) ele-1: All FHIR elements must have a @value or children
version	SΣ	1..1	string	Business version of the value set ele-1: All FHIR elements must have a @value or children
name	SΣ	1..1	string	Name for this value set (computer friendly) ele-1: All FHIR elements must have a @value or children
title	SΣ	1..1	string	Name for this value set (human friendly) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required) ele-1: All FHIR elements must have a @value or children
publisher	SΣ	0..1	string	Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children
compose	S	0..1	BackboneElement	Content logical definition of the value set (CLD) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
include	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	1..1	uri	The system the codes come from ele-1: All FHIR elements must have a @value or children
concept	C	0..*	BackboneElement	A concept defined in the system ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	code	Code or expression from system ele-1: All FHIR elements must have a @value or children
expansion	S	0..1	BackboneElement	Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
timestamp	S	1..1	dateTime	Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children
contains	C	0..*	BackboneElement	Codes in the value set ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	S	1..1	uri	System value for the code ele-1: All FHIR elements must have a @value or children
code	SC	1..1	code	Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ValueSet.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard

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.exists() and ('#'+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(uri) = '#').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())
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.exists() implies name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
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()

Differential View

This structure is derived from ValueSet

Name	Flags	Card.	Type	Description & Constraints
ValueSet		0..*	ValueSet	A set of codes drawn from one or more code systems
url	S	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
identifier	S	0..*	Identifier	Additional identifier for the value set (business identifier)
version	S	1..1	string	Business version of the value set
name	S	1..1	string	Name for this value set (computer friendly)
title	S	1..1	string	Name for this value set (human friendly)
status	S	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
publisher	S	0..1	string	Name of the publisher (organization or individual)
compose	S	0..1	BackboneElement	Content logical definition of the value set (CLD)
include	S	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
system	S	1..1	uri	The system the codes come from
concept
code	S	1..1	code	Code or expression from system
expansion	S	0..1	BackboneElement	Used when the value set is "expanded"
timestamp	S	1..1	dateTime	Time ValueSet expansion happened
contains
system	S	1..1	uri	System value for the code
code	S	1..1	code	Code - if blank, this is not a selectable code
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ValueSet.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	A set of codes drawn from one or more code systems vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
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): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the value set (business identifier)
version	SΣ	1..1	string	Business version of the value set
name	SΣ	1..1	string	Name for this value set (computer friendly)
title	SΣ	1..1	string	Name for this value set (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the value set
useContext	Σ	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	S	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	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter
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	SΣC	1..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	S	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): IETF language tag 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	S	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	S	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 vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present
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	S	1..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	SC	1..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	URI
ValueSet.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ValueSet.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ValueSet.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
ValueSet.compose.include.concept.designation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use	extensible	DesignationUse http://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard
ValueSet.compose.include.filter.op	required	FilterOperator http://hl7.org/fhir/ValueSet/filter-operator|4.3.0 from the FHIR Standard

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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	ValueSet.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
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.exists() implies name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
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 ValueSet

Summary

Mandatory: 4 elements(3 nested mandatory elements)
Must-Support: 15 elements

Other representations of profile: CSV, Excel, Schematron