Estonian Terminology Services Implementation Guide
1.0.0 - draft
Estonian Terminology Services Implementation Guide
1.0.0 - draft
Estonian Terminology Services Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/TerminologyServices/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.ee/StructureDefinition/Metadata | Version: 1.0.0 | |||
| Draft as of 2025-01-10 | Computable Name: Metadata | |||
Klassifikaatori/koodiloendi pass. Logical model for metadata for a codesystem or value set
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Metadata |
0..* | Base | Metadata for code set | |
  identifier |
1..* | BackboneElement | Identifiers ele-1: All FHIR elements must have a @value or children | |
   @id |
0..1 | id | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| fhirURI |
1..1 | Identifier | FHIR identifier | |
 oid |
0..1 | Identifier | OID identifier | |
| name |
1..* | BackboneElement | Name ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| titleEstonian |
1..1 | string | The most commonly used name (can be an acronym). Preferred name in most settings. | |
| titleEnglish |
0..1 | string | ||
| fullNameEstonian |
0..1 | string | Full name in Estonian if it differs from common name | |
| machinereadableName |
1..1 | string | Name for machine-processing and URI creation | |
| classification |
0..1 | boolean | CodeSystem is classified as classification by Estonian state regulations | |
| domain |
1..* | code | Usage context (healthcare, social care, work, ...) | |
| description |
1..1 | string | Short description | |
| owner |
1..1 | string | Owner/expert of the content. Takes responsibility for the quality of the content | |
| maintainer |
1..1 | string | Technical maintainer and publisher | |
 basedOn |
0..* | Reference() | Source terminology. | |
| relatedTerminologyAsset |
0..* | BackboneElement | Related terminology that is not technically the source it's directly based on ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| reference |
0..1 | Reference() | Related terminology asset's URL | |
| description |
0..1 | string | Description how this terminology is related | |
| guidance |
0..* | BackboneElement | Guidance related to the terminology asset, textual or referenced ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| usage |
0..1 | string | Textual guidance about the usage of the terminology asset. | |
| manual |
0..* | url | Links to additional guidance material | |
| codingPrinciples |
0..1 | string | Short guidance about the structure of the code system (hierarchy, code creation, etc) | |
| changeManagementInformation |
1..1 | string | Guidance on change management and release cycles | |
| relatedAct |
0..* | BackboneElement | Related legal acts ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url |
0..1 | uri | URL to the related legal act | |
| name |
0..1 | string | Name of the related legal act | |
| description |
0..1 | string | Explanation about how the documented legal act is related to the terminology asset | |
| datePublication |
1..1 | date | Date the terminology asset was published | |
| dateLastUpdate |
1..1 | date | Date of the last update | |
| effectivePeriod |
0..* | Period | Effective dates of the terminology asset version. | |
| invalidationDate |
0..1 | date | ?Date of deprecation of the whole terminology asset | |
| version |
0..1 | string | Version | |
| status |
1..1 | code | Validity status of the terminology asset | |
| replacedBy |
0..* | Reference() | Reference to the new terminology asset that replaces the invalidated asset | |
| replaces |
0..* | Reference() | Terminology asset which has been replaced by the new terminology asset | |
| guidanceOnUpdate |
0..1 | string | Information about the update in case of a new version (reference or short description of impact, transition periods and implementation guidance) | |
| comments |
0..1 | string | Additional textual information | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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 Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Metadata |
0..* | Base | Metadata for code set | |
| identifier |
1..* | BackboneElement | Identifiers | |
| fhirURI |
1..1 | Identifier | FHIR identifier | |
| oid |
0..1 | Identifier | OID identifier | |
| name |
1..* | BackboneElement | Name | |
| titleEstonian |
1..1 | string | The most commonly used name (can be an acronym). Preferred name in most settings. | |
| titleEnglish |
0..1 | string | ||
| fullNameEstonian |
0..1 | string | Full name in Estonian if it differs from common name | |
| machinereadableName |
1..1 | string | Name for machine-processing and URI creation | |
| classification |
0..1 | boolean | CodeSystem is classified as classification by Estonian state regulations | |
| domain |
1..* | code | Usage context (healthcare, social care, work, ...) | |
| description |
1..1 | string | Short description | |
| owner |
1..1 | string | Owner/expert of the content. Takes responsibility for the quality of the content | |
| maintainer |
1..1 | string | Technical maintainer and publisher | |
| basedOn |
0..* | Reference() | Source terminology. | |
| relatedTerminologyAsset |
0..* | BackboneElement | Related terminology that is not technically the source it's directly based on | |
| reference |
0..1 | Reference() | Related terminology asset's URL | |
| description |
0..1 | string | Description how this terminology is related | |
| guidance |
0..* | BackboneElement | Guidance related to the terminology asset, textual or referenced | |
| usage |
0..1 | string | Textual guidance about the usage of the terminology asset. | |
| manual |
0..* | url | Links to additional guidance material | |
| codingPrinciples |
0..1 | string | Short guidance about the structure of the code system (hierarchy, code creation, etc) | |
| changeManagementInformation |
1..1 | string | Guidance on change management and release cycles | |
| relatedAct |
0..* | BackboneElement | Related legal acts | |
| url |
0..1 | uri | URL to the related legal act | |
| name |
0..1 | string | Name of the related legal act | |
| description |
0..1 | string | Explanation about how the documented legal act is related to the terminology asset | |
| datePublication |
1..1 | date | Date the terminology asset was published | |
| dateLastUpdate |
1..1 | date | Date of the last update | |
| effectivePeriod |
0..* | Period | Effective dates of the terminology asset version. | |
| invalidationDate |
0..1 | date | ?Date of deprecation of the whole terminology asset | |
| version |
0..1 | string | Version | |
| status |
1..1 | code | Validity status of the terminology asset | |
| replacedBy |
0..* | Reference() | Reference to the new terminology asset that replaces the invalidated asset | |
| replaces |
0..* | Reference() | Terminology asset which has been replaced by the new terminology asset | |
| guidanceOnUpdate |
0..1 | string | Information about the update in case of a new version (reference or short description of impact, transition periods and implementation guidance) | |
| comments |
0..1 | string | Additional textual information | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Metadata |
0..* | Base | Metadata for code set | |
| identifier |
1..* | BackboneElement | Identifiers | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fhirURI |
1..1 | Identifier | FHIR identifier | |
| oid |
0..1 | Identifier | OID identifier | |
| name |
1..* | BackboneElement | Name | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| titleEstonian |
1..1 | string | The most commonly used name (can be an acronym). Preferred name in most settings. | |
| titleEnglish |
0..1 | string | ||
| fullNameEstonian |
0..1 | string | Full name in Estonian if it differs from common name | |
| machinereadableName |
1..1 | string | Name for machine-processing and URI creation | |
| classification |
0..1 | boolean | CodeSystem is classified as classification by Estonian state regulations | |
| domain |
1..* | code | Usage context (healthcare, social care, work, ...) | |
| description |
1..1 | string | Short description | |
| owner |
1..1 | string | Owner/expert of the content. Takes responsibility for the quality of the content | |
| maintainer |
1..1 | string | Technical maintainer and publisher | |
| basedOn |
0..* | Reference() | Source terminology. | |
| relatedTerminologyAsset |
0..* | BackboneElement | Related terminology that is not technically the source it's directly based on | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference |
0..1 | Reference() | Related terminology asset's URL | |
| description |
0..1 | string | Description how this terminology is related | |
| guidance |
0..* | BackboneElement | Guidance related to the terminology asset, textual or referenced | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| usage |
0..1 | string | Textual guidance about the usage of the terminology asset. | |
| manual |
0..* | url | Links to additional guidance material | |
| codingPrinciples |
0..1 | string | Short guidance about the structure of the code system (hierarchy, code creation, etc) | |
| changeManagementInformation |
1..1 | string | Guidance on change management and release cycles | |
| relatedAct |
0..* | BackboneElement | Related legal acts | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| url |
0..1 | uri | URL to the related legal act | |
| name |
0..1 | string | Name of the related legal act | |
| description |
0..1 | string | Explanation about how the documented legal act is related to the terminology asset | |
| datePublication |
1..1 | date | Date the terminology asset was published | |
| dateLastUpdate |
1..1 | date | Date of the last update | |
| effectivePeriod |
0..* | Period | Effective dates of the terminology asset version. | |
| invalidationDate |
0..1 | date | ?Date of deprecation of the whole terminology asset | |
| version |
0..1 | string | Version | |
| status |
1..1 | code | Validity status of the terminology asset | |
| replacedBy |
0..* | Reference() | Reference to the new terminology asset that replaces the invalidated asset | |
| replaces |
0..* | Reference() | Terminology asset which has been replaced by the new terminology asset | |
| guidanceOnUpdate |
0..1 | string | Information about the update in case of a new version (reference or short description of impact, transition periods and implementation guidance) | |
| comments |
0..1 | string | Additional textual information | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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 Base
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Metadata |
0..* | Base | Metadata for code set | |
| identifier |
1..* | BackboneElement | Identifiers ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| fhirURI |
1..1 | Identifier | FHIR identifier | |
| oid |
0..1 | Identifier | OID identifier | |
| name |
1..* | BackboneElement | Name ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| titleEstonian |
1..1 | string | The most commonly used name (can be an acronym). Preferred name in most settings. | |
| titleEnglish |
0..1 | string | ||
| fullNameEstonian |
0..1 | string | Full name in Estonian if it differs from common name | |
| machinereadableName |
1..1 | string | Name for machine-processing and URI creation | |
| classification |
0..1 | boolean | CodeSystem is classified as classification by Estonian state regulations | |
| domain |
1..* | code | Usage context (healthcare, social care, work, ...) | |
| description |
1..1 | string | Short description | |
| owner |
1..1 | string | Owner/expert of the content. Takes responsibility for the quality of the content | |
| maintainer |
1..1 | string | Technical maintainer and publisher | |
| basedOn |
0..* | Reference() | Source terminology. | |
| relatedTerminologyAsset |
0..* | BackboneElement | Related terminology that is not technically the source it's directly based on ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| reference |
0..1 | Reference() | Related terminology asset's URL | |
| description |
0..1 | string | Description how this terminology is related | |
| guidance |
0..* | BackboneElement | Guidance related to the terminology asset, textual or referenced ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| usage |
0..1 | string | Textual guidance about the usage of the terminology asset. | |
| manual |
0..* | url | Links to additional guidance material | |
| codingPrinciples |
0..1 | string | Short guidance about the structure of the code system (hierarchy, code creation, etc) | |
| changeManagementInformation |
1..1 | string | Guidance on change management and release cycles | |
| relatedAct |
0..* | BackboneElement | Related legal acts ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url |
0..1 | uri | URL to the related legal act | |
| name |
0..1 | string | Name of the related legal act | |
| description |
0..1 | string | Explanation about how the documented legal act is related to the terminology asset | |
| datePublication |
1..1 | date | Date the terminology asset was published | |
| dateLastUpdate |
1..1 | date | Date of the last update | |
| effectivePeriod |
0..* | Period | Effective dates of the terminology asset version. | |
| invalidationDate |
0..1 | date | ?Date of deprecation of the whole terminology asset | |
| version |
0..1 | string | Version | |
| status |
1..1 | code | Validity status of the terminology asset | |
| replacedBy |
0..* | Reference() | Reference to the new terminology asset that replaces the invalidated asset | |
| replaces |
0..* | Reference() | Terminology asset which has been replaced by the new terminology asset | |
| guidanceOnUpdate |
0..1 | string | Information about the update in case of a new version (reference or short description of impact, transition periods and implementation guidance) | |
| comments |
0..1 | string | Additional textual information | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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 Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Metadata |
0..* | Base | Metadata for code set | |
| identifier |
1..* | BackboneElement | Identifiers | |
| fhirURI |
1..1 | Identifier | FHIR identifier | |
| oid |
0..1 | Identifier | OID identifier | |
| name |
1..* | BackboneElement | Name | |
| titleEstonian |
1..1 | string | The most commonly used name (can be an acronym). Preferred name in most settings. | |
| titleEnglish |
0..1 | string | ||
| fullNameEstonian |
0..1 | string | Full name in Estonian if it differs from common name | |
| machinereadableName |
1..1 | string | Name for machine-processing and URI creation | |
| classification |
0..1 | boolean | CodeSystem is classified as classification by Estonian state regulations | |
| domain |
1..* | code | Usage context (healthcare, social care, work, ...) | |
| description |
1..1 | string | Short description | |
| owner |
1..1 | string | Owner/expert of the content. Takes responsibility for the quality of the content | |
| maintainer |
1..1 | string | Technical maintainer and publisher | |
| basedOn |
0..* | Reference() | Source terminology. | |
| relatedTerminologyAsset |
0..* | BackboneElement | Related terminology that is not technically the source it's directly based on | |
| reference |
0..1 | Reference() | Related terminology asset's URL | |
| description |
0..1 | string | Description how this terminology is related | |
| guidance |
0..* | BackboneElement | Guidance related to the terminology asset, textual or referenced | |
| usage |
0..1 | string | Textual guidance about the usage of the terminology asset. | |
| manual |
0..* | url | Links to additional guidance material | |
| codingPrinciples |
0..1 | string | Short guidance about the structure of the code system (hierarchy, code creation, etc) | |
| changeManagementInformation |
1..1 | string | Guidance on change management and release cycles | |
| relatedAct |
0..* | BackboneElement | Related legal acts | |
| url |
0..1 | uri | URL to the related legal act | |
| name |
0..1 | string | Name of the related legal act | |
| description |
0..1 | string | Explanation about how the documented legal act is related to the terminology asset | |
| datePublication |
1..1 | date | Date the terminology asset was published | |
| dateLastUpdate |
1..1 | date | Date of the last update | |
| effectivePeriod |
0..* | Period | Effective dates of the terminology asset version. | |
| invalidationDate |
0..1 | date | ?Date of deprecation of the whole terminology asset | |
| version |
0..1 | string | Version | |
| status |
1..1 | code | Validity status of the terminology asset | |
| replacedBy |
0..* | Reference() | Reference to the new terminology asset that replaces the invalidated asset | |
| replaces |
0..* | Reference() | Terminology asset which has been replaced by the new terminology asset | |
| guidanceOnUpdate |
0..1 | string | Information about the update in case of a new version (reference or short description of impact, transition periods and implementation guidance) | |
| comments |
0..1 | string | Additional textual information | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Metadata |
0..* | Base | Metadata for code set | |
| identifier |
1..* | BackboneElement | Identifiers | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fhirURI |
1..1 | Identifier | FHIR identifier | |
| oid |
0..1 | Identifier | OID identifier | |
| name |
1..* | BackboneElement | Name | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| titleEstonian |
1..1 | string | The most commonly used name (can be an acronym). Preferred name in most settings. | |
| titleEnglish |
0..1 | string | ||
| fullNameEstonian |
0..1 | string | Full name in Estonian if it differs from common name | |
| machinereadableName |
1..1 | string | Name for machine-processing and URI creation | |
| classification |
0..1 | boolean | CodeSystem is classified as classification by Estonian state regulations | |
| domain |
1..* | code | Usage context (healthcare, social care, work, ...) | |
| description |
1..1 | string | Short description | |
| owner |
1..1 | string | Owner/expert of the content. Takes responsibility for the quality of the content | |
| maintainer |
1..1 | string | Technical maintainer and publisher | |
| basedOn |
0..* | Reference() | Source terminology. | |
| relatedTerminologyAsset |
0..* | BackboneElement | Related terminology that is not technically the source it's directly based on | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference |
0..1 | Reference() | Related terminology asset's URL | |
| description |
0..1 | string | Description how this terminology is related | |
| guidance |
0..* | BackboneElement | Guidance related to the terminology asset, textual or referenced | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| usage |
0..1 | string | Textual guidance about the usage of the terminology asset. | |
| manual |
0..* | url | Links to additional guidance material | |
| codingPrinciples |
0..1 | string | Short guidance about the structure of the code system (hierarchy, code creation, etc) | |
| changeManagementInformation |
1..1 | string | Guidance on change management and release cycles | |
| relatedAct |
0..* | BackboneElement | Related legal acts | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| url |
0..1 | uri | URL to the related legal act | |
| name |
0..1 | string | Name of the related legal act | |
| description |
0..1 | string | Explanation about how the documented legal act is related to the terminology asset | |
| datePublication |
1..1 | date | Date the terminology asset was published | |
| dateLastUpdate |
1..1 | date | Date of the last update | |
| effectivePeriod |
0..* | Period | Effective dates of the terminology asset version. | |
| invalidationDate |
0..1 | date | ?Date of deprecation of the whole terminology asset | |
| version |
0..1 | string | Version | |
| status |
1..1 | code | Validity status of the terminology asset | |
| replacedBy |
0..* | Reference() | Reference to the new terminology asset that replaces the invalidated asset | |
| replaces |
0..* | Reference() | Terminology asset which has been replaced by the new terminology asset | |
| guidanceOnUpdate |
0..1 | string | Information about the update in case of a new version (reference or short description of impact, transition periods and implementation guidance) | |
| comments |
0..1 | string | Additional textual information | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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 Base