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/FHIR/openehr-base-ig/ 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 | Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on. DV_TEXT is used to represent any identifier of a real thing, issued by some authority or agency. Base definition for all types defined in FHIR type system. |
Short | Items which are truly boolean dataBase for all types and resources |
Comments | If the formatting field is set, the value field is affected as follows:
|
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. DV_TEXT.value | |
Definition | 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. |
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 value attribute, and 'markdown' as the value of the formatting field. |
Short | DEPRECATED: this field is deprecated; use markdown |
Comments | Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item. |
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: 'plain': use for plain text, possibly containing newlines, but otherwise unformatted (same as Void);
DEPRECATED usage: contains a string of the form |
Short | plain | plain_no_newlines | markdown |
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 |
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 ENTRY, or else the text object is being used outside of an ENTRY or other enclosing structure which indicates the language. |
Short | Optional indicator of the localised language in which the value is written |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
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 |
Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets ) |
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 | Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on. DV_TEXT is used to represent any identifier of a real thing, issued by some authority or agency. |
Short | Items which are truly boolean data |
Comments | If the formatting field is set, the value field is affected as follows:
|
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. DV_TEXT.value | |
Definition | 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. |
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 value attribute, and 'markdown' as the value of the formatting field. |
Short | DEPRECATED: this field is deprecated; use markdown |
Comments | Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item. |
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: 'plain': use for plain text, possibly containing newlines, but otherwise unformatted (same as Void);
DEPRECATED usage: contains a string of the form |
Short | plain | plain_no_newlines | markdown |
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 |
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 ENTRY, or else the text object is being used outside of an ENTRY or other enclosing structure which indicates the language. |
Short | Optional indicator of the localised language in which the value is written |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
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 |
Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets ) |
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 | Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on. DV_TEXT is used to represent any identifier of a real thing, issued by some authority or agency. |
Short | Items which are truly boolean data |
Comments | If the formatting field is set, the value field is affected as follows:
|
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. DV_TEXT.value | |
Definition | 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. |
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 value attribute, and 'markdown' as the value of the formatting field. |
Short | DEPRECATED: this field is deprecated; use markdown |
Comments | Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item. |
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: 'plain': use for plain text, possibly containing newlines, but otherwise unformatted (same as Void);
DEPRECATED usage: contains a string of the form |
Short | plain | plain_no_newlines | markdown |
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 |
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 ENTRY, or else the text object is being used outside of an ENTRY or other enclosing structure which indicates the language. |
Short | Optional indicator of the localised language in which the value is written |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
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 |
Binding | The codes SHALL be taken from Character Set (required to https://specifications.openehr.org/fhir/valueset-character_sets ) |
Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
Is Modifier | false |