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 |
XML representation of the DvCodedText logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="DvCodedText"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition DvCodedText</b></p><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-DvCodedText-definitions.html#DvCodedText" title="openEHR CodedText FSH wrapper">DvCodedText</a><a name="DvCodedText"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_coded_text_class">DV_CODED_TEXT</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">openEHR CodedText<br/><br/>Elements defined in Ancestors:<a href="https://specifications.openehr.org/releases/BASE/latest/foundation_types.html#_any_class" title="Carriage return character.">CR</a>, <a href="https://specifications.openehr.org/releases/BASE/latest/foundation_types.html#_any_class" title="Line feed character.">LF</a>, <a href="https://specifications.openehr.org/releases/BASE/latest/foundation_types.html#_any_class" title="Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype">Local_terminology_id</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_text_class" title="Displayable rendition of the item, regardless of its underlying structure. For `DV_CODED_TEXT`, this is the rubric of the complete term as provided by the terminology service.
">value</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_text_class" title="DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item.">hyperlink</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_text_class" title="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.
DEPRECATED usage: contains a string of the form `"name:value; name:value..."` , e.g. `"font-weight : bold; font-family : Arial; font-size : 12pt;"`. Values taken from W3C CSS2 properties lists for background and font . ">formatting</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_text_class" title="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).
">mappings</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_text_class" title="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 `ENTRY`, or else the text object is being used outside of an `ENTRY` or other enclosing structure which indicates the language. ">language</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_text_class" title="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.
">encoding</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_coded_text_class" title="The term of which the `_value_` attribute is the textual rendition (i.e. rubric).
">defining_code</a><br/><span style="font-weight:bold">Instances of this logical model are not marked to be the target of a Reference</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/web-source">
<valueUrl
value="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_coded_text_class"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-as-leaf"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-defns-parent"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-replace-cardinality"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
<valueCode value="can-bind"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-as-leaf"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-defns-parent"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-replace-cardinality"/>
</extension>
<url
value="https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/DvCodedText"/>
<version value="0.1.0"/>
<name value="DvCodedText"/>
<status value="draft"/>
<date value="2026-03-25T15:55:34+00:00"/>
<publisher value="Ian"/>
<contact>
<name value="Ian"/>
<telecom>
<system value="url"/>
<value value="http://example.org/example-publisher"/>
</telecom>
</contact>
<description value="openEHR CodedText FSH wrapper"/>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type
value="https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/DvCodedText"/>
<baseDefinition
value="http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"/>
<derivation value="specialization"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="0.1.0-snapshot"/>
</extension>
<element id="DvCodedText">
<path value="DvCodedText"/>
<short value="openEHR CodedText"/>
<definition value="openEHR CodedText FSH wrapper"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="Valid_value"/>
<severity value="error"/>
<human value="Valid value must not be empty"/>
<expression value="value.empty().not()"/>
<source value="http://openehr.org/fhir/StructureDefinition/DV-TEXT"/>
</constraint>
<constraint>
<key value="Mappings_valid"/>
<severity value="error"/>
<human value="Mappings valid must not be empty"/>
<expression value="mappings /= void implies mappings.empty().not()"/>
<source value="http://openehr.org/fhir/StructureDefinition/DV-TEXT"/>
</constraint>
<constraint>
<key value="Formatting_valid"/>
<severity value="error"/>
<human value="Formatting valid must not be empty"/>
<expression
value="formatting /= void implies formatting.empty().not()"/>
<source value="http://openehr.org/fhir/StructureDefinition/DV-TEXT"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="DvCodedText.CR">
<path value="DvCodedText.CR"/>
<short value="Carriage return character."/>
<definition value="Carriage return character."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="BASIC_DEFINITIONS.CR"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.LF">
<path value="DvCodedText.LF"/>
<short value="Line feed character."/>
<definition value="Line feed character."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="BASIC_DEFINITIONS.LF"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.Local-terminology-id">
<path value="DvCodedText.Local_terminology_id"/>
<short value="Predefined terminology identifier"/>
<definition
value="Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="OPENEHR_DEFINITIONS.Local_terminology_id"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.value">
<path value="DvCodedText.value"/>
<short
value="Displayable rendition of the item, regardless of its underlying structure."/>
<definition
value="Displayable rendition of the item, regardless of its underlying structure. For `DV_CODED_TEXT`, this is the rubric of the complete term as provided by the terminology service."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="DV_TEXT.value"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.hyperlink">
<path value="DvCodedText.hyperlink"/>
<short
value="DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field."/>
<definition
value="DEPRECATED: this field is deprecated; use markdown link/text in the `_value_` attribute, and `"markdown"` as the value of the `_formatting_` field.
Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DV_TEXT.hyperlink"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://openehr.org/fhir/StructureDefinition/DV-URI"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.formatting">
<path value="DvCodedText.formatting"/>
<short
value="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."/>
<definition
value="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.
DEPRECATED usage: contains a string of the form `"name:value; name:value..."` , e.g. `"font-weight : bold; font-family : Arial; font-size : 12pt;"`. Values taken from W3C CSS2 properties lists for background and font ."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DV_TEXT.formatting"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.mappings">
<path value="DvCodedText.mappings"/>
<short
value="Terms from other terminologies most closely matching this term, typically used where the originator (e."/>
<definition
value="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)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DV_TEXT.mappings"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/TERM-MAPPING"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.language">
<path value="DvCodedText.language"/>
<short
value="Optional indicator of the localised language in which the value is written."/>
<definition
value="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 `ENTRY`, or else the text object is being used outside of an `ENTRY` or other enclosing structure which indicates the language."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DV_TEXT.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.encoding">
<path value="DvCodedText.encoding"/>
<short
value="Name of character encoding scheme in which this value is encoded."/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DV_TEXT.encoding"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"/>
</type>
<isModifier value="false"/>
</element>
<element id="DvCodedText.defining-code">
<path value="DvCodedText.defining_code"/>
<short
value="The term of which the `_value_` attribute is the textual rendition (i."/>
<definition
value="The term of which the `_value_` attribute is the textual rendition (i.e. rubric)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="DV_CODED_TEXT.defining_code"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"/>
</type>
<isModifier value="false"/>
</element>
</snapshot>
<differential>
<element id="DvCodedText">
<path value="DvCodedText"/>
<short value="openEHR CodedText"/>
<definition value="openEHR CodedText FSH wrapper"/>
</element>
</differential>
</StructureDefinition>