CodeSystem
The 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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 17 of 20 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
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) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
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)Binding (extensible): jurisdiction |
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(ValueSet) | Canonical reference to the value set with entire code system |
hierarchyMeaningΣ | 0..1 | code | grouped-by | is-a | part-of | classified-withBinding (required): codesystem-hierarchy-meaning |
compositionalΣ | 0..1 | boolean | If code system defines a compositional grammar |
versionNeededΣ | 0..1 | boolean | If definitions are not stable |
contentRequiredΣ | 1..1 | code | not-present | example | fragment | complete | supplementBinding (required): codesystem-content-mode |
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 |
codeRequiredΣ | 1..1 | code | Code that identifies the filter |
descriptionΣ | 0..1 | string | How or why the filter is used |
operatorRequiredΣ | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | existsBinding (required): filter-operator |
valueRequiredΣ | 1..1 | string | What to use for the value |
propertyΣ | 0..* | BackboneElement | Additional information supplied about each concept |
codeRequiredΣ | 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 |
typeRequiredΣ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimalBinding (required): concept-property-type |
concept | 0..* | BackboneElement | Concepts in the code system |
codeRequired | 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 |
language | 0..1 | code | Human language of the designationBinding (preferred): languages |
use | 0..1 | Coding | Details how this designation would be usedBinding (extensible): designation-use |
valueRequired | 1..1 | string | The text value for this designation |
property | 0..* | BackboneElement | Property value for the concept |
codeRequired | 1..1 | code | Reference to CodeSystem.property.code |
value[x]Required | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | Value of the property for this concept |
concept | 0..* | Same as CodeSystem.concept | Child Concepts (is-a/contains/categorizes) |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/CodeSystem?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
code | token | A code defined in the code system CodeSystem.concept.code | ||
content-mode | token | not-present | example | fragment | complete | supplement CodeSystem.content | ||
context | token | A use context assigned to the code system (CodeSystem.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the code system (CodeSystem.useContext.value.ofType(Quantity)) | (CodeSystem.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the code system CodeSystem.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the code system CodeSystem.useContext | ||
context-type-value | composite | A use context type and value assigned to the code system CodeSystem.useContext | ||
date | date | The code system publication date CodeSystem.date | ||
description | string | The description of the code system CodeSystem.description | ||
identifier | token | External identifier for the code system CodeSystem.identifier | ||
jurisdiction | token | Intended jurisdiction for the code system CodeSystem.jurisdiction | ||
language | token | A language in which a designation is provided CodeSystem.concept.designation.language | ||
name | string | Computationally friendly name of the code system CodeSystem.name | ||
publisher | string | Name of the publisher of the code system CodeSystem.publisher | ||
status | token | The current status of the code system CodeSystem.status | ||
supplements | reference | Find code system supplements for the referenced code system CodeSystem.supplements | ||
system | uri | The system for any codes defined by this code system (same as 'url') CodeSystem.url | ||
title | string | The human-friendly name of the code system CodeSystem.title | ||
url | uri | The uri that identifies the code system CodeSystem.url | ||
version | token | The business version of the code system CodeSystem.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken