Estonian Terminology Services Implementation Guide
1.0.0 - draft Estonia flag

Estonian Terminology Services Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/TerminologyServices/ and changes regularly. See the Directory of published versions

Resource Profile: TEHIK CodeSystem profile

Official URL: https://fhir.ee/StructureDefinition/tehikcodesystem Version: 1.0.0
Draft as of 2025-08-07 Computable Name: TehikCodeSystem

Profile for the basic code system in TEHIK terminology server. The code system may be contained in a value set if it has no independent meaning

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4, scs-1, scs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
.... extension:changeManagementDescription 0..1 markdown Description of change management: change requests, release cycles, etc
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:codingPrinciples 0..1 markdown Description of coding principles: structure of codes, hierarchy, etc.
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:otherTitle 0..* (Complex) Other human-readable title for the code system
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName profiled by https://fhir.ee/StructureDefinition/other-name-localized
... url SΣC 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the code system (e.g ISO OID)
Slice: Unordered, Open by pattern:system
.... identifier:oid Σ 0..1 Identifier ISO OID identifier represented as URN
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
... version SΣ 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Computer-friendly name/identifier to be used for machine-processing
... title SΣ 1..1 string Name of the code system, a human-readable well understood name
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 1..1 boolean For testing purposes, not real usage
... publisher SΣ 1..1 string The maintainer/publisher of the code system. For international code systems, the publisher might be the national release maintainer.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the code system
... useContext Σ 0..* UsageContext Usage context: health, social care, work
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
.... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
..... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
... purpose 0..1 markdown Overview of the purpose, content, and usage of the code system
... author 0..1 ContactDetail Owner of the code system. Organisation/group who is responsible for the content of the code system. For international code systems, the owner might be the national release owner.
.... name Σ 1..1 string Name of the organisation/group.
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
... hierarchyMeaning SΣ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 SΣ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.
... concept SC 0..* BackboneElement Concepts in the code system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SC 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.identifier:oid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
CodeSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
CodeSystem.useContext.codeextensibleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
CodeSystem.useContext.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.useContext.value[x]:valueCodeableConceptexampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|5.0.0
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCodeSystemName 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-1warningCodeSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2warningCodeSystemIf there is an explicit hierarchy, a hierarchyMeaning should be provided
: concept.concept.exists() implies hierarchyMeaning.exists()
csd-3warningCodeSystemIf there is an implicit hierarchy, a hierarchyMeaning should be provided
: concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4errorCodeSystemIf the code system content = supplement, it must nominate what it's a supplement for
: CodeSystem.content = 'supplement' implies CodeSystem.supplements.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()
scs-1errorCodeSystemIf a codesystem contains nested concepts, it must specify hierarchyMeaning
: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2errorCodeSystemIf a codesystem contains example, fragment, or complete content, it must have at least one concept
: content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()

This structure is derived from ShareableCodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
... Slices for extension Content/Rules for all slices
.... extension:changeManagementDescription 0..1 markdown Description of change management: change requests, release cycles, etc
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:codingPrinciples 0..1 markdown Description of coding principles: structure of codes, hierarchy, etc.
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:otherTitle 0..* (Complex) Other human-readable title for the code system
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName profiled by https://fhir.ee/StructureDefinition/other-name-localized
... url 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... Slices for identifier 0..* Identifier A non-FHIR identifier for the code system (e.g ISO OID)
Slice: Unordered, Open by pattern:system
.... identifier:oid 0..1 Identifier ISO OID identifier represented as URN
..... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
... title 1..1 string Name of the code system, a human-readable well understood name
... experimental 1..1 boolean For testing purposes, not real usage
... publisher 1..1 string The maintainer/publisher of the code system. For international code systems, the publisher might be the national release maintainer.
... contact 1..* ContactDetail Contact details for the publisher
... description 1..1 markdown Short description of the code system
... useContext 0..* UsageContext Usage context: health, social care, work
.... Slices for value[x] 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Open by type:$this
..... value[x]:valueCodeableConcept 1..1 CodeableConcept Value that defines the context
... purpose 0..1 markdown Overview of the purpose, content, and usage of the code system
... author 0..1 ContactDetail Owner of the code system. Organisation/group who is responsible for the content of the code system. For international code systems, the owner might be the national release owner.
.... name 1..1 string Name of the organisation/group.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4, scs-1, scs-2
... 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 BindingsPurpose
CommonLanguages Starter
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
.... extension:changeManagementDescription 0..1 markdown Description of change management: change requests, release cycles, etc
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:codingPrinciples 0..1 markdown Description of coding principles: structure of codes, hierarchy, etc.
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:otherTitle 0..* (Complex) Other human-readable title for the code system
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName profiled by https://fhir.ee/StructureDefinition/other-name-localized
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the code system (e.g ISO OID)
Slice: Unordered, Open by pattern:system
.... identifier:oid Σ 0..1 Identifier ISO OID identifier represented as URN
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version SΣ 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Computer-friendly name/identifier to be used for machine-processing
... title SΣ 1..1 string Name of the code system, a human-readable well understood name
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 1..1 string The maintainer/publisher of the code system. For international code systems, the publisher might be the national release maintainer.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the code system
... useContext Σ 0..* UsageContext Usage context: health, social care, work
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
.... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
..... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
... 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 Overview of the purpose, content, and usage of the code system
... 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
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..1 ContactDetail Owner of the code system. Organisation/group who is responsible for the content of the code system. For international code systems, the owner might be the national release owner.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ 1..1 string Name of the organisation/group.
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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 SΣ 1..1 boolean If code comparison is case sensitive
... valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
... hierarchyMeaning SΣ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 SΣ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
... 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 SC 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 SC 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... designation C 0..* BackboneElement Additional representations for the concept
Constraints: csd-5
..... 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 BindingsPurpose
CommonLanguages Starter
..... 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 SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
CodeSystem.identifier:oid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
CodeSystem.identifier:oid.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
CodeSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
CodeSystem.useContext.codeextensibleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
CodeSystem.useContext.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.useContext.value[x]:valueCodeableConceptexampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
CodeSystem.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
From the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|5.0.0
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|5.0.0
From the FHIR Standard
CodeSystem.filter.operatorrequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard
CodeSystem.property.typerequiredPropertyType
http://hl7.org/fhir/ValueSet/concept-property-type|5.0.0
From the FHIR Standard
CodeSystem.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
CodeSystem.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
CodeSystem.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCodeSystemName 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-1warningCodeSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2warningCodeSystemIf there is an explicit hierarchy, a hierarchyMeaning should be provided
: concept.concept.exists() implies hierarchyMeaning.exists()
csd-3warningCodeSystemIf there is an implicit hierarchy, a hierarchyMeaning should be provided
: concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4errorCodeSystemIf the code system content = supplement, it must nominate what it's a supplement for
: CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
csd-5errorCodeSystem.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.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()
scs-1errorCodeSystemIf a codesystem contains nested concepts, it must specify hierarchyMeaning
: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2errorCodeSystemIf a codesystem contains example, fragment, or complete content, it must have at least one concept
: content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()

This structure is derived from ShareableCodeSystem

Summary

Mandatory: 3 elements(3 nested mandatory elements)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CodeSystem.identifier
  • The element 1 is sliced based on the value of CodeSystem.useContext.value[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4, scs-1, scs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
.... extension:changeManagementDescription 0..1 markdown Description of change management: change requests, release cycles, etc
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:codingPrinciples 0..1 markdown Description of coding principles: structure of codes, hierarchy, etc.
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:otherTitle 0..* (Complex) Other human-readable title for the code system
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName profiled by https://fhir.ee/StructureDefinition/other-name-localized
... url SΣC 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the code system (e.g ISO OID)
Slice: Unordered, Open by pattern:system
.... identifier:oid Σ 0..1 Identifier ISO OID identifier represented as URN
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
... version SΣ 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Computer-friendly name/identifier to be used for machine-processing
... title SΣ 1..1 string Name of the code system, a human-readable well understood name
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 1..1 boolean For testing purposes, not real usage
... publisher SΣ 1..1 string The maintainer/publisher of the code system. For international code systems, the publisher might be the national release maintainer.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the code system
... useContext Σ 0..* UsageContext Usage context: health, social care, work
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
.... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
..... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
... purpose 0..1 markdown Overview of the purpose, content, and usage of the code system
... author 0..1 ContactDetail Owner of the code system. Organisation/group who is responsible for the content of the code system. For international code systems, the owner might be the national release owner.
.... name Σ 1..1 string Name of the organisation/group.
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
... hierarchyMeaning SΣ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 SΣ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.
... concept SC 0..* BackboneElement Concepts in the code system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SC 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.identifier:oid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
CodeSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
CodeSystem.useContext.codeextensibleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
CodeSystem.useContext.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.useContext.value[x]:valueCodeableConceptexampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|5.0.0
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCodeSystemName 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-1warningCodeSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2warningCodeSystemIf there is an explicit hierarchy, a hierarchyMeaning should be provided
: concept.concept.exists() implies hierarchyMeaning.exists()
csd-3warningCodeSystemIf there is an implicit hierarchy, a hierarchyMeaning should be provided
: concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4errorCodeSystemIf the code system content = supplement, it must nominate what it's a supplement for
: CodeSystem.content = 'supplement' implies CodeSystem.supplements.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()
scs-1errorCodeSystemIf a codesystem contains nested concepts, it must specify hierarchyMeaning
: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2errorCodeSystemIf a codesystem contains example, fragment, or complete content, it must have at least one concept
: content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()

Differential View

This structure is derived from ShareableCodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
... Slices for extension Content/Rules for all slices
.... extension:changeManagementDescription 0..1 markdown Description of change management: change requests, release cycles, etc
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:codingPrinciples 0..1 markdown Description of coding principles: structure of codes, hierarchy, etc.
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:otherTitle 0..* (Complex) Other human-readable title for the code system
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName profiled by https://fhir.ee/StructureDefinition/other-name-localized
... url 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... Slices for identifier 0..* Identifier A non-FHIR identifier for the code system (e.g ISO OID)
Slice: Unordered, Open by pattern:system
.... identifier:oid 0..1 Identifier ISO OID identifier represented as URN
..... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
... title 1..1 string Name of the code system, a human-readable well understood name
... experimental 1..1 boolean For testing purposes, not real usage
... publisher 1..1 string The maintainer/publisher of the code system. For international code systems, the publisher might be the national release maintainer.
... contact 1..* ContactDetail Contact details for the publisher
... description 1..1 markdown Short description of the code system
... useContext 0..* UsageContext Usage context: health, social care, work
.... Slices for value[x] 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Open by type:$this
..... value[x]:valueCodeableConcept 1..1 CodeableConcept Value that defines the context
... purpose 0..1 markdown Overview of the purpose, content, and usage of the code system
... author 0..1 ContactDetail Owner of the code system. Organisation/group who is responsible for the content of the code system. For international code systems, the owner might be the national release owner.
.... name 1..1 string Name of the organisation/group.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: cnl-0, csd-1, csd-2, csd-3, csd-4, scs-1, scs-2
... 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 BindingsPurpose
CommonLanguages Starter
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
.... extension:changeManagementDescription 0..1 markdown Description of change management: change requests, release cycles, etc
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:codingPrinciples 0..1 markdown Description of coding principles: structure of codes, hierarchy, etc.
URL: https://fhir.ee/StructureDefinition/guidance-material
.... extension:otherTitle 0..* (Complex) Other human-readable title for the code system
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName profiled by https://fhir.ee/StructureDefinition/other-name-localized
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the code system (e.g ISO OID)
Slice: Unordered, Open by pattern:system
.... identifier:oid Σ 0..1 Identifier ISO OID identifier represented as URN
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version SΣ 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Computer-friendly name/identifier to be used for machine-processing
... title SΣ 1..1 string Name of the code system, a human-readable well understood name
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 1..1 string The maintainer/publisher of the code system. For international code systems, the publisher might be the national release maintainer.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the code system
... useContext Σ 0..* UsageContext Usage context: health, social care, work
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
.... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
..... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
... 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 Overview of the purpose, content, and usage of the code system
... 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
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..1 ContactDetail Owner of the code system. Organisation/group who is responsible for the content of the code system. For international code systems, the owner might be the national release owner.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ 1..1 string Name of the organisation/group.
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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 SΣ 1..1 boolean If code comparison is case sensitive
... valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
... hierarchyMeaning SΣ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 SΣ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
... 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 SC 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 SC 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... designation C 0..* BackboneElement Additional representations for the concept
Constraints: csd-5
..... 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 BindingsPurpose
CommonLanguages Starter
..... 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 SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
CodeSystem.identifier:oid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
CodeSystem.identifier:oid.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
CodeSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
CodeSystem.useContext.codeextensibleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
CodeSystem.useContext.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.useContext.value[x]:valueCodeableConceptexampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
CodeSystem.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
CodeSystem.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
From the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|5.0.0
From the FHIR Standard
CodeSystem.contentrequiredCodeSystemContentMode
http://hl7.org/fhir/ValueSet/codesystem-content-mode|5.0.0
From the FHIR Standard
CodeSystem.filter.operatorrequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard
CodeSystem.property.typerequiredPropertyType
http://hl7.org/fhir/ValueSet/concept-property-type|5.0.0
From the FHIR Standard
CodeSystem.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
CodeSystem.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
CodeSystem.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCodeSystemName 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-1warningCodeSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2warningCodeSystemIf there is an explicit hierarchy, a hierarchyMeaning should be provided
: concept.concept.exists() implies hierarchyMeaning.exists()
csd-3warningCodeSystemIf there is an implicit hierarchy, a hierarchyMeaning should be provided
: concept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4errorCodeSystemIf the code system content = supplement, it must nominate what it's a supplement for
: CodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
csd-5errorCodeSystem.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.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()
scs-1errorCodeSystemIf a codesystem contains nested concepts, it must specify hierarchyMeaning
: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2errorCodeSystemIf a codesystem contains example, fragment, or complete content, it must have at least one concept
: content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()

This structure is derived from ShareableCodeSystem

Summary

Mandatory: 3 elements(3 nested mandatory elements)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CodeSystem.identifier
  • The element 1 is sliced based on the value of CodeSystem.useContext.value[x]

 

Other representations of profile: CSV, Excel, Schematron