Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Base.Narrative extends HS.FHIR.DTL.vSTU3.Model.Base.Element

A human-readable formatted text, including images.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Narrative;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Narrative;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property div as %String (MAXLEN = 1000000, REFELEMENTQUALIFIED = 1, REFNAMESPACE = "", XMLNAME = "div", XMLPROJECTION = "ELEMENT", XMLREF = 1) [ Required ];

Limited xhtml content. The narrative SHALL have some non-whitespace content (text or an image). The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, elements (either name or href), images and internally contained style attributes. The inner portion of the div content is often used for the innerHTML property in a browser. In order to simplify this kind of processing, when the narrative is represented in JSON, it SHALL be encoded so that the characters between the first '>' and the last '<' delimiters is the content of the

element; e.g. "div": "
" is legal, but this is not: "div": "
" Note that the XHTML is contained in general XML so there is no support for HTML entities like   or © etc. Unicode characters SHALL be used instead. Unicode   substitutes for  .
Property methods: divDisplayToLogical(), divGet(), divIsValid(), divLogicalToDisplay(), divLogicalToOdbc(), divNormalize(), divSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

generated | extensions | additional | empty

narrative-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend narrative-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab