Structured Data Capture
4.0.0 - STU 4 International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Resource Profile: SDC Code System

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem Version: 4.0.0
Standards status: Trial-use Maturity Level: 4 Computable Name: SDCCodeSystem
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.6

Defines how CodeSystem is used to reflect code lists found in data element defintions and form definitions.

Scope and Usage

Code systems are referenced by ValueSets to define possible answer choices in a re-useable cross-questionnaire (and other data structure) manner. Codes might be drawn from standard international terminologies like LOINC or SNOMED CT or from regional code systems for drugs, billing codes, etc. The use of standardized codes is useful when data needs to be populated into the questionnaire or extracted from the questionnaire for other uses. It is also helpful when the set of possibilities is highly dynamic - for example drug codes where the set of available codes might change daily or weekly.

This profile sets expectations for use of the CodeSystem resource when used as a source for answers to questions in a Questionnaire. It identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the Questionnaire use-case.

For systems where discovery of CodeSystem is important, implementers are encouraged to also comply with the CRMI Shareable CodeSystem profile.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, sdc-2, sdc-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... version SΣ 0..1 string Business version of the code system (Coding.version)
... name ΣC 0..1 string Name for this code system (computer friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the code system
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
... content SΣ 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.
... property SΣ 0..* BackboneElement Additional information supplied about each concept
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri SΣ 0..1 uri Formal identifier for the property
.... type SΣ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
... concept S 0..* BackboneElement Concepts in the code system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... definition S 0..1 string Formal definition
.... property S 0..* BackboneElement Property value for the concept
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code S 1..1 code Reference to CodeSystem.property.code
..... value[x] S 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept S 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sdc-2errorCodeSystemIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3warningCodeSystemSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: sdc-2, sdc-3
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url S 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... name 0..1 string Name for this code system (computer friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 0..1 boolean For testing purposes, not real usage
... date S 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the code system
... caseSensitive S 1..1 boolean If code comparison is case sensitive
... compositional 0..0
... versionNeeded 0..0
... content S 1..1 code not-present | example | fragment | complete | supplement
... property S 0..* BackboneElement Additional information supplied about each concept
.... code S 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri S 0..1 uri Formal identifier for the property
.... type S 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
... concept S 0..* BackboneElement Concepts in the code system
.... code S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... definition S 0..1 string Formal definition
.... designation
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
....... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... property S 0..* BackboneElement Property value for the concept
..... code S 1..1 code Reference to CodeSystem.property.code
..... value[x] S 1..1 code, Coding, string, integer, boolean, dateTime, decimal Value of the property for this concept
.... concept S 0..* Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-2errorCodeSystemIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3warningCodeSystemSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, sdc-2, sdc-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣ 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version SΣ 0..1 string Business version of the code system (Coding.version)
... name ΣC 0..1 string Name for this code system (computer friendly)
... title Σ 0..1 string Name for this code system (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 0..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this code system is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... caseSensitive 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 Σ 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
... content SΣ 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
... supplements Σ 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
... count Σ 0..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 1..* code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
.... value Σ 1..1 string What to use for the value
... property SΣ 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 SΣ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri SΣ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type SΣ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
... concept S 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 S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1 string Primitive value for string
Max Length:1048576
.... definition S 0..1 string Formal definition
.... designation 0..* BackboneElement Additional representations for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... use 0..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.
..... value 1..1 string The text value for this designation
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
....... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value 0..1 string Primitive value for string
Max Length:1048576
.... property S 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 S 1..1 code Reference to CodeSystem.property.code
..... value[x] S 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept S 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sdc-2errorCodeSystemIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3warningCodeSystemSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())

This structure is derived from CodeSystem

Summary

Mandatory: 1 element
Must-Support: 22 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, sdc-2, sdc-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... version SΣ 0..1 string Business version of the code system (Coding.version)
... name ΣC 0..1 string Name for this code system (computer friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the code system
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
... content SΣ 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.
... property SΣ 0..* BackboneElement Additional information supplied about each concept
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri SΣ 0..1 uri Formal identifier for the property
.... type SΣ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
... concept S 0..* BackboneElement Concepts in the code system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... definition S 0..1 string Formal definition
.... property S 0..* BackboneElement Property value for the concept
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code S 1..1 code Reference to CodeSystem.property.code
..... value[x] S 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept S 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sdc-2errorCodeSystemIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3warningCodeSystemSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: sdc-2, sdc-3
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url S 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... name 0..1 string Name for this code system (computer friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 0..1 boolean For testing purposes, not real usage
... date S 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the code system
... caseSensitive S 1..1 boolean If code comparison is case sensitive
... compositional 0..0
... versionNeeded 0..0
... content S 1..1 code not-present | example | fragment | complete | supplement
... property S 0..* BackboneElement Additional information supplied about each concept
.... code S 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri S 0..1 uri Formal identifier for the property
.... type S 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
... concept S 0..* BackboneElement Concepts in the code system
.... code S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... definition S 0..1 string Formal definition
.... designation
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
....... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... property S 0..* BackboneElement Property value for the concept
..... code S 1..1 code Reference to CodeSystem.property.code
..... value[x] S 1..1 code, Coding, string, integer, boolean, dateTime, decimal Value of the property for this concept
.... concept S 0..* Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-2errorCodeSystemIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3warningCodeSystemSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CodeSystem C 0..* CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, sdc-2, sdc-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣ 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version SΣ 0..1 string Business version of the code system (Coding.version)
... name ΣC 0..1 string Name for this code system (computer friendly)
... title Σ 0..1 string Name for this code system (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 0..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this code system is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... caseSensitive 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 Σ 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
... content SΣ 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
... supplements Σ 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
... count Σ 0..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 1..* code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
.... value Σ 1..1 string What to use for the value
... property SΣ 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 SΣ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri SΣ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type SΣ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
... concept S 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 S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1 string Primitive value for string
Max Length:1048576
.... definition S 0..1 string Formal definition
.... designation 0..* BackboneElement Additional representations for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... use 0..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.
..... value 1..1 string The text value for this designation
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptDisplayLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:conceptDisplayLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
....... extension:conceptDisplayLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value 0..1 string Primitive value for string
Max Length:1048576
.... property S 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 S 1..1 code Reference to CodeSystem.property.code
..... value[x] S 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept S 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sdc-2errorCodeSystemIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3warningCodeSystemSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())

This structure is derived from CodeSystem

Summary

Mandatory: 1 element
Must-Support: 22 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron