SMART Base
0.3.0 - ci-build
SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/litlfred/smart-base/ and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/base/StructureDefinition/KGTerminologyCode | Version: 0.3.0 | |||
| Active as of 2026-10-06 | Computable Name: KGTerminologyCode | |||
A code in an external terminology — ICD-10, ICD-11, SNOMED CT, ATC, or a WHO classification such as CDHI. CROSS-REFERENCE ONLY. It records system, code and display, and asserts NOTHING about the terminology: no hierarchy, no subsumption, no synonyms, no post-coordination. The terminology has its own authority, its own release cycle and its own tooling, and a partial copy here would be wrong within one release. Resolve meaning against the terminology server, not against this graph. Derives from Coding (FHIR R4 core datatype); system, code, display, version are its elements. Class IRI: http://smart.who.int/kg/terminology-code.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coding | Knowledge graph L1: Terminology code Elements defined in Ancestors:@id, extension, system, version, code, display, userSelected | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
A code in an external terminology — ICD-10, ICD-11, SNOMED CT, ATC, or a WHO classification such as CDHI. CROSS-REFERENCE ONLY. It records system, code and display, and asserts NOTHING about the terminology: no hierarchy, no subsumption, no synonyms, no post-coordination. The terminology has its own authority, its own release cycle and its own tooling, and a partial copy here would be wrong within one release. Resolve meaning against the terminology server, not against this graph. Derives from Coding (FHIR R4 core datatype); system, code, display, version are its elements. Class IRI: http://smart.who.int/kg/terminology-code.
Version: 1.0.0
This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-KGTerminologyCode.
Description: A code in an external terminology — ICD-10, ICD-11, SNOMED CT, ATC, or a WHO classification such as CDHI. CROSS-REFERENCE ONLY. It records system, code and display, and asserts NOTHING about the terminology: no hierarchy, no subsumption, no synonyms, no post-coordination. The terminology has its own authority, its own release cycle and its own tooling, and a partial copy here would be wrong within one release. Resolve meaning against the terminology server, not against this graph. Derives from Coding (FHIR R4 core datatype); system, code, display, version are its elements. Class IRI: http://smart.who.int/kg/terminology-code.
Type: object
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://smart.who.int/base/StructureDefinition-KGTerminologyCode.schema.json",
"title": "Knowledge graph L1: Terminology code",
"description": "A code in an external terminology \u2014 ICD-10, ICD-11, SNOMED CT, ATC, or a WHO classification such as CDHI. CROSS-REFERENCE ONLY. It records system, code and display, and asserts NOTHING about the terminology: no hierarchy, no subsumption, no synonyms, no post-coordination. The terminology has its own authority, its own release cycle and its own tooling, and a partial copy here would be wrong within one release. Resolve meaning against the terminology server, not against this graph. Derives from Coding (FHIR R4 core datatype); system, code, display, version are its elements. Class IRI: http://smart.who.int/kg/terminology-code.",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"const": "KGTerminologyCode",
"description": "Resource type identifier for KGTerminologyCode logical model"
},
"id": {
"type": "object",
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
},
"system": {
"type": "string",
"format": "uri",
"description": "The identification of the code system that defines the meaning of the symbol in the code."
},
"version": {
"type": "string",
"description": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."
},
"code": {
"type": "string",
"description": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)."
},
"display": {
"type": "string",
"description": "A representation of the meaning of the code in the system, following the rules of the system."
},
"userSelected": {
"type": "boolean",
"description": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)."
}
},
"required": [
"resourceType"
],
"resourceDefinition": "http://smart.who.int/base/StructureDefinition/KGTerminologyCode",
"fhir:parent": "http://hl7.org/fhir/StructureDefinition/Coding"
}
This documentation is automatically generated from the OpenAPI specification.
This structure is derived from Coding
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coding | Knowledge graph L1: Terminology code Elements defined in Ancestors:@id, extension, system, version, code, display, userSelected | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coding | Knowledge graph L1: Terminology code Elements defined in Ancestors:@id, extension, system, version, code, display, userSelected | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Coding
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coding | Knowledge graph L1: Terminology code Elements defined in Ancestors:@id, extension, system, version, code, display, userSelected | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Coding
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coding | Knowledge graph L1: Terminology code Elements defined in Ancestors:@id, extension, system, version, code, display, userSelected | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coding | Knowledge graph L1: Terminology code Elements defined in Ancestors:@id, extension, system, version, code, display, userSelected | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Coding