OpenEHR Base package
0.1.0 - First Draft International flag

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

Logical Model: DV_TEXT

Official URL: http://openehr.org/fhir/StructureDefinition/DV-TEXT Version: 0.1.0
Standards status: Informative Maturity Level: 3 Computable Name: DV_TEXT

A text item, which may contain any amount of legal characters arranged as e.g. words, sentences etc (i.e. one DV_TEXT may be more than one word). Visual formatting and hyperlinks may be included via markdown.

If the _formatting_ field is set, the _value_ field is affected as follows:

  • _formatting_ = "plain": plain text, may contain newlines;
  • _formatting_ = "plain_no_newlines": plain text with no newlines;
  • _formatting_ = "markdown": text in markdown format; use of CommonMark strongly recommended.

A DV_TEXT can be coded by adding mappings to it.

Original Source: specifications.openehr.org

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_TEXT C 0..* DATA_VALUE A text item, which may contain any amount of legal characters arranged as e.

Elements defined in Ancestors:CR, LF, Local_terminology_id
Constraints: Valid_value, Mappings_valid, Formatting_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... hyperlink 0..1 DV_URI DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
... formatting 0..1 string 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.
... mappings 0..* TERM_MAPPING Terms from other terminologies most closely matching this term, typically used where the originator (e.
... language 0..1 CODE_PHRASE Optional indicator of the localised language in which the value is written.
... encoding 0..1 CODE_PHRASE Name of character encoding scheme in which this value is encoded.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Formatting_valid error DV_TEXT Formatting valid must not be empty formatting /= void implies formatting.empty().not()
Mappings_valid error DV_TEXT Mappings valid must not be empty mappings /= void implies mappings.empty().not()
Valid_value error DV_TEXT Valid value must not be empty value.empty().not()

This structure is derived from DATA_VALUE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_TEXT C 0..* DATA_VALUE A text item, which may contain any amount of legal characters arranged as e.

Elements defined in Ancestors:CR, LF, Local_terminology_id
Binding: Character Set (required)
Constraints: Valid_value, Mappings_valid, Formatting_valid
... value 1..1 string Displayable rendition of the item, regardless of its underlying structure.
... hyperlink 0..1 DV_URI DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
... formatting 0..1 string 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.
... language 0..1 CODE_PHRASE Optional indicator of the localised language in which the value is written.
... encoding 0..1 CODE_PHRASE Name of character encoding scheme in which this value is encoded.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DV_TEXT Base required Character Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
Formatting_valid error DV_TEXT Formatting valid must not be empty formatting /= void implies formatting.empty().not()
Mappings_valid error DV_TEXT Mappings valid must not be empty mappings /= void implies mappings.empty().not()
Valid_value error DV_TEXT Valid value must not be empty value.empty().not()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_TEXT C 0..* DATA_VALUE A text item, which may contain any amount of legal characters arranged as e.

Elements defined in Ancestors:CR, LF, Local_terminology_id
Constraints: Valid_value, Mappings_valid, Formatting_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... hyperlink 0..1 DV_URI DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
... formatting 0..1 string 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.
... mappings 0..* TERM_MAPPING Terms from other terminologies most closely matching this term, typically used where the originator (e.
... language 0..1 CODE_PHRASE Optional indicator of the localised language in which the value is written.
... encoding 0..1 CODE_PHRASE Name of character encoding scheme in which this value is encoded.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Formatting_valid error DV_TEXT Formatting valid must not be empty formatting /= void implies formatting.empty().not()
Mappings_valid error DV_TEXT Mappings valid must not be empty mappings /= void implies mappings.empty().not()
Valid_value error DV_TEXT Valid value must not be empty value.empty().not()

This structure is derived from DATA_VALUE

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_TEXT C 0..* DATA_VALUE A text item, which may contain any amount of legal characters arranged as e.

Elements defined in Ancestors:CR, LF, Local_terminology_id
Constraints: Valid_value, Mappings_valid, Formatting_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... hyperlink 0..1 DV_URI DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
... formatting 0..1 string 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.
... mappings 0..* TERM_MAPPING Terms from other terminologies most closely matching this term, typically used where the originator (e.
... language 0..1 CODE_PHRASE Optional indicator of the localised language in which the value is written.
... encoding 0..1 CODE_PHRASE Name of character encoding scheme in which this value is encoded.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Formatting_valid error DV_TEXT Formatting valid must not be empty formatting /= void implies formatting.empty().not()
Mappings_valid error DV_TEXT Mappings valid must not be empty mappings /= void implies mappings.empty().not()
Valid_value error DV_TEXT Valid value must not be empty value.empty().not()

Differential View

This structure is derived from DATA_VALUE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_TEXT C 0..* DATA_VALUE A text item, which may contain any amount of legal characters arranged as e.

Elements defined in Ancestors:CR, LF, Local_terminology_id
Binding: Character Set (required)
Constraints: Valid_value, Mappings_valid, Formatting_valid
... value 1..1 string Displayable rendition of the item, regardless of its underlying structure.
... hyperlink 0..1 DV_URI DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
... formatting 0..1 string 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.
... language 0..1 CODE_PHRASE Optional indicator of the localised language in which the value is written.
... encoding 0..1 CODE_PHRASE Name of character encoding scheme in which this value is encoded.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DV_TEXT Base required Character Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
Formatting_valid error DV_TEXT Formatting valid must not be empty formatting /= void implies formatting.empty().not()
Mappings_valid error DV_TEXT Mappings valid must not be empty mappings /= void implies mappings.empty().not()
Valid_value error DV_TEXT Valid value must not be empty value.empty().not()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_TEXT C 0..* DATA_VALUE A text item, which may contain any amount of legal characters arranged as e.

Elements defined in Ancestors:CR, LF, Local_terminology_id
Constraints: Valid_value, Mappings_valid, Formatting_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... hyperlink 0..1 DV_URI DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
... formatting 0..1 string 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.
... mappings 0..* TERM_MAPPING Terms from other terminologies most closely matching this term, typically used where the originator (e.
... language 0..1 CODE_PHRASE Optional indicator of the localised language in which the value is written.
... encoding 0..1 CODE_PHRASE Name of character encoding scheme in which this value is encoded.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Formatting_valid error DV_TEXT Formatting valid must not be empty formatting /= void implies formatting.empty().not()
Mappings_valid error DV_TEXT Mappings valid must not be empty mappings /= void implies mappings.empty().not()
Valid_value error DV_TEXT Valid value must not be empty value.empty().not()

This structure is derived from DATA_VALUE

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

 

Other representations of profile: CSV, Excel