Skip to main content

HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation

class HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation extends HS.FHIR.DTL.vSTU3.Model.Base.Element

A text note which also contains information about who made the statement and when.

Property 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 XMLNAME = Annotation;
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 XMLPROJECTION = ELEMENT;
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 = Annotation;
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.

Properties

property authorReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "authorReference", XMLPROJECTION = "ELEMENT");
Reference

Individual responsible for the Annotation:

Practitioner | Patient | RelatedPerson

Property methods: authorReferenceGet(), authorReferenceGetSwizzled(), authorReferenceIsValid(), authorReferenceNewObject(), authorReferenceSet()
property authorString as %String (MAXLEN = 1000000, XMLNAME = "authorString", XMLPROJECTION = "ATTRIBUTE");
string

Individual responsible for the Annotation:

Property methods: authorStringDisplayToLogical(), authorStringGet(), authorStringIsValid(), authorStringLogicalToDisplay(), authorStringLogicalToOdbc(), authorStringNormalize(), authorStringSet()
property text as %String (MAXLEN = 1000000, XMLNAME = "text", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

The annotation - text content.

Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property time as %String (MAXLEN = 1000000, XMLNAME = "time", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the annotation was made.

Property methods: timeDisplayToLogical(), timeGet(), timeIsValid(), timeLogicalToDisplay(), timeLogicalToOdbc(), timeNormalize(), timeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab