Skip to main content

HS.FHIR.vSTU3.Model.Base.Period

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A time period defined by a start and end date and optionally time.
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 = Period;
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 end as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "end", XMLPROJECTION = "ELEMENT");
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Property methods: endGet(), endGetSwizzled(), endIsValid(), endNewObject(), endSet()
property start as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "start", XMLPROJECTION = "ELEMENT");
The start of the period. The boundary is inclusive.
Property methods: startGet(), startGetSwizzled(), startIsValid(), startNewObject(), startSet()

Methods

deprecated method %OnNew(pStart As %String, pEnd As %String, pExtension As %RegisteredObject) as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Get new object, populated with specified data.
deprecated method SetEnd(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 "end" property.
deprecated method SetStart(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 "start" property.

Inherited Members

Inherited Properties

Inherited Methods

Feedback