CodeSystem
activeFoundationThe CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| CodeSystem | 0..* | — | Declares the existence of and describes a code system or code system supplement |
| .idΣ | 0..1 | String | 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 Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 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Σ | 0..1 | string | Business version of the code system (Coding.version) |
| .nameΣ | 0..1 | string | Name for this code system (computer friendly) |
| .titleΣ | 0..1 | string | Name for this code system (human friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 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 | 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) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this code system is defined |
| .copyright | 0..1 | markdown | Use and/or publishing restrictions |
| .caseSensitiveΣ | 0..1 | boolean | If code comparison is case sensitive |
| .valueSetΣ | 0..1 | canonical | Canonical reference to the value set with entire code system |
| .hierarchyMeaningΣ | 0..1 | code | grouped-by | is-a | part-of | classified-with Bindingcodesystem-hierarchy-meaning(required) |
| .compositionalΣ | 0..1 | boolean | If code system defines a compositional grammar |
| .versionNeededΣ | 0..1 | boolean | If definitions are not stable |
| .contentΣ | 1..1 | code | not-present | example | fragment | complete | supplement Bindingcodesystem-content-mode(required) |
| .supplementsΣ | 0..1 | canonical | 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 Bindingfilter-operator(required) |
| .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 Bindingconcept-property-type(required) |
| .concept | 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 | 1..1 | code | Code that identifies concept |
| .display | 0..1 | string | Text to display to the user |
| .definition | 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 Bindinglanguages(preferred) |
| .use | 0..1 | Coding | Details how this designation would be used Bindingdesignation-use(extensible) |
| .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 | 1..1 | code | Reference to CodeSystem.property.code |
| .value[x] | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | Value of the property for this concept |
| .concept | 0..* | — | Child Concepts (is-a/contains/categorizes) |