Data Sharing Framework (DSF) Implementation Guide
2.0.0 - ci-build

Data Sharing Framework (DSF) Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: CodeSystem

Official URL: http://dsf.dev/fhir/StructureDefinition/code-system Version: 1.0.0
Active as of 2023-06-28 Computable Name: CodeSystem

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... content Σ 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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
... version 1..1 string Business version of the code system (Coding.version)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version Σ 1..1 string Business version of the code system (Coding.version)
... 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 (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: Jurisdiction ValueSet (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
... 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 Σ 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 Σ 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 Σ 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 | 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
... property Σ 0..* 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
.... 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.
... concept 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 1..1 code Code that identifies concept
.... display 0..1 string Text to display to the user
.... definition 0..1 string Formal definition
.... designation 0..* BackboneElement Additional representations 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
..... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... use 0..1 Coding Details 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 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 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
From the FHIR Standard
CodeSystem.filter.operatorrequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard
CodeSystem.property.typerequiredPropertyType
http://hl7.org/fhir/ValueSet/concept-property-type|4.0.1
From the FHIR Standard
CodeSystem.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CodeSystem

Summary

Mandatory: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... content Σ 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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
... version 1..1 string Business version of the code system (Coding.version)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1
... 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version Σ 1..1 string Business version of the code system (Coding.version)
... 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 (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: Jurisdiction ValueSet (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
... 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 Σ 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 Σ 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 Σ 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 | 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
... property Σ 0..* 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
.... 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.
... concept 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 1..1 code Code that identifies concept
.... display 0..1 string Text to display to the user
.... definition 0..1 string Formal definition
.... designation 0..* BackboneElement Additional representations 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
..... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... use 0..1 Coding Details 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 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 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
From the FHIR Standard
CodeSystem.filter.operatorrequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard
CodeSystem.property.typerequiredPropertyType
http://hl7.org/fhir/ValueSet/concept-property-type|4.0.1
From the FHIR Standard
CodeSystem.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CodeSystem

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel, Schematron