NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem NDomainResourceDeclares the existence of and describes a code system or code system supplement
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Within a code system definition, all the codes SHALL be unique
+ Warning: If there is an explicit hierarchy, a hierarchyMeaning should be provided
+ Warning: If there is an implicit hierarchy, a hierarchyMeaning should be provided
+ Rule: If the code system content = supplement, it must nominate what it's a supplement for

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the code system (business identifier)

... version Σ0..1stringBusiness version of the code system (Coding.version)
... versionAlgorithm[x] ΣTU0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this code system (computer friendly)
... title ΣT0..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the code system
... useContext ΣTU0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this code system is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel TTU0..1stringCopyright holder and year(s)
... approvalDate TU0..1dateWhen the CodeSystem was approved by publisher
... lastReviewDate TU0..1dateWhen the CodeSystem was last reviewed by the publisher
... effectivePeriod ΣTU0..1PeriodWhen the CodeSystem is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author TU0..*ContactDetailWho authored the CodeSystem

... editor TU0..*ContactDetailWho edited the CodeSystem

... reviewer TU0..*ContactDetailWho reviewed the CodeSystem

... endorser TU0..*ContactDetailWho endorsed the CodeSystem

... relatedArtifact TU0..*RelatedArtifactAdditional documentation, citations, etc

... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning ΣC0..1codegrouped-by | is-a | part-of | classified-with
Binding: Code System Hierarchy Meaning (Required)
... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content ΣC1..1codenot-present | example | fragment | complete | supplement
Binding: Code System Content Mode (Required)
... supplements ΣCTU0..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

.... 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 | child-of | descendent-leaf | exists
Binding: Filter Operator (Required)

.... value Σ1..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept

.... 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: Property Type (Required)
... concept C0..*BackboneElementConcepts in the code system

.... code C1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation C0..*BackboneElementAdditional representations for the concept
+ Rule: Must have a value for concept.designation.use if concept.designation.additionalUse is present

..... language 0..1codeHuman language of the designation
Binding: All Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set

..... use C0..1CodingDetails how this designation would be used
Binding: Designation Use (Extensible)
..... additionalUse CTU0..*CodingAdditional ways how this designation would be used
Binding: Designation Use (Extensible)

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept

..... code C1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept C0..*see conceptChild Concepts (is-a/contains/categorizes)


doco Documentation for this format