Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

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

Resource Profile: DataDictionaryCodeSystem

Profile of CodeSystem for Evidence Based Medicine IG. The DataDictionaryCodeSystem Profile is used for a code key for variable names in a dataset.

Usage:

• Examples for this Resource Profile: DataDictionary_for_phs003190 and DataDictionary_Measuring_the_Rate_of_Scientific_Knowledge_Transfer

Formal Views of Profile Content

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

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

This structure is derived from CodeSystem

Name	Flags	Card.	Type	Description & Constraints
CodeSystem		0..*	CodeSystem	Declares the existence of and describes a code system or code system supplement
url		1..1	uri	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
topic		0..0
Slices for property		0..*	BackboneElement	Additional information supplied about each concept Slice: Unordered, Open by value:code
property:datatype	S	0..1	BackboneElement	Additional information supplied about each concept
code		1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Datatype
type		1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Required Pattern: string
property:unitsOfMeasure	S	0..1	BackboneElement	Additional information supplied about each concept
code		1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Units
type		1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Required Pattern: string
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	C	0..*	CodeSystem	Declares the existence of and describes a code system or code system supplement cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided csd-4: If the code system content = supplement, it must nominate what it's a supplement for
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
url	ΣC	1..1	uri	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
hierarchyMeaning	ΣC	0..1	code	grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
content	ΣC	1..1	code	not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
Slices for property	Σ	0..*	BackboneElement	Additional information supplied about each concept Slice: Unordered, Open by value:code
property:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
property:datatype	SΣ	0..1	BackboneElement	Additional information supplied about each concept
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Datatype
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
property:unitsOfMeasure	SΣ	0..1	BackboneElement	Additional information supplied about each concept
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Units
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CodeSystem.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2 from the FHIR Standard
CodeSystem.hierarchyMeaning	required	CodeSystemHierarchyMeaning http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|6.0.0-ballot2 from the FHIR Standard
CodeSystem.content	required	CodeSystemContentMode http://hl7.org/fhir/ValueSet/codesystem-content-mode|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property.type	required	PropertyType http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:datatype.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:unitsOfMeasure.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cnl-0	warning	CodeSystem	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1	warning	CodeSystem.url	URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$')
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique : concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2	warning	CodeSystem	If there is an explicit hierarchy, a hierarchyMeaning should be provided : concept.concept.exists() implies hierarchyMeaning.exists()
csd-3	warning	CodeSystem	If there is an implicit hierarchy, a hierarchyMeaning should be provided : concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4	error	CodeSystem	If the code system content = supplement, it must nominate what it's a supplement for : CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	C	0..*	CodeSystem	Declares the existence of and describes a code system or code system supplement cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided csd-4: If the code system content = supplement, it must nominate what it's a supplement for
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
url	ΣC	1..1	uri	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
identifier	Σ	0..*	Identifier	Additional identifier for the code system (business identifier)
version	Σ	0..1	string	Business version of the code system (Coding.version)
versionAlgorithm[x]	Σ	0..1		How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString			string
versionAlgorithmCoding			Coding
name	ΣC	0..1	string	Name for this code system (computer friendly)
title	Σ	0..1	string	Name for this code system (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher/steward (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the code system
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for code system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this code system is defined
copyright		0..1	markdown	Use and/or publishing restrictions
copyrightLabel		0..1	string	Copyright holder and year(s)
approvalDate		0..1	date	When the CodeSystem was approved by publisher
lastReviewDate		0..1	date	When the CodeSystem was last reviewed by the publisher
effectivePeriod	Σ	0..1	Period	When the CodeSystem is expected to be used
author		0..*	ContactDetail	Who authored the CodeSystem
editor		0..*	ContactDetail	Who edited the CodeSystem
reviewer		0..*	ContactDetail	Who reviewed the CodeSystem
endorser		0..*	ContactDetail	Who endorsed the CodeSystem
relatedArtifact		0..*	RelatedArtifact	Additional documentation, citations, etc
caseSensitive	Σ	0..1	boolean	If code comparison is case sensitive
valueSet	Σ	0..1	canonical(ValueSet)	Canonical reference to the value set with entire code system
hierarchyMeaning	ΣC	0..1	code	grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
compositional	Σ	0..1	boolean	If code system defines a compositional grammar
versionNeeded	Σ	0..1	boolean	If definitions are not stable
content	ΣC	1..1	code	not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
supplements	ΣC	0..1	canonical(CodeSystem)	Canonical URL of Code System this adds designations and properties to
count	Σ	0..1	unsignedInt	Total concepts in the code system
filter	Σ	0..*	BackboneElement	Filter that can be used in a value set
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Code that identifies the filter
description	Σ	0..1	string	How or why the filter is used
operator	Σ	1..*	code	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value	Σ	1..1	string	What to use for the value
Slices for property	Σ	0..*	BackboneElement	Additional information supplied about each concept Slice: Unordered, Open by value:code
property:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations
uri	Σ	0..1	uri	Formal identifier for the property
description	Σ	0..1	string	Why the property is defined, and/or what it conveys
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
property:datatype	SΣ	0..1	BackboneElement	Additional information supplied about each 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
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Datatype
uri	Σ	0..1	uri	Formal identifier for the property
description	Σ	0..1	string	Why the property is defined, and/or what it conveys
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
property:unitsOfMeasure	SΣ	0..1	BackboneElement	Additional information supplied about each 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
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Units
uri	Σ	0..1	uri	Formal identifier for the property
description	Σ	0..1	string	Why the property is defined, and/or what it conveys
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
concept	C	0..*	BackboneElement	Concepts in the code 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	C	1..1	code	Code that identifies concept
display		0..1	string	Text to display to the user
definition		0..1	string	Formal definition
designation	C	0..*	BackboneElement	Additional representations for the concept csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse 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
language		0..1	code	Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
use	C	0..1	Coding	Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used.
additionalUse	C	0..*	Coding	Additional ways how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used.
value		1..1	string	The text value for this designation
property		0..*	BackboneElement	Property value for the 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
code	C	1..1	code	Reference to CodeSystem.property.code
value[x]		1..1		Value of the property for this concept
valueCode			code
valueCoding			Coding
valueString			string
valueInteger			integer
valueBoolean			boolean
valueDateTime			dateTime
valueDecimal			decimal
concept	C	0..*	See concept (CodeSystem)	Child Concepts (is-a/contains/categorizes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CodeSystem.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2 from the FHIR Standard
CodeSystem.versionAlgorithm[x]	extensible	VersionAlgorithm http://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard
CodeSystem.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2 from the FHIR Standard
CodeSystem.jurisdiction	extensible	JurisdictionValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
CodeSystem.hierarchyMeaning	required	CodeSystemHierarchyMeaning http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|6.0.0-ballot2 from the FHIR Standard
CodeSystem.content	required	CodeSystemContentMode http://hl7.org/fhir/ValueSet/codesystem-content-mode|6.0.0-ballot2 from the FHIR Standard
CodeSystem.filter.operator	required	FilterOperator http://hl7.org/fhir/ValueSet/filter-operator|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property.type	required	PropertyType http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:datatype.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:unitsOfMeasure.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.concept.designation.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2 from the FHIR Standard
CodeSystem.concept.designation.use	extensible	DesignationUse http://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard
CodeSystem.concept.designation.additionalUse	extensible	DesignationUse http://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cnl-0	warning	CodeSystem	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1	warning	CodeSystem.url	URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$')
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique : concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2	warning	CodeSystem	If there is an explicit hierarchy, a hierarchyMeaning should be provided : concept.concept.exists() implies hierarchyMeaning.exists()
csd-3	warning	CodeSystem	If there is an implicit hierarchy, a hierarchyMeaning should be provided : concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4	error	CodeSystem	If the code system content = supplement, it must nominate what it's a supplement for : CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
csd-5	error	CodeSystem.concept.designation	Must have a value for concept.designation.use if concept.designation.additionalUse is present : additionalUse.exists() implies use.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from CodeSystem

Summary

Mandatory: 1 element
Must-Support: 2 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CodeSystem.property

Maturity: 1

Differential View

This structure is derived from CodeSystem

Name	Flags	Card.	Type	Description & Constraints
CodeSystem		0..*	CodeSystem	Declares the existence of and describes a code system or code system supplement
url		1..1	uri	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
topic		0..0
Slices for property		0..*	BackboneElement	Additional information supplied about each concept Slice: Unordered, Open by value:code
property:datatype	S	0..1	BackboneElement	Additional information supplied about each concept
code		1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Datatype
type		1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Required Pattern: string
property:unitsOfMeasure	S	0..1	BackboneElement	Additional information supplied about each concept
code		1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Units
type		1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Required Pattern: string
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	C	0..*	CodeSystem	Declares the existence of and describes a code system or code system supplement cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided csd-4: If the code system content = supplement, it must nominate what it's a supplement for
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
url	ΣC	1..1	uri	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
hierarchyMeaning	ΣC	0..1	code	grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
content	ΣC	1..1	code	not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
Slices for property	Σ	0..*	BackboneElement	Additional information supplied about each concept Slice: Unordered, Open by value:code
property:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
property:datatype	SΣ	0..1	BackboneElement	Additional information supplied about each concept
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Datatype
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
property:unitsOfMeasure	SΣ	0..1	BackboneElement	Additional information supplied about each concept
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Units
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CodeSystem.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2 from the FHIR Standard
CodeSystem.hierarchyMeaning	required	CodeSystemHierarchyMeaning http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|6.0.0-ballot2 from the FHIR Standard
CodeSystem.content	required	CodeSystemContentMode http://hl7.org/fhir/ValueSet/codesystem-content-mode|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property.type	required	PropertyType http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:datatype.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:unitsOfMeasure.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cnl-0	warning	CodeSystem	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1	warning	CodeSystem.url	URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$')
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique : concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2	warning	CodeSystem	If there is an explicit hierarchy, a hierarchyMeaning should be provided : concept.concept.exists() implies hierarchyMeaning.exists()
csd-3	warning	CodeSystem	If there is an implicit hierarchy, a hierarchyMeaning should be provided : concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4	error	CodeSystem	If the code system content = supplement, it must nominate what it's a supplement for : CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	C	0..*	CodeSystem	Declares the existence of and describes a code system or code system supplement cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided csd-4: If the code system content = supplement, it must nominate what it's a supplement for
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
url	ΣC	1..1	uri	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
identifier	Σ	0..*	Identifier	Additional identifier for the code system (business identifier)
version	Σ	0..1	string	Business version of the code system (Coding.version)
versionAlgorithm[x]	Σ	0..1		How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString			string
versionAlgorithmCoding			Coding
name	ΣC	0..1	string	Name for this code system (computer friendly)
title	Σ	0..1	string	Name for this code system (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher/steward (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the code system
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for code system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this code system is defined
copyright		0..1	markdown	Use and/or publishing restrictions
copyrightLabel		0..1	string	Copyright holder and year(s)
approvalDate		0..1	date	When the CodeSystem was approved by publisher
lastReviewDate		0..1	date	When the CodeSystem was last reviewed by the publisher
effectivePeriod	Σ	0..1	Period	When the CodeSystem is expected to be used
author		0..*	ContactDetail	Who authored the CodeSystem
editor		0..*	ContactDetail	Who edited the CodeSystem
reviewer		0..*	ContactDetail	Who reviewed the CodeSystem
endorser		0..*	ContactDetail	Who endorsed the CodeSystem
relatedArtifact		0..*	RelatedArtifact	Additional documentation, citations, etc
caseSensitive	Σ	0..1	boolean	If code comparison is case sensitive
valueSet	Σ	0..1	canonical(ValueSet)	Canonical reference to the value set with entire code system
hierarchyMeaning	ΣC	0..1	code	grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
compositional	Σ	0..1	boolean	If code system defines a compositional grammar
versionNeeded	Σ	0..1	boolean	If definitions are not stable
content	ΣC	1..1	code	not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
supplements	ΣC	0..1	canonical(CodeSystem)	Canonical URL of Code System this adds designations and properties to
count	Σ	0..1	unsignedInt	Total concepts in the code system
filter	Σ	0..*	BackboneElement	Filter that can be used in a value set
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Code that identifies the filter
description	Σ	0..1	string	How or why the filter is used
operator	Σ	1..*	code	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value	Σ	1..1	string	What to use for the value
Slices for property	Σ	0..*	BackboneElement	Additional information supplied about each concept Slice: Unordered, Open by value:code
property:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations
uri	Σ	0..1	uri	Formal identifier for the property
description	Σ	0..1	string	Why the property is defined, and/or what it conveys
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
property:datatype	SΣ	0..1	BackboneElement	Additional information supplied about each 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
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Datatype
uri	Σ	0..1	uri	Formal identifier for the property
description	Σ	0..1	string	Why the property is defined, and/or what it conveys
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
property:unitsOfMeasure	SΣ	0..1	BackboneElement	Additional information supplied about each 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
code	Σ	1..1	code	Identifies the property on the concepts, and when referred to in operations Required Pattern: Units
uri	Σ	0..1	uri	Formal identifier for the property
description	Σ	0..1	string	Why the property is defined, and/or what it conveys
type	Σ	1..1	code	code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. Required Pattern: string
concept	C	0..*	BackboneElement	Concepts in the code 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	C	1..1	code	Code that identifies concept
display		0..1	string	Text to display to the user
definition		0..1	string	Formal definition
designation	C	0..*	BackboneElement	Additional representations for the concept csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse 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
language		0..1	code	Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
use	C	0..1	Coding	Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used.
additionalUse	C	0..*	Coding	Additional ways how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used.
value		1..1	string	The text value for this designation
property		0..*	BackboneElement	Property value for the 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
code	C	1..1	code	Reference to CodeSystem.property.code
value[x]		1..1		Value of the property for this concept
valueCode			code
valueCoding			Coding
valueString			string
valueInteger			integer
valueBoolean			boolean
valueDateTime			dateTime
valueDecimal			decimal
concept	C	0..*	See concept (CodeSystem)	Child Concepts (is-a/contains/categorizes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CodeSystem.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2 from the FHIR Standard
CodeSystem.versionAlgorithm[x]	extensible	VersionAlgorithm http://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard
CodeSystem.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2 from the FHIR Standard
CodeSystem.jurisdiction	extensible	JurisdictionValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
CodeSystem.hierarchyMeaning	required	CodeSystemHierarchyMeaning http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|6.0.0-ballot2 from the FHIR Standard
CodeSystem.content	required	CodeSystemContentMode http://hl7.org/fhir/ValueSet/codesystem-content-mode|6.0.0-ballot2 from the FHIR Standard
CodeSystem.filter.operator	required	FilterOperator http://hl7.org/fhir/ValueSet/filter-operator|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property.type	required	PropertyType http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:datatype.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.property:unitsOfMeasure.type	required	Pattern: string http://hl7.org/fhir/ValueSet/concept-property-type|6.0.0-ballot2 from the FHIR Standard
CodeSystem.concept.designation.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2 from the FHIR Standard
CodeSystem.concept.designation.use	extensible	DesignationUse http://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard
CodeSystem.concept.designation.additionalUse	extensible	DesignationUse http://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cnl-0	warning	CodeSystem	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1	warning	CodeSystem.url	URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$')
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique : concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2	warning	CodeSystem	If there is an explicit hierarchy, a hierarchyMeaning should be provided : concept.concept.exists() implies hierarchyMeaning.exists()
csd-3	warning	CodeSystem	If there is an implicit hierarchy, a hierarchyMeaning should be provided : concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4	error	CodeSystem	If the code system content = supplement, it must nominate what it's a supplement for : CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
csd-5	error	CodeSystem.concept.designation	Must have a value for concept.designation.use if concept.designation.additionalUse is present : additionalUse.exists() implies use.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from CodeSystem

Summary

Mandatory: 1 element
Must-Support: 2 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of CodeSystem.property

Maturity: 1

Other representations of profile: CSV, Excel, Schematron