Skip to main content

HS.FHIR.vSTU3.Model.Base.Narrative

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A human-readable formatted text, including images.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
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.

Properties

property div as %String (MAXLEN = 1000000, REFELEMENTQUALIFIED = 1, REFNAMESPACE = "http://www.w3.org/1999/xhtml", XMLNAME = "div", XMLPROJECTION = "ELEMENT", XMLREF = 1) [ Required ];
The actual narrative content, a stripped down version of XHTML.
Property methods: divDisplayToLogical(), divGet(), divIsValid(), divLogicalToDisplay(), divLogicalToOdbc(), divNormalize(), divSet()
property status as HS.FHIR.vSTU3.Model.Base.NarrativeStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

Methods

deprecated method %OnNew(pStatus As %String, pDiv As %String) as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Get new object, populated with specified data.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab