HL7 Terminology (THO)
6.1.0 - Continuous Process Integration (ci build) International flag

HL7 Terminology (THO) - Local Development build (v6.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Publishable CodeSystem

Official URL: http://terminology.hl7.org/StructureDefinition/publishablecodesystem Version: 1.0.0
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: PublishableCodeSystem

Defines and enforces the minimum expectations for publication and distribution of a code system, typically as part of an artifact repository or implementation guide publication

Usage:

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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided
csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided
csd-4: If the code system content = supplement, it must nominate what it's a supplement for
scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning
scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... otherName 0..* (Complex) Alternative names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url SΣC 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 0..* Identifier Additional identifier for the code system (business identifier)
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the code system (Coding.version)
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 0..1 string Name for this code system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Name for this code system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact SΣ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the code system
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose S 0..1 markdown Why this code system is defined
ele-1: All FHIR elements must have a @value or children
... copyright S 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel S 0..1 string Copyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the CodeSystem was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1 date When the CodeSystem was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod SΣ 0..1 Period When the CodeSystem is expected to be used
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
ele-1: All FHIR elements must have a @value or children
... author 0..* ContactDetail Who authored the CodeSystem
ele-1: All FHIR elements must have a @value or children
... editor 0..* ContactDetail Who edited the CodeSystem
ele-1: All FHIR elements must have a @value or children
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
ele-1: All FHIR elements must have a @value or children
... endorser 0..* ContactDetail Who endorsed the CodeSystem
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
ele-1: All FHIR elements must have a @value or children
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... concept SC 0..* BackboneElement Concepts in the code system
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code SC 1..1 code Code that identifies concept
ele-1: All FHIR elements must have a @value or children
.... display S 0..1 string Text to display to the user
ele-1: All FHIR elements must have a @value or children
.... definition S 0..1 string Formal definition
ele-1: All FHIR elements must have a @value or children
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.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

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 & Constraintsdoco
.. 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
.... sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
.... otherName 0..* (Complex) Alternative names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
... identifier S 0..* Identifier Additional identifier for the code system (business identifier)
... date S 1..1 dateTime Date last changed
... useContext S 0..* UsageContext The context that the content is intended to support
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
... purpose S 0..1 markdown Why this code system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 S 0..1 Period When the CodeSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the CodeSystem
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
... endorser 0..* ContactDetail Who endorsed the CodeSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided
csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided
csd-4: If the code system content = supplement, it must nominate what it's a supplement for
scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning
scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept
... 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 Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
.... sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
.... otherName 0..* (Complex) Alternative names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
... 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)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier SΣ 0..* Identifier Additional identifier for the code system (business identifier)
... 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 0..1 string Name for this code system (computer friendly)
... title SΣ 1..1 string Name for this code system (human friendly)
... 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 SΣ 1..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the code system
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 0..1 markdown Why this code system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 SΣ 0..1 Period When the CodeSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the CodeSystem
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
... endorser 0..* ContactDetail Who endorsed the CodeSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... caseSensitive 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
csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse is present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 0..1 code Human language of the designation
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
..... use C 0..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... additionalUse C 0..* Coding Additional ways how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.


..... value 1..1 string The text value for this designation
.... property 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code C 1..1 code Reference to CodeSystem.property.code
..... value[x] 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.languagerequiredAllLanguages (a valid code from Tags for the Identification of Languages)
http://hl7.org/fhir/ValueSet/all-languages|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.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 (a valid code from Tags for the Identification of Languages)
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: 1 element
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided
csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided
csd-4: If the code system content = supplement, it must nominate what it's a supplement for
scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning
scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... otherName 0..* (Complex) Alternative names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url SΣC 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 0..* Identifier Additional identifier for the code system (business identifier)
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the code system (Coding.version)
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 0..1 string Name for this code system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Name for this code system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact SΣ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the code system
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose S 0..1 markdown Why this code system is defined
ele-1: All FHIR elements must have a @value or children
... copyright S 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel S 0..1 string Copyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the CodeSystem was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1 date When the CodeSystem was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod SΣ 0..1 Period When the CodeSystem is expected to be used
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
ele-1: All FHIR elements must have a @value or children
... author 0..* ContactDetail Who authored the CodeSystem
ele-1: All FHIR elements must have a @value or children
... editor 0..* ContactDetail Who edited the CodeSystem
ele-1: All FHIR elements must have a @value or children
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
ele-1: All FHIR elements must have a @value or children
... endorser 0..* ContactDetail Who endorsed the CodeSystem
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
ele-1: All FHIR elements must have a @value or children
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... concept SC 0..* BackboneElement Concepts in the code system
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code SC 1..1 code Code that identifies concept
ele-1: All FHIR elements must have a @value or children
.... display S 0..1 string Text to display to the user
ele-1: All FHIR elements must have a @value or children
.... definition S 0..1 string Formal definition
ele-1: All FHIR elements must have a @value or children
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.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

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 & Constraintsdoco
.. 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
.... sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
.... otherName 0..* (Complex) Alternative names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
... identifier S 0..* Identifier Additional identifier for the code system (business identifier)
... date S 1..1 dateTime Date last changed
... useContext S 0..* UsageContext The context that the content is intended to support
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
... purpose S 0..1 markdown Why this code system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 S 0..1 Period When the CodeSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the CodeSystem
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
... endorser 0..* ContactDetail Who endorsed the CodeSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 ShareableCodeSystem Declares the existence of and describes a code system or code system supplement
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided
csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided
csd-4: If the code system content = supplement, it must nominate what it's a supplement for
scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning
scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept
... 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 Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
.... sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
.... otherName 0..* (Complex) Alternative names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
... 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)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier SΣ 0..* Identifier Additional identifier for the code system (business identifier)
... 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 0..1 string Name for this code system (computer friendly)
... title SΣ 1..1 string Name for this code system (human friendly)
... 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 SΣ 1..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the code system
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 0..1 markdown Why this code system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 SΣ 0..1 Period When the CodeSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the CodeSystem
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
... endorser 0..* ContactDetail Who endorsed the CodeSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... caseSensitive 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
csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse is present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 0..1 code Human language of the designation
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
..... use C 0..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... additionalUse C 0..* Coding Additional ways how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.


..... value 1..1 string The text value for this designation
.... property 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code C 1..1 code Reference to CodeSystem.property.code
..... value[x] 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept SC 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CodeSystem.languagerequiredAllLanguages (a valid code from Tags for the Identification of Languages)
http://hl7.org/fhir/ValueSet/all-languages|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.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 (a valid code from Tags for the Identification of Languages)
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: 1 element
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron