OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package, published by openEHR + HL7. 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/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions
Page standards status: Informative | Maturity Level: 3 |
Definitions for the DV-TEXT logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. DV_TEXT | |
Definition | A text item, which may contain any amount of legal characters arranged as e.g. words, sentences etc (i.e. one If the
A Base definition for all types defined in FHIR type system. |
Short | A text item, which may contain any amount of legal characters arranged as e.Base for all types and resources |
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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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 |
Guidance on how to interpret the contents of this table can be foundhere
0. DV_TEXT | |
Definition | A text item, which may contain any amount of legal characters arranged as e.g. words, sentences etc (i.e. one If the
A |
Short | A text item, which may contain any amount of legal characters arranged as e. |
Control | 0..* |
Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets ) |
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. DV_TEXT.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 |
4. DV_TEXT.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 |
6. DV_TEXT.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 |
8. DV_TEXT.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 |
10. DV_TEXT.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 |
12. DV_TEXT.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 |
Guidance on how to interpret the contents of this table can be foundhere
0. DV_TEXT | |
Definition | A text item, which may contain any amount of legal characters arranged as e.g. words, sentences etc (i.e. one If the
A |
Short | A text item, which may contain any amount of legal characters arranged as e. |
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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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. DV_TEXT.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 |