EHDS openEHR data exchange
0.1.0 - ci-build
EHDS openEHR data exchange, published by Ian. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/freshehr/EHDS-openEHR-FHIR-IG/ and changes regularly. See the Directory of published versions
| Draft as of 2026-03-25 |
Definitions for the DvCodedText logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. DvCodedText | |
| Definition | openEHR CodedText FSH wrapper |
| Short | openEHR CodedText |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Valid_value: Valid value must not be empty (value.empty().not())Mappings_valid: Mappings valid must not be empty ( mappings /= void implies mappings.empty().not())Formatting_valid: Formatting valid must not be empty ( formatting /= void implies formatting.empty().not()) |
| 2. DvCodedText.CR | |
| Definition | Carriage return character. |
| Short | Carriage return character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DvCodedText.LF | |
| Definition | Line feed character. |
| Short | Line feed character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DvCodedText.Local-terminology-id | |
| Definition | Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype |
| Short | Predefined terminology identifier |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DvCodedText.value | |
| Definition | Displayable rendition of the item, regardless of its underlying structure. For |
| Short | Displayable rendition of the item, regardless of its underlying structure. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DvCodedText.hyperlink | |
| Definition | DEPRECATED: this field is deprecated; use markdown link/text in the Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item. |
| Short | DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-URI |
| Is Modifier | false |
| 12. DvCodedText.formatting | |
| Definition | If set, contains one of the following values:
DEPRECATED usage: contains a string of the form |
| Short | If set, contains one of the following values: * `"plain"`: use for plain text, possibly containing newlines, but otherwise unformatted (same as Void); * `"plain_no_newlines"`: use for text containing no newlines or other formatting; * `"markdown"`: use for markdown formatted text, strongly recommended in the format of the CommonMark specification. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DvCodedText.mappings | |
| Definition | Terms from other terminologies most closely matching this term, typically used where the originator (e.g. pathology lab) of information uses a local terminology but also supplies one or more equivalents from well known terminologies (e.g. LOINC). |
| Short | Terms from other terminologies most closely matching this term, typically used where the originator (e. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/TERM-MAPPING |
| Is Modifier | false |
| 16. DvCodedText.language | |
| Definition | Optional indicator of the localised language in which the value is written. Coded from openEHR Code Set languages . Only used when either the text object is in a different language from the enclosing |
| Short | Optional indicator of the localised language in which the value is written. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 18. DvCodedText.encoding | |
| Definition | Name of character encoding scheme in which this value is encoded. Coded from openEHR Code Set character sets . Unicode is the default assumption in openEHR, with UTF-8 being the assumed encoding. This attribute allows for variations from these assumptions. |
| Short | Name of character encoding scheme in which this value is encoded. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 20. DvCodedText.defining-code | |
| Definition | The term of which the |
| Short | The term of which the `_value_` attribute is the textual rendition (i. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DvCodedText | |
| Definition | openEHR CodedText FSH wrapper |
| Short | openEHR CodedText |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DvCodedText | |
| Definition | openEHR CodedText FSH wrapper |
| Short | openEHR CodedText |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Valid_value: Valid value must not be empty (value.empty().not())Mappings_valid: Mappings valid must not be empty ( mappings /= void implies mappings.empty().not())Formatting_valid: Formatting valid must not be empty ( formatting /= void implies formatting.empty().not()) |
| 2. DvCodedText.CR | |
| Definition | Carriage return character. |
| Short | Carriage return character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DvCodedText.LF | |
| Definition | Line feed character. |
| Short | Line feed character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DvCodedText.Local-terminology-id | |
| Definition | Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype |
| Short | Predefined terminology identifier |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DvCodedText.value | |
| Definition | Displayable rendition of the item, regardless of its underlying structure. For |
| Short | Displayable rendition of the item, regardless of its underlying structure. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DvCodedText.hyperlink | |
| Definition | DEPRECATED: this field is deprecated; use markdown link/text in the Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item. |
| Short | DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-URI |
| Is Modifier | false |
| 12. DvCodedText.formatting | |
| Definition | If set, contains one of the following values:
DEPRECATED usage: contains a string of the form |
| Short | If set, contains one of the following values: * `"plain"`: use for plain text, possibly containing newlines, but otherwise unformatted (same as Void); * `"plain_no_newlines"`: use for text containing no newlines or other formatting; * `"markdown"`: use for markdown formatted text, strongly recommended in the format of the CommonMark specification. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DvCodedText.mappings | |
| Definition | Terms from other terminologies most closely matching this term, typically used where the originator (e.g. pathology lab) of information uses a local terminology but also supplies one or more equivalents from well known terminologies (e.g. LOINC). |
| Short | Terms from other terminologies most closely matching this term, typically used where the originator (e. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/TERM-MAPPING |
| Is Modifier | false |
| 16. DvCodedText.language | |
| Definition | Optional indicator of the localised language in which the value is written. Coded from openEHR Code Set languages . Only used when either the text object is in a different language from the enclosing |
| Short | Optional indicator of the localised language in which the value is written. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 18. DvCodedText.encoding | |
| Definition | Name of character encoding scheme in which this value is encoded. Coded from openEHR Code Set character sets . Unicode is the default assumption in openEHR, with UTF-8 being the assumed encoding. This attribute allows for variations from these assumptions. |
| Short | Name of character encoding scheme in which this value is encoded. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 20. DvCodedText.defining-code | |
| Definition | The term of which the |
| Short | The term of which the `_value_` attribute is the textual rendition (i. |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |