Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CodeSystem | N | DomainResource | Declares 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 | ΣC | 0..1 | uri | Canonical 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..* | Identifier | Additional identifier for the code system (business identifier) | ||||
version | Σ | 0..1 | string | Business version of the code system (Coding.version) | ||||
versionAlgorithm[x] | ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | ΣC | 0..1 | string | Name for this code system (computer friendly) | ||||
title | ΣT | 0..1 | string | Name for this code system (human friendly) | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | T | 0..1 | markdown | Natural language description of the code system | ||||
useContext | ΣTU | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (Extensible) | ||||
purpose | T | 0..1 | markdown | Why this code system is defined | ||||
copyright | T | 0..1 | markdown | Use and/or publishing restrictions | ||||
copyrightLabel | TTU | 0..1 | string | Copyright holder and year(s) | ||||
approvalDate | TU | 0..1 | date | When the CodeSystem was approved by publisher | ||||
lastReviewDate | TU | 0..1 | date | When the CodeSystem was last reviewed by the publisher | ||||
effectivePeriod | ΣTU | 0..1 | Period | When the CodeSystem is expected to be used | ||||
topic | XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | ||||
author | TU | 0..* | ContactDetail | Who authored the CodeSystem | ||||
editor | TU | 0..* | ContactDetail | Who edited the CodeSystem | ||||
reviewer | TU | 0..* | ContactDetail | Who reviewed the CodeSystem | ||||
endorser | TU | 0..* | ContactDetail | Who endorsed the CodeSystem | ||||
relatedArtifact | TU | 0..* | RelatedArtifact | Additional documentation, citations, etc | ||||
caseSensitive | Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
hierarchyMeaning | ΣC | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: Code System Hierarchy Meaning (Required) | ||||
compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
versionNeeded | Σ | 0..1 | boolean | If definitions are not stable | ||||
content | ΣC | 1..1 | code | not-present | example | fragment | complete | supplement Binding: Code System Content Mode (Required) | ||||
supplements | ΣCTU | 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 | ||||
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: Filter Operator (Required) | ||||
value | Σ | 1..1 | string | What to use for the value | ||||
property | Σ | 0..* | BackboneElement | Additional information supplied about each concept | ||||
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: Property Type (Required) | ||||
concept | C | 0..* | BackboneElement | Concepts in the code system | ||||
code | C | 1..1 | code | Code that identifies concept | ||||
display | 0..1 | string | Text to display to the user | |||||
definition | 0..1 | string | Formal definition | |||||
designation | C | 0..* | BackboneElement | Additional representations for the concept + Rule: Must have a value for concept.designation.use if concept.designation.additionalUse is present | ||||
language | 0..1 | code | Human language of the designation Binding: All Languages (Required)
| |||||
use | C | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (Extensible) | ||||
additionalUse | CTU | 0..* | Coding | Additional ways how this designation would be used Binding: Designation Use (Extensible) | ||||
value | 1..1 | string | The text value for this designation | |||||
property | 0..* | BackboneElement | Property value for the concept | |||||
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 | C | 0..* | see concept | Child Concepts (is-a/contains/categorizes) | ||||
Documentation for this format |