Package org.hl7.fhir.r5.openehr

Class DV_TEXT

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.LogicalBase
org.hl7.fhir.r5.openehr.DATA_VALUE
org.hl7.fhir.r5.openehr.DV_TEXT
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType
Direct Known Subclasses:
DV_CODED_TEXT
public class DV_TEXT extends DATA_VALUE implements org.hl7.fhir.instance.model.api.ICompositeType
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.
See Also:

  • Field Details

    • value

      protected StringType 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.

    • formatting

      protected StringType formatting
      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

    • mappingsList

      protected List<TERM_MAPPING> mappingsList
      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).

    • language

      protected CODE_PHRASE language
      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.

    • encoding

      protected CODE_PHRASE encoding
      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.

  • Constructor Details

  • Method Details

    • getValueElement

      public StringType getValueElement()
      Returns:
      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.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value

    • hasValueElement

      public boolean hasValueElement()

    • hasValue

      public boolean hasValue()

    • setValueElement

      public DV_TEXT setValueElement(StringType value)
      Parameters:
      value - 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.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value

    • getValue

      public String getValue()
      Returns:
      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.

    • setValue

      public DV_TEXT setValue(String value)
      Parameters:
      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.

    • getHyperlink

      public DV_URI getHyperlink()
      Returns:
      hyperlink (DEPRECATED: this field is deprecated; use markdown link/text in the value attribute, and 'markdown' as the value of the formatting field.)

    • hasHyperlink

      public boolean hasHyperlink()

    • setHyperlink

      public DV_TEXT setHyperlink(DV_URI value)
      Parameters:
      value - hyperlink (DEPRECATED: this field is deprecated; use markdown link/text in the value attribute, and 'markdown' as the value of the formatting field.)

    • getFormattingElement

      public StringType getFormattingElement()
      Returns:
      formatting (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). This is the underlying object with id, value and extensions. The accessor "getFormatting" gives direct access to the value

    • hasFormattingElement

      public boolean hasFormattingElement()

    • hasFormatting

      public boolean hasFormatting()

    • setFormattingElement

      public DV_TEXT setFormattingElement(StringType value)
      Parameters:
      value - formatting (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). This is the underlying object with id, value and extensions. The accessor "getFormatting" gives direct access to the value

    • getFormatting

      public String getFormatting()
      Returns:
      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

    • setFormatting

      public DV_TEXT setFormatting(String value)
      Parameters:
      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

    • getMappingsList

      public List<TERM_MAPPING> getMappingsList()
      Returns:
      invalid reference 
      #mappings
      (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).)

    • setMappingsList

      public DV_TEXT setMappingsList(List<TERM_MAPPING> theMappings)
      Returns:
      Returns a reference to this for easy method chaining

    • hasMappings

      public boolean hasMappings()

    • addMappings

      public TERM_MAPPING addMappings()

    • addMappings

      public DV_TEXT addMappings(TERM_MAPPING t)

    • getMappingsFirstRep

      public TERM_MAPPING getMappingsFirstRep()
      Returns:
      The first repetition of repeating field
      invalid reference 
      #mappings
      , creating it if it does not already exist {3}

    • getLanguage

      public CODE_PHRASE getLanguage()
      Returns:
      language (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.)

    • hasLanguage

      public boolean hasLanguage()

    • setLanguage

      public DV_TEXT setLanguage(CODE_PHRASE value)
      Parameters:
      value - language (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.)

    • getEncoding

      public CODE_PHRASE getEncoding()
      Returns:
      encoding (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.)

    • hasEncoding

      public boolean hasEncoding()

    • setEncoding

      public DV_TEXT setEncoding(CODE_PHRASE value)
      Parameters:
      value - encoding (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.)

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Base

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DATA_VALUE
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public DV_TEXT copy()
      Specified by:
      copy in class DATA_VALUE

    • copyValues

      public void copyValues(DV_TEXT dst)

    • typedCopy

      protected DV_TEXT typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Base

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Base

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Base