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

C

0..*

A set of codes drawn from one or more code systems
Constraints: csd-1

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 CodeSystem 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 CodeSystem 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 CodeSystem 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 CodeSystem (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 CodeSystem (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 CodeSystem (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 CodeSystem (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:supplements

0..1

R5: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.supplements

?!

0..*

Extensions that cannot be ignored

url

Σ

0..1

Logical URI to reference this code system (globally unique) (Coding.system)

identifier

Σ

0..1

Identifier

Additional identifier for the code system

version

Σ

0..1

Business version of the code system (Coding.version)

Σ

0..1

Name for this code system (computer friendly)

title

Σ

0..1

Name for this code system (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

date

Σ

0..1

dateTime

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-CodeSystem.contact

Σ

0..1

Name of an individual to contact

telecom

Σ

0..*

ContactPoint

Contact details for individual or organization

0..1

Natural language description of the code system

useContext

Σ

0..*

UsageContext

Context the content is intended to support

jurisdiction

Σ

0..*

CodeableConcept

Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use

purpose

0..1

Why this code system is defined

copyright

0..1

Use and/or publishing restrictions

caseSensitive

Σ

0..1

If code comparison is case sensitive

valueSet

Σ

0..1

Canonical URL for value set with entire code system

hierarchyMeaning

Σ

0..1

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

If code system defines a post-composition grammar

versionNeeded

Σ

0..1

If definitions are not stable

content

Σ

1..1

not-present | example | fragment | complete
Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:content

0..1

R5: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.content
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.

0..1

Primitive value for code

count

Σ

0..1

unsignedInt

Total concepts in the code system

filter

Σ

0..*

Filter that can be used in a value set

id

0..1

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

Σ

1..1

Code that identifies the filter

Σ

0..1

How or why the filter is used

operator

Σ

1..*

Operators that can be used with filter
Binding: FilterOperator

(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:operator

0..*

0..1

Primitive value for code

Σ

1..1

What to use for the value

Σ

0..*

Additional information supplied about each concept

id

0..1

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

Σ

1..1

Identifies the property on the concepts, and when referred to in operations

uri

Σ

0..1

Formal identifier for the property

Σ

0..1

Why the property is defined, and/or what it conveys

type

Σ

1..1

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:type

0..1

0..1

Primitive value for code

concept

0..*

Concepts in the code 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 that identifies concept

display

0..1

Text to display to the user

0..1

Formal definition

0..*

Additional representations for the 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-CodeSystem.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

0..*

Property value for the concept

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:value

0..1

decimal

R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.property.value

?!Σ

0..*

Extensions that cannot be ignored

1..1

Documentation for this format

Reference to CodeSystem.property.code

value[x]

1..1

Value of the property for this concept

valueCode

valueCoding

valueString

valueInteger

valueBoolean

valueDateTime

0..*

See concept (CodeSystem)

Child Concepts (is-a/contains/categorizes)

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
CodeSystem.language	Base	extensible	Common Languages	📍3.0.2	tx.fhir.org
CodeSystem.status	Base	required	PublicationStatus	📍3.0.2	FHIR Std.
CodeSystem.jurisdiction	Base	extensible	Jurisdiction ValueSet	📍3.0.2	FHIR Std.
CodeSystem.hierarchyMeaning	Base	required	CodeSystemHierarchyMeaning	📍3.0.2	FHIR Std.
CodeSystem.content	Base	required	CodeSystemContentMode	📍3.0.2	FHIR Std.
CodeSystem.filter.operator	Base	required	FilterOperator	📍3.0.2	tx.fhir.org
CodeSystem.property.type	Base	required	PropertyType	📍3.0.2	FHIR Std.
CodeSystem.concept.designation.language	Base	extensible	Common Languages	📍3.0.2	tx.fhir.org
CodeSystem.concept.designation.use	Base	extensible	Designation Use	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique	`(concept.code \| descendants().concept.code).isDistinct()`
dom-1	error	CodeSystem	If the resource is contained in another resource, it SHALL NOT contain any narrative	`contained.text.empty()`
dom-2	error	CodeSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	CodeSystem	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	CodeSystem	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()`

This structure is derived from CodeSystem

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-CodeSystem.supplements|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.contact|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.content|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.filter.operator|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.property.type|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.designation.additionalUse|0.1.0
http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.property.value|0.1.0

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
CodeSystem	C	0..*	CodeSystem	A set of codes drawn from one or more code systems Constraints: csd-1
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 CodeSystem 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 CodeSystem 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 CodeSystem 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 CodeSystem (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 CodeSystem (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 CodeSystem (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 CodeSystem (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:supplements		0..1	uri	R5: Canonical URL of Code System this adds designations and properties to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.supplements
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
content	Σ	1..1	code	not-present \| example \| fragment \| complete Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:content		0..1	code	R5: not-present \| example \| fragment \| complete \| supplement URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.content 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.
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Description	Expression
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique	`(concept.code \| descendants().concept.code).isDistinct()`
dom-1	error	CodeSystem	If the resource is contained in another resource, it SHALL NOT contain any narrative	`contained.text.empty()`
dom-2	error	CodeSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	CodeSystem	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	CodeSystem	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()`

Differential View

This structure is derived from CodeSystem

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
CodeSystem	0..*	CodeSystem	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 CodeSystem 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 CodeSystem 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 CodeSystem 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 CodeSystem (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 CodeSystem (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 CodeSystem (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 CodeSystem (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:supplements	0..1	uri	R5: Canonical URL of Code System this adds designations and properties to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.supplements
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-CodeSystem.contact
content
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:content	0..1	code	R5: not-present \| example \| fragment \| complete \| supplement URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.content 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.
filter
operator
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:operator	0..*	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-CodeSystem.filter.operator Binding: R5FilterOperatorForR3 (0.1.0) (required): The kind of operation to perform as a part of a property based filter.
property
type
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	0..1	code	R5: code \| Coding \| string \| integer \| boolean \| dateTime \| decimal URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.property.type Binding: PropertyType (required): The type of a property value.
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-CodeSystem.concept.designation.additionalUse
property
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:value	0..1	decimal	R5: value additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.property.value
Documentation for this format

Snapshot View

Description & Constraints Filter: Filters

C

0..*

A set of codes drawn from one or more code systems
Constraints: csd-1

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 CodeSystem 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 CodeSystem 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 CodeSystem 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 CodeSystem (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 CodeSystem (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 CodeSystem (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 CodeSystem (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:supplements

0..1

R5: Canonical URL of Code System this adds designations and properties to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.supplements

?!

0..*

Extensions that cannot be ignored

url

Σ

0..1

Logical URI to reference this code system (globally unique) (Coding.system)

identifier

Σ

0..1

Identifier

Additional identifier for the code system

version

Σ

0..1

Business version of the code system (Coding.version)

Σ

0..1

Name for this code system (computer friendly)

title

Σ

0..1

Name for this code system (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

date

Σ

0..1

dateTime

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-CodeSystem.contact

Σ

0..1

Name of an individual to contact

telecom

Σ

0..*

ContactPoint

Contact details for individual or organization

0..1

Natural language description of the code system

useContext

Σ

0..*

UsageContext

Context the content is intended to support

jurisdiction

Σ

0..*

CodeableConcept

Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use

purpose

0..1

Why this code system is defined

copyright

0..1

Use and/or publishing restrictions

caseSensitive

Σ

0..1

If code comparison is case sensitive

valueSet

Σ

0..1

Canonical URL for value set with entire code system

hierarchyMeaning

Σ

0..1

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

If code system defines a post-composition grammar

versionNeeded

Σ

0..1

If definitions are not stable

content

Σ

1..1

not-present | example | fragment | complete
Binding: CodeSystemContentMode (required): How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:content

0..1

R5: not-present | example | fragment | complete | supplement
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.content
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.

0..1

Primitive value for code

count

Σ

0..1

unsignedInt

Total concepts in the code system

filter

Σ

0..*

Filter that can be used in a value set

id

0..1

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

Σ

1..1

Code that identifies the filter

Σ

0..1

How or why the filter is used

operator

Σ

1..*

Operators that can be used with filter
Binding: FilterOperator

(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:operator

0..*

0..1

Primitive value for code

Σ

1..1

What to use for the value

Σ

0..*

Additional information supplied about each concept

id

0..1

xml:id (or equivalent in JSON)

0..*

Additional Content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored

Σ

1..1

Identifies the property on the concepts, and when referred to in operations

uri

Σ

0..1

Formal identifier for the property

Σ

0..1

Why the property is defined, and/or what it conveys

type

Σ

1..1

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:type

0..1

0..1

Primitive value for code

concept

0..*

Concepts in the code 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 that identifies concept

display

0..1

Text to display to the user

0..1

Formal definition

0..*

Additional representations for the 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-CodeSystem.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

0..*

Property value for the concept

id

0..1

xml:id (or equivalent in JSON)

0..*

Extension
Slice: Unordered, Open by value:url

extension:value

0..1

decimal

R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.property.value

?!Σ

0..*

Extensions that cannot be ignored

1..1