Sharing Valuesets, Codes, and Maps (SVCM)
1.5.1 - Trial-Implementation International flag

This page is part of the Sharing Valuesets, Codes, and Maps (SVCM) (v1.5.1: Publication) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SVCM CodeSystem

Official URL: https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.CodeSystem Version: 1.5.1
Active as of 2023-08-02 Computable Name: SVCMCodeSystem

A profile on the CodeSystem resource for SVCM.

Usage:

Formal Views of Profile Content

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

This structure is derived from Shareable CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 1..1Shareable CodeSystemDeclares the existence of and describes a code system or code system supplement
... url 1..1uriFor existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
... identifier 0..*IdentifierThe identifier shall contain any business identifiers this code system is identified by.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C1..1Shareable CodeSystemDeclares the existence of and describes a code system or code system supplement
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriFor existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
... identifier Σ0..*IdentifierThe identifier shall contain any business identifiers this code system is identified by.
... version Σ1..1stringBusiness version of the code system (Coding.version)
... name ΣC1..1stringName for this code system (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... publisher Σ1..1stringName of the publisher (organization or individual)
... description 1..1markdownNatural language description of the code system
... content Σ1..1codenot-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

... concept 1..*BackboneElementConcepts in the code system
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CodeSystem.statusrequiredPublicationStatus
CodeSystem.contentrequiredCodeSystemContentMode
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C1..1Shareable CodeSystemDeclares the existence of and describes a code system or code system supplement
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriFor existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
... identifier Σ0..*IdentifierThe identifier shall contain any business identifiers this code system is identified by.
... version Σ1..1stringBusiness version of the code system (Coding.version)
... name ΣC1..1stringName for this code system (computer friendly)
... title Σ0..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the code system
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this code system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content Σ1..1codenot-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..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter Σ0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow 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..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept 1..*BackboneElementConcepts in the code system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation 0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CodeSystem.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.statusrequiredPublicationStatus
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
CodeSystem.contentrequiredCodeSystemContentMode
CodeSystem.filter.operatorrequiredFilterOperator
CodeSystem.property.typerequiredPropertyType
CodeSystem.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.concept.designation.useextensibleDesignationUse

This structure is derived from Shareable CodeSystem

Summary

Differential View

This structure is derived from Shareable CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 1..1Shareable CodeSystemDeclares the existence of and describes a code system or code system supplement
... url 1..1uriFor existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
... identifier 0..*IdentifierThe identifier shall contain any business identifiers this code system is identified by.

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C1..1Shareable CodeSystemDeclares the existence of and describes a code system or code system supplement
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriFor existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
... identifier Σ0..*IdentifierThe identifier shall contain any business identifiers this code system is identified by.
... version Σ1..1stringBusiness version of the code system (Coding.version)
... name ΣC1..1stringName for this code system (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... publisher Σ1..1stringName of the publisher (organization or individual)
... description 1..1markdownNatural language description of the code system
... content Σ1..1codenot-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

... concept 1..*BackboneElementConcepts in the code system
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CodeSystem.statusrequiredPublicationStatus
CodeSystem.contentrequiredCodeSystemContentMode

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C1..1Shareable CodeSystemDeclares the existence of and describes a code system or code system supplement
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriFor existing code systems with an id in other formats, the URL can be expressed as a URN, e.g., urn:oid:X.X.X. Otherwise the value shall be a URL.
... identifier Σ0..*IdentifierThe identifier shall contain any business identifiers this code system is identified by.
... version Σ1..1stringBusiness version of the code system (Coding.version)
... name ΣC1..1stringName for this code system (computer friendly)
... title Σ0..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the code system
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this code system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content Σ1..1codenot-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..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter Σ0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow 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..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept 1..*BackboneElementConcepts in the code system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation 0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CodeSystem.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.statusrequiredPublicationStatus
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
CodeSystem.contentrequiredCodeSystemContentMode
CodeSystem.filter.operatorrequiredFilterOperator
CodeSystem.property.typerequiredPropertyType
CodeSystem.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.concept.designation.useextensibleDesignationUse

This structure is derived from Shareable CodeSystem

Summary

 

Other representations of profile: CSV, Excel, Schematron