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 ValueSet profile

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

Profile for the basic value set in TEHIK terminology server. Includes metadata conventions for the value set and its elements.

Usages:

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

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
.. ValueSet C 1..1 ShareableValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource A value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
... Slices for extension 0..* Extension Description of change management: periodicity, change request workflow, release dates, responsibilities, etc
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:authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
.... extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
.... extension:changeManagementDescription 0..1 markdown Extension
URL: https://fhir.ee/StructureDefinition/guidance-material
... url SΣC 1..1 uri this is the default formula for uri
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the value set (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 value set
... 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 value set, a human-readable well understood name. English name can be provided in the translation element.
... 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 original maintainer/publisher of the value set.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the value set
... 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 value set
... author 0..1 ContactDetail Owner of the value set. Organisation/group who is responsible for the content of the value set.
.... name Σ 1..1 string Name of the organisation/group.

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName 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-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 ShareableValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 1..1 ShareableValueSet A set of codes drawn from one or more code systems
... contained 0..* Resource A value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
... extension 0..* Extension Description of change management: periodicity, change request workflow, release dates, responsibilities, etc
... Slices for extension Content/Rules for all slices
.... extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
.... extension:changeManagementDescription 0..1 markdown Extension
URL: https://fhir.ee/StructureDefinition/guidance-material
... Slices for identifier 0..* Identifier A non-FHIR identifier for the value set (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
... name 1..1 string Computer-friendly name/identifier to be used for machine-processing
... title 1..1 string Name of the value set, a human-readable well understood name. English name can be provided in the translation element.
... experimental 1..1 boolean For testing purposes, not real usage
... publisher 1..1 string The original maintainer/publisher of the value set.
... contact 1..* ContactDetail Contact details for the publisher
... description 1..1 markdown Short description of the value set
... 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
... jurisdiction 0..0
... purpose 0..1 markdown Overview of the purpose, content, and usage of the value set
... topic 0..0
... author 0..1 ContactDetail Owner of the value set. Organisation/group who is responsible for the content of the value set.
.... name 1..1 string Name of the organisation/group.
... compose
.... property 0..* string Property to return if client doesn't override

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 1..1 ShareableValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... 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 A value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
... Slices for extension 0..* Extension Description of change management: periodicity, change request workflow, release dates, responsibilities, etc
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:authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
.... extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
.... extension:changeManagementDescription 0..1 markdown Extension
URL: https://fhir.ee/StructureDefinition/guidance-material
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri this is the default formula for uri
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the value set (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 value set
... 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 value set, a human-readable well understood name. English name can be provided in the translation element.
... 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 original maintainer/publisher of the value set.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the value set
... 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.
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Overview of the purpose, content, and usage of the value set
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the ValueSet was approved by publisher
... lastReviewDate 0..1 date When the ValueSet was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ValueSet is expected to be used
... author 0..1 ContactDetail Owner of the value set. Organisation/group who is responsible for the content of the value set.
.... 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 ValueSet
... reviewer 0..* ContactDetail Who reviewed the ValueSet
... endorser 0..* ContactDetail Who endorsed the ValueSet
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation C 0..* BackboneElement Additional representations for this concept
Constraints: vsd-11
....... 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 Types of uses of designations
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
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | 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 Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
..... copyright 0..1 string A copyright statement for the specific code system included in the value set
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
.... property 0..* string Property to return if client doesn't override
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... next 0..1 uri Opaque urls for paging through expansion results
.... timestamp 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... 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
.... contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system C 0..1 uri System value for the code
..... abstract C 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... 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 ValueSet.expansion.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
...... subProperty 0..* BackboneElement SubProperty 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 ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
... scope 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... 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
.... inclusionCriteria 0..1 string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1 string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.identifier:oid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
ValueSet.identifier:oid.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ValueSet.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
ValueSet.useContext.codeextensibleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
ValueSet.useContext.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ValueSet.useContext.value[x]:valueCodeableConceptexampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName 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-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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()
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsSHALL have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsSHALL have a system if a code is present
: code.empty() or system.exists()
vsd-11errorValueSet.compose.include.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.exists()

This structure is derived from ShareableValueSet

Summary

Mandatory: 3 elements(3 nested mandatory elements)
Prohibited: 2 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 ValueSet.identifier
  • The element 1 is sliced based on the value of ValueSet.useContext.value[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 1..1 ShareableValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource A value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
... Slices for extension 0..* Extension Description of change management: periodicity, change request workflow, release dates, responsibilities, etc
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:authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
.... extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
.... extension:changeManagementDescription 0..1 markdown Extension
URL: https://fhir.ee/StructureDefinition/guidance-material
... url SΣC 1..1 uri this is the default formula for uri
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the value set (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 value set
... 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 value set, a human-readable well understood name. English name can be provided in the translation element.
... 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 original maintainer/publisher of the value set.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the value set
... 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 value set
... author 0..1 ContactDetail Owner of the value set. Organisation/group who is responsible for the content of the value set.
.... name Σ 1..1 string Name of the organisation/group.

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName 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-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 ShareableValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 1..1 ShareableValueSet A set of codes drawn from one or more code systems
... contained 0..* Resource A value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
... extension 0..* Extension Description of change management: periodicity, change request workflow, release dates, responsibilities, etc
... Slices for extension Content/Rules for all slices
.... extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
.... extension:changeManagementDescription 0..1 markdown Extension
URL: https://fhir.ee/StructureDefinition/guidance-material
... Slices for identifier 0..* Identifier A non-FHIR identifier for the value set (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
... name 1..1 string Computer-friendly name/identifier to be used for machine-processing
... title 1..1 string Name of the value set, a human-readable well understood name. English name can be provided in the translation element.
... experimental 1..1 boolean For testing purposes, not real usage
... publisher 1..1 string The original maintainer/publisher of the value set.
... contact 1..* ContactDetail Contact details for the publisher
... description 1..1 markdown Short description of the value set
... 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
... jurisdiction 0..0
... purpose 0..1 markdown Overview of the purpose, content, and usage of the value set
... topic 0..0
... author 0..1 ContactDetail Owner of the value set. Organisation/group who is responsible for the content of the value set.
.... name 1..1 string Name of the organisation/group.
... compose
.... property 0..* string Property to return if client doesn't override

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 1..1 ShareableValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... 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 A value set can contain codesystem supplement if the code system does not have a meaningful use outside this value set.
... Slices for extension 0..* Extension Description of change management: periodicity, change request workflow, release dates, responsibilities, etc
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:authoritativeSource S 0..1 uri Reference to the current trusted source of the ValueSet resource (metadata and definition)
URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
.... extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
.... extension:changeManagementDescription 0..1 markdown Extension
URL: https://fhir.ee/StructureDefinition/guidance-material
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri this is the default formula for uri
Constraints: cnl-1
... Slices for identifier Σ 0..* Identifier A non-FHIR identifier for the value set (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 value set
... 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 value set, a human-readable well understood name. English name can be provided in the translation element.
... 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 original maintainer/publisher of the value set.
... contact Σ 1..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Short description of the value set
... 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.
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Overview of the purpose, content, and usage of the value set
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the ValueSet was approved by publisher
... lastReviewDate 0..1 date When the ValueSet was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ValueSet is expected to be used
... author 0..1 ContactDetail Owner of the value set. Organisation/group who is responsible for the content of the value set.
.... 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 ValueSet
... reviewer 0..* ContactDetail Who reviewed the ValueSet
... endorser 0..* ContactDetail Who endorsed the ValueSet
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation C 0..* BackboneElement Additional representations for this concept
Constraints: vsd-11
....... 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 Types of uses of designations
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
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | 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 Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
..... copyright 0..1 string A copyright statement for the specific code system included in the value set
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
.... property 0..* string Property to return if client doesn't override
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... next 0..1 uri Opaque urls for paging through expansion results
.... timestamp 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... 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
.... contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system C 0..1 uri System value for the code
..... abstract C 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... 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 ValueSet.expansion.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
...... subProperty 0..* BackboneElement SubProperty 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 ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
... scope 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... 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
.... inclusionCriteria 0..1 string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1 string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.identifier:oid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
ValueSet.identifier:oid.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ValueSet.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
ValueSet.useContext.codeextensibleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
ValueSet.useContext.value[x]exampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ValueSet.useContext.value[x]:valueCodeableConceptexampleContextOfUseValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName 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-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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()
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsSHALL have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsSHALL have a system if a code is present
: code.empty() or system.exists()
vsd-11errorValueSet.compose.include.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.exists()

This structure is derived from ShareableValueSet

Summary

Mandatory: 3 elements(3 nested mandatory elements)
Prohibited: 2 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 ValueSet.identifier
  • The element 1 is sliced based on the value of ValueSet.useContext.value[x]

 

Other representations of profile: CSV, Excel, Schematron